@adcp/sdk API Reference - v10.0.1
    Preparing search index...

    Interface OpenFeedStreamOptions

    interface OpenFeedStreamOptions {
        fetchImpl: {
            (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
            (input: string | URL | Request, init?: RequestInit): Promise<Response>;
        };
        baseUrl: string;
        apiKey: string;
        query?: FeedStreamQuery;
        redirect?: "follow"
        | "error";
        maxFrameBytes?: number;
        signal?: AbortSignal;
    }
    Index

    Properties

    fetchImpl baseUrl apiKey query? redirect? maxFrameBytes? signal?

    Properties

    fetchImpl: {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | URL | Request, init?: RequestInit): Promise<Response>;
    }

    Type Declaration

      • (input: URL | RequestInfo, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: URL | RequestInfo
        • Optionalinit: RequestInit

        Returns Promise<Response>

      • (input: string | URL | Request, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: string | URL | Request
        • Optionalinit: RequestInit

        Returns Promise<Response>

    baseUrl: string
    apiKey: string
    query?: FeedStreamQuery
    redirect?: "follow" | "error"

    Redirect policy for the stream fetch. Defaults to 'error', which prevents the Authorization bearer from being replayed to a redirect target. Set 'follow' only with a fully trusted baseUrl — fetch may forward the bearer to the redirect location.

    maxFrameBytes?: number

    Cap on bytes buffered for a single un-dispatched SSE event. See DEFAULT_MAX_SSE_FRAME_BYTES.

    signal?: AbortSignal

    Settings

    Member Visibility

    On This Page

    Properties