openmixer — generated API reference
    Preparing search index...

    Interface RestRouterOptions

    Wiring for RestRouter.

    interface RestRouterOptions {
        onBroadcast?: (frame: ResourceBroadcast<object>) => void;
        prefix?: string;
        pumped?: (path: string) => boolean;
        registry: ResourceRegistry;
        revisionOf?: () => number;
    }
    Index
    onBroadcast?: (frame: ResourceBroadcast<object>) => void

    Called once per accepted PATCH with the frame the registry derived by re-reading the state. The host fans it out to its clients; the router neither builds nor addresses it.

    prefix?: string

    Path prefix the host mounts the router at. Default /api.

    pumped?: (path: string) => boolean

    Whether path is PUMP-FED — the console's pump table, asked per request, never copied. The same predicate the stream hub derives its pumped from, so the contract a client reads and the frames it is sent cannot describe two different desks. Absent: no row is flagged.

    The one registry this console registered its entities into.

    revisionOf?: () => number

    The console revision right now — stamps state bodies (see RestStateBody.rev).