@honua/sdk-js
    Preparing search index...

    Interface CreateHonuaServerRealtimeSubscriptionOptions<TFeature>

    interface CreateHonuaServerRealtimeSubscriptionOptions<TFeature = unknown> {
        baseUrl?: string;
        decodeEvent?: (payload: unknown) => RealtimeFeatureEvent<TFeature>;
        eventSourceFactory?: RealtimeServerSentEventSourceFactory;
        eventTypes?: readonly string[];
        url?: string;
        withCredentials?: boolean;
    }

    Type Parameters

    • TFeature = unknown

    Hierarchy

    Index

    Properties

    baseUrl? decodeEvent? eventSourceFactory? eventTypes? url? withCredentials?

    Properties

    baseUrl?: string

    honua-server origin, e.g. https://honua.example. The /api/v1/streaming/features path is appended automatically. Mutually exclusive with CreateHonuaServerRealtimeSubscriptionOptions.url.

    decodeEvent?: (payload: unknown) => RealtimeFeatureEvent<TFeature>

    Override the honua-server feature-change decoder while keeping the serviceId= / layers= query encoding.

    eventSourceFactory?: RealtimeServerSentEventSourceFactory
    eventTypes?: readonly string[]
    url?: string

    Full streaming-features URL. Use this when the endpoint lives at a non-default path. Overrides CreateHonuaServerRealtimeSubscriptionOptions.baseUrl.

    withCredentials?: boolean

    Settings

    Member Visibility

    On This Page

    Properties