Beignet API reference
    Preparing search index...

    Interface InlineScheduleRunnerOptions<Ctx>

    Options for the inline schedule runner.

    interface InlineScheduleRunnerOptions<Ctx> {
        ctx?: Ctx | (() => MaybePromise<Ctx>);
        instrumentation?: ProviderInstrumentationTarget;
        instrumentationContext?: ScheduleInstrumentationContext;
        now?: () => Date;
        tracing?: TracingPort;
        onError?<S extends ScheduleDef<string, StandardSchema, Ctx>>(
            args: ScheduleErrorArgs<S>,
        ): MaybePromise<void>;
        onHookError?<S extends ScheduleDef<string, StandardSchema, Ctx>>(
            args: ScheduleHookErrorArgs<S>,
        ): MaybePromise<void>;
        onStart?<S extends ScheduleDef<string, StandardSchema, Ctx>>(
            args: ScheduleLifecycleArgs<S>,
        ): MaybePromise<void>;
        onSuccess?<S extends ScheduleDef<string, StandardSchema, Ctx>>(
            args: ScheduleLifecycleArgs<S>,
        ): MaybePromise<void>;
    }

    Type Parameters

    • Ctx
    Index
    ctx? instrumentation? instrumentationContext? now? tracing?
    onError? onHookError? onStart? onSuccess?
    ctx?: Ctx | (() => MaybePromise<Ctx>)

    Static schedule context or factory evaluated for each run.

    instrumentation?: ProviderInstrumentationTarget

    Provider instrumentation target that receives schedule events for each run. Pass ctx.ports, ctx.ports.instrumentation, or ctx.ports.devtools directly.

    The runner records started, completed, and failed events. Recording failures are isolated from schedule execution.

    instrumentationContext?: ScheduleInstrumentationContext

    Correlation fields attached to recorded schedule events.

    now?: () => Date

    Clock used when run timestamps are not provided.

    tracing?: TracingPort

    Runtime tracing port used before a lazy context factory runs.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods