Convex

https://github.com/convex/convex-js
Admin
Convex is the TypeScript backend application platform, providing client libraries, a backend SDK,...
Tokens:13,642
Snippets:88
Trust Score:10
License:Apache-2.0
Update:5 days ago
Show doc for...
Tokens:
Raw
### Install non-Convex skill (web-design-guidelines)

Source: https://github.com/convex/convex-js/blob/main/src/cli/lib/aiFiles/MANUAL_TESTING.md

Installs a non-Convex skill before running ai-files install to verify it survives removal.

```bash
npx skills add vercel-labs/agent-skills --skill web-design-guidelines --agent codex --yes
```

--------------------------------

### Install Convex skill manually (convex-quickstart)

Source: https://github.com/convex/convex-js/blob/main/src/cli/lib/aiFiles/MANUAL_TESTING.md

Installs a Convex skill manually to verify it is not claimed by ai-files install.

```bash
npx skills add convex/agent-skills --skill convex-quickstart --agent codex --yes
```

--------------------------------

### List skills with npx skills ls --json

Source: https://github.com/convex/convex-js/blob/main/src/cli/lib/aiFiles/MANUAL_TESTING.md

List installed skills in JSON format to verify the removal results.

```bash
npx skills ls --json
```

--------------------------------

### Install non-Convex and Convex skills

Source: https://github.com/convex/convex-js/blob/main/src/cli/lib/aiFiles/MANUAL_TESTING.md

Install a non-Convex skill and a couple of Convex skills in a fresh temp project before running the remove command.

```bash
npx skills add vercel-labs/agent-skills --skill web-design-guidelines --agent codex --yes
```

```bash
npx skills add convex/agent-skills --skill convex-quickstart --agent codex --yes
```

--------------------------------

### Run npx convex ai-files remove

Source: https://github.com/convex/convex-js/blob/main/src/cli/lib/aiFiles/MANUAL_TESTING.md

Run the remove command to remove skills based on the canonical catalog.

```bash
npx convex ai-files remove
```

--------------------------------

### Set CONVEX_VERSION_API_ORIGIN environment variable

Source: https://github.com/convex/convex-js/blob/main/src/cli/lib/aiFiles/MANUAL_TESTING.md

Use this environment variable to point the CLI at a local stub or local version service when testing unreleased changes to version.convex.dev. This is useful during rollout windows when the local CLI expects a newer /v1/agent_skills response shape than the deployed service currently serves.

```bash
CONVEX_VERSION_API_ORIGIN=http://127.0.0.1:3212
```

--------------------------------

### Run convex ai-files remove with local version API override

Source: https://github.com/convex/convex-js/blob/main/src/cli/lib/aiFiles/MANUAL_TESTING.md

Invokes the convex ai-files remove command with the CONVEX_VERSION_API_ORIGIN environment variable set to a local stub or local version service. Useful during rollout windows when the local CLI expects a newer /v1/agent_skills response shape than the deployed service currently serves.

```bash
CONVEX_VERSION_API_ORIGIN=http://127.0.0.1:3212 npx convex ai-files remove
```

--------------------------------

### DatabaseReader

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Interface for reading data from the database. Provides methods to get, query, and normalize IDs. Deprecated.

```APIDOC
## DatabaseReader

### Description
Interface for reading data from the database. Provides methods to get, query, and normalize IDs. Deprecated.

### Methods

#### get
```typescript
get<TableName extends TableNamesInDataModel<DataModel>>(id: Id<TableName>): Promise<DocumentByName<DataModel, TableName> | null>;
```
- **id** (Id<TableName>) - Required - The ID of the document to retrieve.
- **Returns**: Promise of the document or null.

#### normalizeId
```typescript
normalizeId<TableName extends TableNamesInDataModel<DataModel>>(tableName: TableName, id: string): Id<TableName> | null;
```
- **tableName** (TableName) - Required - The table name.
- **id** (string) - Required - The ID string to normalize.
- **Returns**: Normalized ID or null.

#### query
```typescript
query<TableName extends TableNamesInDataModel<DataModel>>(tableName: TableName): QueryInitializer<NamedTableInfo<DataModel, TableName>>;
```
- **tableName** (TableName) - Required - The table to query.
- **Returns**: QueryInitializer for the table.
```

