@gibme/starlink
    Preparing search index...

    Type Alias Options

    Construction options for the local gRPC clients (Dishy, WiFiRouter).

    type Options = {
        headers?: Record<string, string>;
        host?: string;
        port?: number;
        timeout?: number;
        tls?: boolean | TlsOptions;
    }
    Index

    Properties

    headers? host? port? timeout? tls?

    Properties

    headers?: Record<string, string>

    Additional headers attached to every gRPC call. Useful when the device is reached through a reverse proxy that requires an API key.

    host?: string

    Target host. Subclasses provide a sensible LAN default.

    port?: number

    Target port. Subclasses provide a sensible LAN default.

    timeout?: number

    Per-call timeout in milliseconds.

    tls?: boolean | TlsOptions

    Enable TLS to reach the device through a reverse proxy. true uses the system trust store with strict hostname verification. An object enables TLS and lets the caller supply a custom CA bundle and/or disable verification.

    Settings

    Member Visibility

    On This Page

    Properties