Theia API Documentation v1.76.0
    Preparing search index...

    Interface ExternalApiEventStreamOptions<T>

    Instantiation options of an ExternalApiEventStream.

    interface ExternalApiEventStreamOptions<T = unknown> {
        coalesceDelay?: number;
        dataSchema?: IJSONSchema;
        description?: string;
        event: string;
        heartbeatInterval?: number;
        operationId?: string;
        snapshot?: () => MaybePromise<T>;
        summary?: string;
    }

    Type Parameters

    • T = unknown
    Index

    Properties

    coalesceDelay? dataSchema? description? event heartbeatInterval? operationId? snapshot? summary?

    Properties

    coalesceDelay?: number

    Delay in milliseconds by which ExternalApiEventStream.notifyChanged broadcasts are coalesced. Defaults to 100.

    dataSchema?: IJSONSchema

    JSON Schema of the event payloads, published in the OpenAPI document.

    description?: string

    Longer description of the stream, published in the OpenAPI document; CommonMark.

    event: string

    Name under which the events are sent, i.e. the event: field of each server-sent event.

    heartbeatInterval?: number

    Interval in milliseconds of the keep-alive comments sent to connected clients. Defaults to 30000.

    operationId?: string

    Stable operation id of the stream's route, unique across the external API, published in the OpenAPI document.

    snapshot?: () => MaybePromise<T>

    Provides the data snapshot that is sent to each connecting client and broadcast, coalesced, on ExternalApiEventStream.notifyChanged.

    summary?: string

    Short summary of the stream, published in the OpenAPI document.

    Settings

    Member Visibility

    On This Page

    Properties