--------------------------------

### Run client tests with npm test

Source: https://github.com/convex/convex-js/blob/main/CONTRIBUTING.md

Runs the client test suite. Note that integration, end-to-end, and proptests are not included in this repository.

```bash
npm test
```

--------------------------------

### StorageWriter.generateUploadUrl

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Generates a URL for uploading a file to storage.

```APIDOC
## StorageWriter.generateUploadUrl

### Description
Generates a URL for uploading a file to storage.

### Method
Promise<string>

### Returns
- **Promise<string>** - The upload URL.

```

--------------------------------

### Scheduler.runAt

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Schedules a function to run at a specific timestamp. The function reference must be a mutation or action with public or internal visibility.

```APIDOC
## Scheduler.runAt

### Description
Schedules a function to run at a specific timestamp. The function reference must be a mutation or action with public or internal visibility.

### Method
runAt

### Parameters
- **timestamp** (number | Date) - Required - The time at which to run the function.
- **functionReference** (SchedulableFunctionReference) - Required - The reference to the function to schedule.
- **...args** (OptionalRestArgs<FuncRef>) - Optional - Arguments to pass to the function.

### Returns
- **Promise<void>** - A promise that resolves when the scheduling is complete.

```

--------------------------------

### Scheduler.runAfter

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Schedules a function to run after a specified delay. The function reference must be a mutation or action with public or internal visibility.

```APIDOC
## Scheduler.runAfter

### Description
Schedules a function to run after a specified delay. The function reference must be a mutation or action with public or internal visibility.

### Method
runAfter

### Parameters
- **delayMs** (number) - Required - The delay in milliseconds before the function runs.
- **functionReference** (SchedulableFunctionReference) - Required - The reference to the function to schedule.
- **...args** (OptionalRestArgs<FuncRef>) - Optional - Arguments to pass to the function.

### Returns
- **Promise<void>** - A promise that resolves when the scheduling is complete.

```

--------------------------------

### cronJobs

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Creates a new Crons instance for defining scheduled jobs. This is the entry point for configuring cron jobs in Convex.

```APIDOC
## cronJobs

### Description
Creates a new Crons instance for defining scheduled jobs. This is the entry point for configuring cron jobs in Convex.

### Method
`cronJobs()`

### Parameters
None

### Returns
- **Crons** - A new Crons instance.
```

--------------------------------

### GenericMutationCtx<DataModel>

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Context object passed to mutation functions. Provides access to database, auth, scheduler, and storage.

```APIDOC
## GenericMutationCtx<DataModel>

### Description
Context object passed to mutation functions. Provides access to database, auth, scheduler, and storage.

### Properties
- **auth** (Auth) - Authentication object.
- **db** (GenericDatabaseWriter<DataModel>) - Database writer for mutations.
- **scheduler** (Scheduler) - Scheduler for scheduling functions.
- **storage** (StorageWriter) - Storage writer for mutations.

```

--------------------------------

### DefineSchemaOptions

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Options for defineSchema, including schemaValidation and strictTableNameTypes.

```APIDOC
## DefineSchemaOptions

### Description
Options for defineSchema, including schemaValidation and strictTableNameTypes.

### Interface Definition
```typescript
export interface DefineSchemaOptions<StrictTableNameTypes extends boolean> {
    schemaValidation?: boolean;
    strictTableNameTypes?: StrictTableNameTypes;
}
```
```

--------------------------------

### GenericQueryCtx<DataModel>

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Context object passed to query functions. Provides access to database, auth, and storage.

