gnap-caep-risc-nodejs
    Preparing search index...

    Interface SignalsReceiverOptions

    interface SignalsReceiverOptions {
        description?: string;
        endOn?: readonly string[];
        eventsRequested?: readonly string[];
        headers?: (
            request: SignedRequest,
        ) => Record<string, string> | Promise<Record<string, string>>;
        log?: Pick<Console, "error" | "info" | "warn">;
        maxEvents?: number;
        onEndSessions: (
            localIds: string[],
            event: SignalEvent,
        ) => void | Promise<void>;
        pollIntervalMs?: number;
        sessionIndex?: SessionIndex;
        tls?: TlsOptions;
        transmitter: string;
    }
    Index
    description?: string

    A description of the stream, shown at the transmitter.

    endOn?: readonly string[]

    The event types that end the matching local sessions.

    eventsRequested?: readonly string[]

    The event types to ask for. Default: the CAEP session and credential events and the RISC account events.

    headers?: (
        request: SignedRequest,
    ) => Record<string, string> | Promise<Record<string, string>>

    Headers for every call. A GNAP access token is Authorization: GNAP <token> plus the key proof. The argument is the request about to be sent, so the proof can cover its body.

    log?: Pick<Console, "error" | "info" | "warn">

    Where the receiver logs. Default console.

    maxEvents?: number

    At most this many SETs per poll. Default 50.

    onEndSessions: (localIds: string[], event: SignalEvent) => void | Promise<void>

    Called with the local sessions an event ends. End them in the application's session store.

    pollIntervalMs?: number

    How long to wait between polls when nothing was waiting, in milliseconds. Default 5000.

    sessionIndex?: SessionIndex

    The session index. The default is this process's memory.

    tls?: TlsOptions

    TLS for every call: ca to trust, and cert + key to present (mutual TLS).

    transmitter: string

    The transmitter's issuer. Its configuration is read from /.well-known/ssf-configuration.