Interface CreateHonuaServerRealtimeSubscriptionOptions<TFeature>

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

Type Parameters

  • TFeature = unknown

Hierarchy

Properties

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

Properties

Optional ReadonlybaseUrl

baseUrl?: string

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

Optional ReadonlydecodeEvent

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

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

Optional ReadonlyeventSourceFactory

eventSourceFactory?: RealtimeServerSentEventSourceFactory

Optional ReadonlyeventTypes

eventTypes?: readonly string[]

Optional Readonlyurl

url?: string

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

Optional ReadonlywithCredentials

withCredentials?: boolean

Settings

Member Visibility

On This Page

Properties