```APIDOC
## GenericQueryCtx<DataModel>

### Description
Context object passed to query functions. Provides access to database, auth, and storage.

### Properties
- **auth** (Auth) - Authentication object.
- **db** (GenericDatabaseReader<DataModel>) - Database reader for queries.
- **storage** (StorageReader) - Storage reader for queries.

```

--------------------------------

### GenericActionCtx<DataModel>

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Context object passed to action functions. Provides methods to run other functions and access auth, scheduler, and storage.

```APIDOC
## GenericActionCtx<DataModel>

### Description
Context object passed to action functions. Provides methods to run other functions and access auth, scheduler, and storage.

### Properties
- **auth** (Auth) - Authentication object.
- **scheduler** (Scheduler) - Scheduler for scheduling functions.
- **storage** (StorageActionWriter) - Storage writer for actions.

### Methods

#### runAction<Action extends FunctionReference<"action", "public" | "internal">>(action: Action, ...args: OptionalRestArgs<Action>): Promise<FunctionReturnType<Action>>
Runs an action function.

#### runMutation<Mutation extends FunctionReference<"mutation", "public" | "internal">>(mutation: Mutation, ...args: OptionalRestArgs<Mutation>): Promise<FunctionReturnType<Mutation>>
Runs a mutation function.

#### runQuery<Query extends FunctionReference<"query", "public" | "internal">>(query: Query, ...args: OptionalRestArgs<Query>): Promise<FunctionReturnType<Query>>
Runs a query function.

```

--------------------------------

### StorageReader.getUrl

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Generates a URL for accessing a stored file. Returns null if the file does not exist.

```APIDOC
## StorageReader.getUrl

### Description
Generates a URL for accessing a stored file. Returns null if the file does not exist.

### Method
Promise<string | null>

### Parameters
- **storageId** (StorageId) - Required - The storage ID of the file.

### Returns
- **Promise<string | null>** - The file URL, or null if not found.

```

--------------------------------

### Crons.daily

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Schedules a function to run daily at a specified time.

```APIDOC
## Crons.daily

### Description
Schedules a function to run daily at a specified time.

### Method
`daily(cronIdentifier: string, schedule: Daily, functionReference: FuncRef, ...args: OptionalRestArgs<FuncRef>): void`

### Parameters
- **cronIdentifier** (string) - Required - A unique identifier for the cron job.
- **schedule** (Daily) - Required - The daily schedule configuration.
- **functionReference** (SchedulableFunctionReference) - Required - The function to schedule.
- **...args** (OptionalRestArgs<FuncRef>) - Optional - Arguments to pass to the function.

### Returns
- **void** - No return value.
```

--------------------------------

### FilterBuilder<TableInfo>

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Provides methods to build filter expressions for queries. Each method returns an Expression that can be used in query filters.

```APIDOC
## FilterBuilder<TableInfo>

### Description
Provides methods to build filter expressions for queries. Each method returns an Expression that can be used in query filters.

### Methods

#### add<T extends NumericValue>(l: ExpressionOrValue<T>, r: ExpressionOrValue<T>): Expression<T>
Adds two numeric expressions.

#### and(...exprs: Array<ExpressionOrValue<boolean>>): Expression<boolean>
Combines multiple boolean expressions with logical AND.

#### div<T extends NumericValue>(l: ExpressionOrValue<T>, r: ExpressionOrValue<T>): Expression<T>
Divides two numeric expressions.

#### eq<T extends Value | undefined>(l: ExpressionOrValue<T>, r: ExpressionOrValue<T>): Expression<boolean>
Checks equality between two expressions.

#### field<FieldPath extends FieldPaths<TableInfo>>(fieldPath: FieldPath): Expression<FieldTypeFromFieldPath<DocumentByInfo<TableInfo>, FieldPath>>
References a field in the document.

#### gt<T extends Value>(l: ExpressionOrValue<T>, r: ExpressionOrValue<T>): Expression<boolean>
Checks if left is greater than right.

#### gte<T extends Value>(l: ExpressionOrValue<T>, r: ExpressionOrValue<T>): Expression<boolean>
Checks if left is greater than or equal to right.

#### lt<T extends Value>(l: ExpressionOrValue<T>, r: ExpressionOrValue<T>): Expression<boolean>
Checks if left is less than right.

#### lte<T extends Value>(l: ExpressionOrValue<T>, r: ExpressionOrValue<T>): Expression<boolean>
Checks if left is less than or equal to right.

#### mod<T extends NumericValue>(l: ExpressionOrValue<T>, r: ExpressionOrValue<T>): Expression<T>
Computes the remainder of division.

#### mul<T extends NumericValue>(l: ExpressionOrValue<T>, r: ExpressionOrValue<T>): Expression<T>
Multiplies two numeric expressions.

#### neg<T extends NumericValue>(x: ExpressionOrValue<T>): Expression<T>
Negates a numeric expression.

#### neq<T extends Value | undefined>(l: ExpressionOrValue<T>, r: ExpressionOrValue<T>): Expression<boolean>
Checks inequality between two expressions.

#### not(x: ExpressionOrValue<boolean>): Expression<boolean>
Negates a boolean expression.

#### or(...exprs: Array<ExpressionOrValue<boolean>>): Expression<boolean>
Combines multiple boolean expressions with logical OR.

#### sub<T extends NumericValue>(l: ExpressionOrValue<T>, r: ExpressionOrValue<T>): Expression<T>
Subtracts two numeric expressions.

```

--------------------------------

### TableDefinition.index

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Defines a database index on a table. Returns a new TableDefinition with the index added.

```APIDOC
## TableDefinition.index

### Description
Defines a database index on a table. Returns a new TableDefinition with the index added.

### Method
TableDefinition<Document, FieldPaths, Expand<Indexes & Record<IndexName, [FirstFieldPath, ...RestFieldPaths, IndexTiebreakerField]>>, SearchIndexes, VectorIndexes>

### Parameters
- **name** (IndexName) - Required - The name of the index.
- **fields** ([FirstFieldPath, ...RestFieldPaths]) - Required - The field paths to index.

### Returns
- **TableDefinition** - A new table definition with the index.

```

--------------------------------

### defineSchema

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Defines a schema for the Convex database. It takes a schema object and optional options, returning a SchemaDefinition.

```APIDOC
## defineSchema

### Description
Defines a schema for the Convex database. It takes a schema object and optional options, returning a SchemaDefinition.

### Signature
```typescript
export function defineSchema<Schema extends GenericSchema, StrictTableNameTypes extends boolean = true>(schema: Schema, options?: DefineSchemaOptions<StrictTableNameTypes>): SchemaDefinition<Schema, StrictTableNameTypes>;
```

### Parameters
- **schema** (GenericSchema) - Required - The schema definition object.
- **options** (DefineSchemaOptions<StrictTableNameTypes>) - Optional - Configuration options.

### Options
- **schemaValidation** (boolean) - Optional - Enable or disable schema validation.
- **strictTableNameTypes** (StrictTableNameTypes) - Optional - Enforce strict table name types.

### Returns
- **SchemaDefinition<Schema, StrictTableNameTypes>** - The defined schema.
```

--------------------------------

### actionGeneric

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

A generic action builder for defining public actions in Convex. It supports both validated and unvalidated function signatures.

```APIDOC
## actionGeneric

### Description
A generic action builder for defining public actions in Convex. It supports both validated and unvalidated function signatures.

### Type
`ActionBuilder<any, "public">`

### Usage
Use `actionGeneric` to register an action function. It accepts either a validated function with a validator or an unvalidated function with an args array.

### Parameters
- **func** (ValidatedFunction | UnvalidatedFunction) - Required - The action function to register.

### Returns
- **RegisteredAction** - The registered action reference.
```

--------------------------------

