@launchdarkly/react-sdk - v4.2.2
    Preparing search index...

    Interface LDEventSourceFactory

    Factory for the EventSource implementation a client-side SDK uses for its streaming connection.

    This should only be used when customizing the streaming transport. Typical usage of the SDK does not require implementing this.

    interface LDEventSourceFactory {
        capabilities?: EventSourceCapabilities;
        createEventSource(
            url: string,
            eventSourceInitDict: EventSourceInitDict,
        ): LDEventSource;
    }
    Index
    capabilities?
    createEventSource
    capabilities?: EventSourceCapabilities

    Capabilities of the event sources this factory produces.

    The SDK checks these before using a feature that not every transport supports -- for instance, it only issues a POST or REPORT streaming request when customMethod is true. When this is omitted, every capability is treated as unsupported.

    customMethod is currently the only capability that changes SDK behavior; declaring headers: false or readTimeout: false does not stop the SDK from supplying those init options.

    • Create an EventSource connected to the given URL with the given initialization options.

      Parameters

      Returns LDEventSource

    Settings
    Member Visibility

    On This Page
    Properties
    Methods