@cfxlabsinc/b2b-services
    Preparing search index...

    Type Alias ScheduleDefinition

    type ScheduleDefinition = {
        argFields?: readonly ScheduleArgField[];
        defaultArgs: readonly [Record<string, unknown>];
        defaultPolicies: TemporalSchedulePolicyInput;
        defaultSpec: TemporalScheduleSpecInput;
        description: string;
        environments?: readonly ("dev" | "prod")[];
        id: string;
        name: string;
        replaces?: readonly string[];
        scheduleId: string;
        workflowType: string;
    }
    Index
    argFields? defaultArgs defaultPolicies defaultSpec description environments? id name replaces? scheduleId workflowType
    argFields?: readonly ScheduleArgField[]

    Argument keys the operator may edit. Omitted → the args are fixed.

    defaultArgs: readonly [Record<string, unknown>]

    The workflow's argument list as the worker registered it. Always exactly one argument object — every one of these workflows takes a single options object — and it doubles as the shape authority for operator edits: a key's value here fixes the JSON type the edited value is serialized as.

    defaultPolicies: TemporalSchedulePolicyInput

    Overlap policy the schedule is created with.

    defaultSpec: TemporalScheduleSpecInput

    Cadence the worker registered, replayed verbatim by the create path.

    description: string

    One-line description of what the schedule does.

    environments?: readonly ("dev" | "prod")[]

    Namespaces the deploy creates this schedule in when it is missing. Omitted → both, which is what a new entry usually wants. Name prod alone for a schedule that would drive a partner integration dev has no business exercising.

    id: string

    Stable registry id, used in the URL (/schedules/<id>).

    name: string

    Sentence-case display name.

    replaces?: readonly string[]

    Temporal schedule ids this entry supersedes. The deploy deletes each one once this entry's own schedule exists, so a schedule whose workflow changed is swapped on deploy with no gap and no hand step.

    scheduleId: string

    Temporal schedule id. The dashboard reads/writes the schedule under this id.

    workflowType: string

    Registered Temporal workflow type (function name) the schedule starts.

    Settings
    Member Visibility

    On This Page
    Properties