openmixer — generated API reference
    Preparing search index...

    Interface ConsoleClientConfig

    Configuration for ConsoleClient.

    interface ConsoleClientConfig {
        baseUrl: string;
        fetch?: {
            (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
            (input: string | URL | Request, init?: RequestInit): Promise<Response>;
        };
        maxRetryMs?: number;
        retryMs?: number;
    }
    Index
    baseUrl fetch? maxRetryMs? retryMs?
    baseUrl: string

    The console's API root, e.g. http://127.0.0.1:8800/api. Always supplied by the caller — a compiled-in default is a console somebody else is running.

    fetch?: {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | URL | Request, init?: RequestInit): Promise<Response>;
    }

    fetch override, for tests and for a caller with its own agent.

    Type Declaration

      • (input: URL | RequestInfo, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: URL | RequestInfo
        • Optionalinit: RequestInit

        Returns Promise<Response>

      • (input: string | URL | Request, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: string | URL | Request
        • Optionalinit: RequestInit

        Returns Promise<Response>

    maxRetryMs?: number
    retryMs?: number

    How long to wait before re-dialling a stream that ended. Doubles to maxRetryMs.

    Settings
    Member Visibility

    On This Page
    Properties