@playlive/react-pipeline
    Preparing search index...

    Interface RealtimePipelineProviderProps

    Props accepted by RealtimePipelineProvider. Every initial* key is forwarded to createPipelineStore; the connection-only knobs live alongside.

    interface RealtimePipelineProviderProps {
        autoConnect?: boolean;
        children: ReactNode;
        connection?: PipelineConnection;
        initialAdminApiKey?: string | null;
        initialAutoConnect?: boolean;
        initialCampaignIDs?: string[];
        initialCampaigns?: TiltifyCampaign[];
        initialCauseIDs?: string[];
        initialCauses?: TiltifyCause[];
        initialDonationTrainsEnabled?: boolean;
        initialDonorSpotlightEnabled?: boolean;
        initialFundraisingEventIDs?: string[];
        initialFundraisingEvents?: TiltifyFundraisingEvent[];
        initialOverlayConfig?: Record<string, string>;
        initialOverlayName?: string;
        initialOverlayPath?: string;
        initialProxyURL?: string | null;
        initialSubathonTimerEnabled?: boolean;
        initialTeamCampaignIDs?: string[];
        initialTeamCampaigns?: TiltifyTeamCampaign[];
        initialTeamUserSlug?: string;
        initialTwitchUsername?: string | null;
        initialURL?: string;
        log?: (msg: string, payload?: unknown) => void;
        reloadOnErrorReconnect?: boolean;
        store?: StoreApi<PipelineStore>;
        url?: string;
        webSocketCtor?: WebSocketCtor;
    }

    Hierarchy

    • InitialProps
      • RealtimePipelineProviderProps
    Index
    autoConnect? children connection? initialAdminApiKey? initialAutoConnect? initialCampaignIDs? initialCampaigns? initialCauseIDs? initialCauses? initialDonationTrainsEnabled? initialDonorSpotlightEnabled? initialFundraisingEventIDs? initialFundraisingEvents? initialOverlayConfig? initialOverlayName? initialOverlayPath? initialProxyURL? initialSubathonTimerEnabled? initialTeamCampaignIDs? initialTeamCampaigns? initialTeamUserSlug? initialTwitchUsername? initialURL? log? reloadOnErrorReconnect? store? url? webSocketCtor?
    autoConnect?: boolean

    Auto-open the connection on mount. Default true for this provider so <RealtimePipelineProvider> is one-stop drop-in.

    children: ReactNode

    Subtree to mount.

    connection?: PipelineConnection

    Pre-built PipelineConnection. When supplied, the provider skips createPipelineConnection(...) entirely — useful in tests + GreenRoom harnesses where you want to drive the store manually.

    initialAdminApiKey?: string | null
    initialAutoConnect?: boolean
    initialCampaignIDs?: string[]
    initialCampaigns?: TiltifyCampaign[]
    initialCauseIDs?: string[]
    initialCauses?: TiltifyCause[]
    initialDonationTrainsEnabled?: boolean
    initialDonorSpotlightEnabled?: boolean
    initialFundraisingEventIDs?: string[]
    initialFundraisingEvents?: TiltifyFundraisingEvent[]
    initialOverlayConfig?: Record<string, string>
    initialOverlayName?: string
    initialOverlayPath?: string
    initialProxyURL?: string | null
    initialSubathonTimerEnabled?: boolean
    initialTeamCampaignIDs?: string[]
    initialTeamCampaigns?: TiltifyTeamCampaign[]
    initialTeamUserSlug?: string
    initialTwitchUsername?: string | null
    initialURL?: string
    log?: (msg: string, payload?: unknown) => void

    Verbose logger for the underlying connection.

    reloadOnErrorReconnect?: boolean
    store?: StoreApi<PipelineStore>

    Pre-built PipelineStoreApi. When supplied, the provider skips createPipelineStore(initialProps) and uses your store directly. Handy for tests + advanced consumers that already manage their own store lifecycle.

    url?: string

    Override the WebSocket URL. Defaults to store.getState().wsURL (which itself defaults to DEFAULT_WEBSOCKET_URL from config).

    webSocketCtor?: WebSocketCtor

    Optional native WebSocket ctor (testing / non-browser hosts). Defaults to globalThis.WebSocket.

    Settings
    Member Visibility

    On This Page
    Properties