Interface ScheduleDef<Name, Payload, Ctx>

Schedule definition created by defineSchedule(...).

interface ScheduleDef<
    Name extends string = string,
    Payload extends StandardSchema = StandardSchema,
    Ctx = unknown,
> {
    cron: string;
    description?: string;
    kind: "schedule";
    name: Name;
    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 = string
Payload extends StandardSchema = StandardSchema
Ctx = unknown

Hierarchy (View Summary)

SchedulePayloadDef<Name, Payload>
- ScheduleDef

Index

Properties

cron description? kind name payload timezone?

Methods

createPayload? handle

Properties

`Readonly`cron

cron: string

Cron expression consumed by schedule providers.

`Optional` `Readonly`description

description?: string

Optional human-readable description for docs and tooling.

`Readonly`kind

kind: "schedule"

Discriminator for schedule definitions.

`Readonly`name

name: Name

Stable schedule name.

`Readonly`payload

payload: Payload

Standard Schema payload validator.

`Optional` `Readonly`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:90

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:96