Beignet API reference
    Preparing search index...

    Type Alias CreateOutboxDrainRouteOptions<Ctx>

    Options for creating a serverless-safe outbox drain route.

    type CreateOutboxDrainRouteOptions<Ctx extends OutboxDrainContext> = {
        batchSize?: number;
        concurrency?: number;
        headers?: HeadersInit | ((req: Request) => HeadersInit | undefined);
        heartbeatMs?: number;
        leaseMs?: number;
        maxActiveMs?: number;
        pipeline?: {
            metadata?: RawRouteInit["metadata"];
            name?: string;
            path?: string;
        };
        registry: OutboxRegistry;
        retryDelayMs?: DrainOutboxOptions["retryDelayMs"];
        secret?: string;
        server: ServerSource<NextRouteServer<Ctx>>;
    }

    Type Parameters

    • Ctx extends OutboxDrainContext
    Index
    batchSize? concurrency? headers? heartbeatMs? leaseMs? maxActiveMs? pipeline? registry retryDelayMs? secret? server
    batchSize?: number

    Maximum eligible messages to handle in one drain pass.

    concurrency?: number

    Maximum messages delivered concurrently. Values above one are unordered.

    headers?: HeadersInit | ((req: Request) => HeadersInit | undefined)

    Additional response headers.

    heartbeatMs?: number

    Serialized claim-renewal interval. Must remain shorter than leaseMs.

    leaseMs?: number

    Claim lease duration in milliseconds.

    maxActiveMs?: number

    Maximum time Beignet renews a claim for one delivery.

    pipeline?: { metadata?: RawRouteInit["metadata"]; name?: string; path?: string }

    Identity and metadata for the hooks pipeline when the server exposes rawRoute(...). metadata feeds metadata-driven hooks such as rate limiting and idempotency; name and path identify the route to hooks, instrumentation, and devtools.

    registry: OutboxRegistry

    Registry of events and jobs that may be delivered from the outbox.

    retryDelayMs?: DrainOutboxOptions["retryDelayMs"]

    Retry delay override passed through to drainOutbox(...).

    secret?: string

    Shared secret expected in the Authorization: Bearer <secret> header.

    Missing secrets fail closed with a 500 response so deployments do not accidentally expose an unauthenticated drain route.

    server: ServerSource<NextRouteServer<Ctx>>

    Beignet server that owns app context and ports.

    Any object exposing createRequestContext works: a NextServer, a core ServerInstance, or a test fake driven from a standard test runner.

    Settings
    Member Visibility

    On This Page
    Properties