Beignet API reference
    Preparing search index...

    Interface CreateInngestJobFunctionOptions<J, Ctx>

    Options for creating an Inngest function from a Beignet job definition.

    interface CreateInngestJobFunctionOptions<
        J extends JobDef<string, StandardSchema, Ctx>,
        Ctx,
    > {
        client: Inngest;
        ctx?: InngestJobFunctionContext<Ctx>;
        description?: string;
        errorReporter?: InngestJobFunctionErrorReporter;
        hooks?: readonly JobHook<JobDef<string, StandardSchema, Ctx>, Ctx>[];
        id?: string;
        instrumentation?: InngestJobFunctionInstrumentation;
        job: J;
        name?: string;
    }

    Type Parameters

    Index
    client ctx? description? errorReporter? hooks? id? instrumentation? job name?
    client: Inngest

    Raw Inngest client.

    ctx?: InngestJobFunctionContext<Ctx>

    Static app context or context factory evaluated for each function run.

    description?: string

    Inngest function description. Defaults to the job description.

    errorReporter?: InngestJobFunctionErrorReporter

    Reporter for terminal failures delivered through Inngest onFailure.

    hooks?: readonly JobHook<JobDef<string, StandardSchema, Ctx>, Ctx>[]

    Hooks that wrap every job attempt executed by this function. Function hooks wrap job-local hooks.

    id?: string

    Inngest function ID. Defaults to the job name.

    instrumentation?: InngestJobFunctionInstrumentation

    Optional provider instrumentation target.

    job: J

    Beignet job definition.

    name?: string

    Inngest function display name. Defaults to the job name.

    Settings
    Member Visibility

    On This Page
    Properties