Interface: Scheduler
server.Scheduler
An interface to schedule Convex functions.
You can schedule either mutations or actions. Mutations are guaranteed to execute exactly once - they are automatically retried on transient errors and either execute successfully or fail deterministically due to developer error in defining the function. Actions execute at most once - they are not retried and might fail due to transient errors.
Consider using an internalMutation or internalAction to enforce that these functions cannot be called directly from a Convex client.
Methods
runAfter
▸ runAfter<FuncRef>(delayMs, functionReference, ...args): Promise<GenericId<"_scheduled_functions">>
Schedule a function to execute after a delay.
Type parameters
| Name | Type |
|---|---|
FuncRef | extends SchedulableFunctionReference |
Parameters
| Name | Type | Description |
|---|---|---|
delayMs | number | Delay in milliseconds. Must be non-negative. If the delay is zero, the scheduled function will be due to execute immediately after the scheduling one completes. |
functionReference | FuncRef | A FunctionReference for the function to schedule. |
...args | OptionalRestArgs<FuncRef> | Arguments to call the scheduled functions with. |
Returns
Promise<GenericId<"_scheduled_functions">>
Defined in
runAt
▸ runAt<FuncRef>(timestamp, functionReference, ...args): Promise<GenericId<"_scheduled_functions">>
Schedule a function to execute at a given timestamp.
Type parameters
| Name | Type |
|---|---|
FuncRef | extends SchedulableFunctionReference |
Parameters
| Name | Type | Description |
|---|---|---|
timestamp | number | Date | A Date or a timestamp (milliseconds since the epoch). If the timestamp is in the past, the scheduled function will be due to execute immediately after the scheduling one completes. The timestamp can't be more than five years in the past or more than five years in the future. |
functionReference | FuncRef | A FunctionReference for the function to schedule. |
...args | OptionalRestArgs<FuncRef> | arguments to call the scheduled functions with. |
Returns
Promise<GenericId<"_scheduled_functions">>
Defined in
cancel
▸ cancel(id): Promise<void>
Cancels a previously scheduled function if it has not started yet. If the scheduled function is already in progress, it will continue running but any new functions that it tries to schedule will be canceled.
Parameters
| Name | Type |
|---|---|
id | GenericId<"_scheduled_functions"> |
Returns
Promise<void>