@squawk
    Preparing search index...

    Interface SourceFeedOptions

    Options for createAircraftFeedForSource. A flat bag covering all three sources, so a caller that picks the source at runtime (a CLI flag, a config file) can pass one object regardless of which source was chosen. Options that do not apply to the selected source are ignored.

    interface SourceFeedOptions {
        fetch?: (
            input: string | URL | Request,
            init?: RequestInit,
        ) => Promise<Response>;
        host: string;
        pollIntervalMs?: number;
        port?: number;
        positionHistoryRetention?: PositionHistoryRetention;
        receiverPosition?: Pick<Position, "lat" | "lon">;
        reconnectDelayMs?: number;
        source: FeedSource;
        staleAfterMs?: number;
        sweepIntervalMs?: number;
        url?: string;
    }

    Hierarchy (View Summary)

    Index
    fetch? host pollIntervalMs? port? positionHistoryRetention? receiverPosition? reconnectDelayMs? source staleAfterMs? sweepIntervalMs? url?
    fetch?: (input: string | URL | Request, init?: RequestInit) => Promise<Response>

    Override for the global fetch. Applies to the json source only.

    host: string

    Hostname or IP address of the dump1090-fa station.

    pollIntervalMs?: number

    Polling interval in ms. Applies to the json source only - see JsonFeedOptions.pollIntervalMs.

    port?: number

    Port to connect to. Defaults to the selected source's entry in DEFAULT_PORT_BY_SOURCE.

    positionHistoryRetention?: PositionHistoryRetention

    How much position history to retain per aircraft. Unbounded (subject to memory) if omitted.

    receiverPosition?: Pick<Position, "lat" | "lon">

    The receiving station's own position. Applies to the beast source only - see BeastFeedOptions.receiverPosition.

    reconnectDelayMs?: number

    Delay in ms before reconnecting after the connection closes or errors. Applies to the sbs and beast sources only.

    source: FeedSource

    Which dump1090-fa output to connect to.

    staleAfterMs?: number

    Milliseconds an aircraft can go without an update before aircraft:lost fires. Defaults to 60000.

    sweepIntervalMs?: number

    Milliseconds between staleness sweeps. An aircraft is dropped on the first sweep after staleAfterMs elapses, so this bounds how late aircraft:lost can fire. Defaults to 1000.

    url?: string

    Full aircraft.json URL, used as-is instead of one assembled from host/port. Applies to the json source only.

    Settings
    Member Visibility

    On This Page
    Properties