Interface DefineScheduleOptions<Name, Payload, Ctx>

Options for defineSchedule(...).

interface DefineScheduleOptions<
    Name extends string,
    Payload extends StandardSchema,
    Ctx,
> {
    cron: string;
    description?: string;
    payload: Payload;
    timezone?: string;
    createPayload?(
        args: ScheduleCreatePayloadArgs<ScheduleDef<Name, Payload, Ctx>>,
    ): MaybePromise<InferSchemaOutput<Payload>>;
    handle(
        args: ScheduleHandleArgs<ScheduleDef<Name, Payload, Ctx>, Ctx>,
    ): MaybePromise<void>;
}

Type Parameters

Name extends string
Payload extends StandardSchema
Ctx

Index

Properties

cron description? payload timezone?

Methods

createPayload? handle

Properties

cron

cron: string

Cron expression consumed by schedule providers.

`Optional`description

description?: string

Optional human-readable description for docs and tooling.

payload

payload: Payload

Standard Schema payload validator.

`Optional`timezone

timezone?: string

Optional IANA timezone consumed by schedule providers.

Methods

`Optional`createPayload

createPayload?(
args: ScheduleCreatePayloadArgs<ScheduleDef<Name, Payload, Ctx>>,
): MaybePromise<InferSchemaOutput<Payload>>
Build a payload when the provider does not supply one.
Parameters
- args: ScheduleCreatePayloadArgs<ScheduleDef<Name, Payload, Ctx>>
Returns MaybePromise<InferSchemaOutput<Payload>>
- Defined in packages/core/src/schedules/index.ts:170

handle

handle(
args: ScheduleHandleArgs<ScheduleDef<Name, Payload, Ctx>, Ctx>,
): MaybePromise<void>
Handle a parsed schedule payload.
Parameters
- args: ScheduleHandleArgs<ScheduleDef<Name, Payload, Ctx>, Ctx>
Returns MaybePromise<void>
- Defined in packages/core/src/schedules/index.ts:176