### Crons.interval

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Schedules a function to run at a fixed interval.

```APIDOC
## Crons.interval

### Description
Schedules a function to run at a fixed interval.

### Method
`interval(cronIdentifier: string, schedule: Interval, functionReference: FuncRef, ...args: OptionalRestArgs<FuncRef>): void`

### Parameters
- **cronIdentifier** (string) - Required - A unique identifier for the cron job.
- **schedule** (Interval) - Required - The interval schedule configuration.
- **functionReference** (SchedulableFunctionReference) - Required - The function to schedule.
- **...args** (OptionalRestArgs<FuncRef>) - Optional - Arguments to pass to the function.

### Returns
- **void** - No return value.
```

--------------------------------

### Generate management API spec

Source: https://github.com/convex/convex-js/blob/main/CONTRIBUTING.md

Updates management-api.json and regenerates src/cli/generatedApi.ts. This is a manual process.

```bash
npm run generateManagementApiSpec
```

--------------------------------

### DatabaseWriter

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Interface for writing data to the database. Extends GenericDatabaseReader and provides insert, patch, replace, and delete methods. Deprecated.

```APIDOC
## DatabaseWriter

### Description
Interface for writing data to the database. Extends GenericDatabaseReader and provides insert, patch, replace, and delete methods. Deprecated.

### Methods

#### delete
```typescript
delete(id: Id<TableNamesInDataModel<DataModel>>): Promise<void>;
```
- **id** (Id<TableNamesInDataModel<DataModel>>) - Required - The ID of the document to delete.
- **Returns**: Promise<void>.

#### insert
```typescript
insert<TableName extends TableNamesInDataModel<DataModel>>(table: TableName, value: WithoutSystemFields<DocumentByName<DataModel, TableName>>): Promise<Id<TableName>>;
```
- **table** (TableName) - Required - The table to insert into.
- **value** (WithoutSystemFields<DocumentByName<DataModel, TableName>>) - Required - The document to insert.
- **Returns**: Promise of the new document ID.

#### patch
```typescript
patch<TableName extends TableNamesInDataModel<DataModel>>(id: Id<TableName>, value: Partial<DocumentByName<DataModel, TableName>>): Promise<void>;
```
- **id** (Id<TableName>) - Required - The ID of the document to patch.
- **value** (Partial<DocumentByName<DataModel, TableName>>) - Required - The partial document with fields to update.
- **Returns**: Promise<void>.

#### replace
```typescript
replace<TableName extends TableNamesInDataModel<DataModel>>(id: Id<TableName>, value: WithOptionalSystemFields<DocumentByName<DataModel, TableName>>): Promise<void>;
```
- **id** (Id<TableName>) - Required - The ID of the document to replace.
- **value** (WithOptionalSystemFields<DocumentByName<DataModel, TableName>>) - Required - The full replacement document.
- **Returns**: Promise<void>.
```

--------------------------------

### Crons.monthly

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Schedules a function to run monthly on a specified day and time.

```APIDOC
## Crons.monthly

### Description
Schedules a function to run monthly on a specified day and time.

### Method
`monthly(cronIdentifier: string, schedule: Monthly, functionReference: FuncRef, ...args: OptionalRestArgs<FuncRef>): void`

### Parameters
- **cronIdentifier** (string) - Required - A unique identifier for the cron job.
- **schedule** (Monthly) - Required - The monthly schedule configuration.
- **functionReference** (SchedulableFunctionReference) - Required - The function to schedule.
- **...args** (OptionalRestArgs<FuncRef>) - Optional - Arguments to pass to the function.

### Returns
- **void** - No return value.
```

--------------------------------

### Crons.hourly

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Schedules a function to run hourly at a specified minute.

