Beignet API reference
    Preparing search index...

    Interface BroadcastRouteOptions<Ctx, Hooks>

    interface BroadcastRouteOptions<
        Ctx extends BroadcastContext,
        Hooks extends readonly RouteHook<Ctx, object>[] = readonly [],
    > {
        admit?: (
            args: {
                ctx: Ctx & AddedCtxFromHooks<Hooks>;
                request: Request;
                signal: AbortSignal;
            },
        ) => | void
        | (() => void | Promise<void>)
        | Promise<void | (() => void | Promise<void>)>;
        channels: ChannelRegistry<NoInfer<Ctx & AddedCtxFromHooks<Hooks>>>;
        hooks?: Hooks;
        maxLifetimeMs?: number;
        metadata?: ContractMeta;
        path?: string;
        resolveOrigin?: (
            args: { ctx: Ctx & AddedCtxFromHooks<Hooks>; request: Request },
        ) => BroadcastOrigin | undefined;
        server:
            | BroadcastServer<Ctx>
            | (() => BroadcastServer<Ctx> | Promise<BroadcastServer<Ctx>>);
    }

    Type Parameters

    • Ctx extends BroadcastContext
    • Hooks extends readonly RouteHook<Ctx, object>[] = readonly []
    Index
    admit? channels hooks? maxLifetimeMs? metadata? path? resolveOrigin? server
    admit?: (
        args: {
            ctx: Ctx & AddedCtxFromHooks<Hooks>;
            request: Request;
            signal: AbortSignal;
        },
    ) => | void
    | (() => void | Promise<void>)
    | Promise<void | (() => void | Promise<void>)>

    Acquire once after route hooks, before the SSE response. Beignet releases on every exit, including late acquisition after cancellation.

    channels: ChannelRegistry<NoInfer<Ctx & AddedCtxFromHooks<Hooks>>>
    hooks?: Hooks
    maxLifetimeMs?: number

    Defaults to 60,000 ms. A safe integer from 1 to 3,600,000; leave setup/cleanup headroom below the host request limit.

    metadata?: ContractMeta
    path?: string
    resolveOrigin?: (
        args: { ctx: Ctx & AddedCtxFromHooks<Hooks>; request: Request },
    ) => BroadcastOrigin | undefined

    Use the same authenticated scope resolver at this endpoint and mutation boundaries.

    server:
        | BroadcastServer<Ctx>
        | (() => BroadcastServer<Ctx> | Promise<BroadcastServer<Ctx>>)

    Settings
    Member Visibility

    On This Page
    Properties