nestjs-temporal-core
    Preparing search index...

    Interface ScheduleCreationOptions

    Schedule creation options — user-facing input for TemporalScheduleService.createSchedule. spec and action are typed against the Temporal SDK directly. searchAttributes and catchupWindow are intentionally loose for backward compatibility.

    interface ScheduleCreationOptions {
        action: ScheduleAction;
        catchupWindow?: string | number;
        description?: string;
        limitedActions?: number;
        memo?: Record<string, unknown>;
        overlapPolicy?:
            | "skip"
            | "buffer_one"
            | "buffer_all"
            | "cancel_other"
            | "terminate_other"
            | "allow_all";
        paused?: boolean;
        pauseOnFailure?: boolean;
        scheduleId: string;
        searchAttributes?: Record<string, unknown>;
        spec: ScheduleSpec;
    }
    Index

    Properties

    action catchupWindow? description? limitedActions? memo? overlapPolicy? paused? pauseOnFailure? scheduleId searchAttributes? spec

    Properties

    action: ScheduleAction
    catchupWindow?: string | number
    description?: string

    Informative message — forwarded to Temporal's state.note.

    limitedActions?: number

    Limit on number of actions.

    Was not applied in prior releases; continues to be a no-op for backward compatibility. Set state.remainingActions via the SDK directly if you need this behavior.

    memo?: Record<string, unknown>
    overlapPolicy?:
        | "skip"
        | "buffer_one"
        | "buffer_all"
        | "cancel_other"
        | "terminate_other"
        | "allow_all"
    paused?: boolean
    pauseOnFailure?: boolean
    scheduleId: string
    searchAttributes?: Record<string, unknown>

    Search attributes. Values are arrays of string/number/Date/boolean (matches Temporal's legacy SearchAttributes shape). Typed loosely here for backward compatibility.

    spec: ScheduleSpec

    Settings

    Member Visibility

    On This Page

    Properties