```APIDOC
## Crons.hourly

### Description
Schedules a function to run hourly at a specified minute.

### Method
`hourly(cronIdentifier: string, schedule: Hourly, functionReference: FuncRef, ...args: OptionalRestArgs<FuncRef>): void`

### Parameters
- **cronIdentifier** (string) - Required - A unique identifier for the cron job.
- **schedule** (Hourly) - Required - The hourly schedule configuration.
- **functionReference** (SchedulableFunctionReference) - Required - The function to schedule.
- **...args** (OptionalRestArgs<FuncRef>) - Optional - Arguments to pass to the function.

### Returns
- **void** - No return value.
```

--------------------------------

### StorageReader.getMetadata

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Retrieves metadata for a stored file using its storage ID. Returns null if the file does not exist.

```APIDOC
## StorageReader.getMetadata

### Description
Retrieves metadata for a stored file using its storage ID. Returns null if the file does not exist.

### Method
Promise<FileMetadata | null>

### Parameters
- **storageId** (StorageId) - Required - The storage ID of the file.

### Returns
- **Promise<FileMetadata | null>** - The file metadata, or null if not found.

```

--------------------------------

### defineTable

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Defines a table schema using either a validator object or a record of validators. Returns a TableDefinition.

```APIDOC
## defineTable

### Description
Defines a table schema using either a validator object or a record of validators. Returns a TableDefinition.

### Overload 1
```typescript
export function defineTable<DocumentSchema extends Validator<Record<string, any>, false, any>>(documentSchema: DocumentSchema): TableDefinition<ExtractDocument<DocumentSchema>, ExtractFieldPaths<DocumentSchema>>;
```

### Overload 2
```typescript
export function defineTable<DocumentSchema extends Record<string, Validator<any, any, any>>>(documentSchema: DocumentSchema): TableDefinition<ExtractDocument<ObjectValidator<DocumentSchema>>, ExtractFieldPaths<ObjectValidator<DocumentSchema>>>;
```

### Parameters
- **documentSchema** (Validator or Record<string, Validator>) - Required - The schema for the table's documents.

### Returns
- **TableDefinition** - The table definition.
```

--------------------------------

### Crons.weekly

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Schedules a function to run weekly on a specified day and time.

```APIDOC
## Crons.weekly

### Description
Schedules a function to run weekly on a specified day and time.

### Method
`weekly(cronIdentifier: string, schedule: Weekly, functionReference: FuncRef, ...args: OptionalRestArgs<FuncRef>): void`

### Parameters
- **cronIdentifier** (string) - Required - A unique identifier for the cron job.
- **schedule** (Weekly) - Required - The weekly schedule configuration.
- **functionReference** (SchedulableFunctionReference) - Required - The function to schedule.
- **...args** (OptionalRestArgs<FuncRef>) - Optional - Arguments to pass to the function.

### Returns
- **void** - No return value.
```

--------------------------------

### StorageActionWriter.store

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Stores a blob in storage and returns its storage ID. Optionally accepts a SHA-256 hash for integrity verification.

```APIDOC
## StorageActionWriter.store

### Description
Stores a blob in storage and returns its storage ID. Optionally accepts a SHA-256 hash for integrity verification.

### Method
store

### Parameters
- **blob** (Blob) - Required - The blob to store.
- **options** (object) - Optional - An object containing optional parameters.
  - **sha256** (string) - Optional - The SHA-256 hash of the blob.

### Returns
- **Promise<StorageId>** - The storage ID of the stored blob.

```

--------------------------------

### TableDefinition.searchIndex

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Defines a search index on a table. Returns a new TableDefinition with the search index added.

```APIDOC
## TableDefinition.searchIndex

### Description
Defines a search index on a table. Returns a new TableDefinition with the search index added.

### Method
TableDefinition<Document, FieldPaths, Indexes, Expand<SearchIndexes & Record<IndexName, { searchField: SearchField; filterFields: FilterFields }>>, VectorIndexes>

### Parameters
- **name** (IndexName) - Required - The name of the search index.
- **indexConfig** (Expand<SearchIndexConfig<SearchField, FilterFields>>) - Required - Configuration for the search index.

### Returns
- **TableDefinition** - A new table definition with the search index.

```

