Auth0 Node.js SDK - v7.6.0
    Preparing search index...

    Interface Args

    interface Args {
        stream: ReadableStream;
        eventShape: JsonEvent | SseEvent;
        signal?: AbortSignal;
        reconnectionEnabled?: boolean;
        maxReconnectionAttempts?: number;
        reconnect?: (lastEventId: string) => Promise<ReadableStream<any>>;
    }
    Index
    stream eventShape signal? reconnectionEnabled? maxReconnectionAttempts? reconnect?
    stream: ReadableStream

    The HTTP response stream to read from.

    eventShape: JsonEvent | SseEvent

    The event shape to use for parsing the stream data.

    signal?: AbortSignal

    An abort signal to stop the stream.

    reconnectionEnabled?: boolean

    Whether transparent mid-stream reconnection is enabled on resumable SSE endpoints. Defaults to true. Has no effect on non-resumable endpoints.

    maxReconnectionAttempts?: number

    Maximum number of consecutive failed reconnect attempts on resumable SSE endpoints before giving up. The counter resets to zero each time a reconnected stream successfully yields at least one event (i.e. makes progress). Has no effect on non-resumable endpoints.

    reconnect?: (lastEventId: string) => Promise<ReadableStream<any>>

    A function that re-issues the HTTP request with the Last-Event-ID header and returns the new response body stream. Required for reconnection to work.

    Settings
    Member Visibility

    On This Page
    Properties