Interface AdminClientOptions

interface AdminClientOptions {
    adminServerUrl?: string;
    adminStreamReconnectAttempts?: number;
    debug?: boolean;
    requestOptions?: {
        headers?: {
            [key: string]: string;
        };
    };
}

Properties

adminServerUrl? adminStreamReconnectAttempts? debug? requestOptions?

Properties

OptionaladminServerUrl

adminServerUrl?: string

The full URL to use to connect to a Mockttp admin server when using a remote (or local but browser) client.

When using a local server, this option is ignored.

OptionaladminStreamReconnectAttempts

adminStreamReconnectAttempts?: number

If the admin stream disconnects, how many times should we try to reconnect? Increasing this can be useful in unstable environments, such as desktop app use case, while fewer retries will provide faster shutdown in environments where you may be killing processes intentionally.

Optionaldebug

debug?: boolean

Should the client print extra debug information?

OptionalrequestOptions

requestOptions?: {
    headers?: {
        [key: string]: string;
    };
}

Options to include on all client requests.

Settings

Member Visibility

On This Page

Properties