--------------------------------

### StorageActionWriter.get

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Retrieves a stored blob by its storage ID. Returns null if the blob does not exist.

```APIDOC
## StorageActionWriter.get

### Description
Retrieves a stored blob by its storage ID. Returns null if the blob does not exist.

### Method
get

### Parameters
- **storageId** (StorageId) - Required - The storage ID of the blob to retrieve.

### Returns
- **Promise<Blob | null>** - The blob if found, otherwise null.

```

--------------------------------

### StorageWriter.delete

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Deletes a stored file using its storage ID.

```APIDOC
## StorageWriter.delete

### Description
Deletes a stored file using its storage ID.

### Method
Promise<void>

### Parameters
- **storageId** (StorageId) - Required - The storage ID of the file to delete.

### Returns
- **Promise<void>** - Resolves when the deletion is complete.

```

--------------------------------

### FileMetadata

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Type representing metadata for a file stored in Convex, including storage ID, SHA256 hash, size, and content type.

```APIDOC
## FileMetadata

### Description
Type representing metadata for a file stored in Convex, including storage ID, SHA256 hash, size, and content type.

### Type Definition
```typescript
export type FileMetadata = {
    storageId: StorageId;
    sha256: string;
    size: number;
    contentType: string | null;
};
```
```

--------------------------------

### Auth.getUserIdentity

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Retrieves the user identity associated with the current request. Returns null if no user is authenticated.

```APIDOC
## Auth.getUserIdentity

### Description
Retrieves the user identity associated with the current request. Returns null if no user is authenticated.

### Method
`getUserIdentity()`

### Parameters
None

### Returns
- **Promise<UserIdentity | null>** - The user identity or null.
```

--------------------------------

### Crons.cron

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Schedules a function to run on a cron schedule. The schedule is specified as a cron string.

```APIDOC
## Crons.cron

### Description
Schedules a function to run on a cron schedule. The schedule is specified as a cron string.

### Method
`cron(cronIdentifier: string, cron: CronString, functionReference: FuncRef, ...args: OptionalRestArgs<FuncRef>): void`

### Parameters
- **cronIdentifier** (string) - Required - A unique identifier for the cron job.
- **cron** (CronString) - Required - The cron schedule string.
- **functionReference** (SchedulableFunctionReference) - Required - The function to schedule.
- **...args** (OptionalRestArgs<FuncRef>) - Optional - Arguments to pass to the function.

### Returns
- **void** - No return value.
```

--------------------------------

### DefaultFunctionArgs

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Type alias for default function arguments, representing a record of unknown values.

```APIDOC
## DefaultFunctionArgs

### Description
Type alias for default function arguments, representing a record of unknown values.

### Type Definition
```typescript
export type DefaultFunctionArgs = Record<string, unknown>;
```
```

--------------------------------

### queryGeneric

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

A public query builder that allows defining queries with validated or unvalidated arguments. It returns a registered query that can be used in the Convex backend.

```APIDOC
## queryGeneric

### Description
A public query builder that allows defining queries with validated or unvalidated arguments. It returns a registered query that can be used in the Convex backend.

### Type
`QueryBuilder<any, "public">`

### Usage
```ts
queryGeneric(func: ValidatedFunction<GenericQueryCtx<DataModel>, ArgsValidator, Output>): RegisteredQuery<"public", ObjectType<ArgsValidator>, Output>
queryGeneric(func: UnvalidatedFunction<GenericQueryCtx<DataModel>, Args, Output>): RegisteredQuery<"public", ArgsArrayToObject<Args>, Output>
```

### Parameters
- **func** (ValidatedFunction | UnvalidatedFunction) - Required - The function that defines the query logic.

### Returns
- **RegisteredQuery** - A registered query object with metadata flags.

```

--------------------------------

### filterApi<API, Predicate>(api: API): FilterApi<API, Predicate>

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Filters an API object to include only modules that match a given predicate type. This is useful for creating scoped API references.

```APIDOC
## filterApi<API, Predicate>(api: API): FilterApi<API, Predicate>

### Description
Filters an API object to include only modules that match a given predicate type. This is useful for creating scoped API references.

### Method
filterApi

### Parameters
- **api** (API) - Required - The API object to filter.

### Returns
FilterApi<API, Predicate> - The filtered API object.

```

--------------------------------

### DocumentByInfo

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Type that extracts the document type from a table info.

```APIDOC
## DocumentByInfo

### Description
Type that extracts the document type from a table info.

### Type Definition
```typescript
export type DocumentByInfo<TableInfo extends GenericTableInfo> = TableInfo["document"];
```
```

--------------------------------

### FieldPaths

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Type that extracts field paths from a table info.

```APIDOC
## FieldPaths

### Description
Type that extracts field paths from a table info.

### Type Definition
```typescript
export type FieldPaths<TableInfo extends GenericTableInfo> = TableInfo["fieldPaths"];
```
```

--------------------------------

### DocumentByName

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Type that extracts the document type from a data model and table name.

```APIDOC
## DocumentByName

### Description
Type that extracts the document type from a data model and table name.

### Type Definition
```typescript
export type DocumentByName<DataModel extends GenericDataModel, TableName extends TableNamesInDataModel<DataModel>> = DataModel[TableName]["document"];
```
```

--------------------------------

### Expression

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Abstract class representing an expression that evaluates to a value or undefined.

```APIDOC
## Expression

### Description
Abstract class representing an expression that evaluates to a value or undefined.

### Class Definition
```typescript
export abstract class Expression<T extends Value | undefined> {
}
```
```

--------------------------------

### DataModelFromSchemaDefinition

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Type that derives a data model from a schema definition. It maps table names to their document, field paths, indexes, and search indexes.

```APIDOC
## DataModelFromSchemaDefinition

### Description
Type that derives a data model from a schema definition. It maps table names to their document, field paths, indexes, and search indexes.

### Type Definition
```typescript
export type DataModelFromSchemaDefinition<SchemaDef extends SchemaDefinition<any, boolean>> = MaybeMakeLooseDataModel<{
    [TableName in keyof SchemaDef["tables"] & string]: SchemaDef["tables"][TableName] extends TableDefinition<infer Document, infer FieldPaths, infer Indexes, infer SearchIndexes, infer VectorIndexes> ? {
        document: Expand<IdField<TableName> & Document>;
        fieldPaths: keyof IdField<TableName> | FieldPaths;
        indexes: Expand<Indexes & SystemIndexes>;
        searchIndexes: SearchIndexes;
        vectorIndexes: VectorIndexes;
    } : never;
}, SchemaDef["strictTableNameTypes"]>;
```
```

--------------------------------

### ExpressionOrValue

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Type alias for either an Expression or a direct value.

```APIDOC
## ExpressionOrValue

### Description
Type alias for either an Expression or a direct value.

### Type Definition
```typescript
export type ExpressionOrValue<T extends Value | undefined> = Expression<T> | T;
```
```

--------------------------------

### FieldTypeFromFieldPath

Source: https://github.com/convex/convex-js/blob/main/api-extractor-configs/reports/server.api.md

Type that resolves the type of a field given a document and a field path string.

```APIDOC
## FieldTypeFromFieldPath

### Description
Type that resolves the type of a field given a document and a field path string.

### Type Definition
```typescript
export type FieldTypeFromFieldPath<Document extends GenericDocument, FieldPath extends string> = FieldPath extends `${infer First}.${infer Second}` ? First extends keyof Document ? Document[First] extends GenericDocument ? FieldTypeFromFieldPath<Document[First], Second> : undefined : undefined : FieldPath extends keyof Document ? Document[FieldPath] : undefined;
```
```
Tokens:
Raw