Interface ClientOptions

interface ClientOptions {
    telemetry?: boolean;
    clientInfo?: { name: string; [key: string]: unknown };
    fetch?: FetchAPI;
    agent?: Dispatcher;
    headers?: HTTPHeaders;
    timeoutDuration?: number;
    retry?: RetryConfiguration;
}

Hierarchy (View Summary)

Omit<Configuration, "baseUrl" | "parseError" | "middleware">
- ClientOptions
  - AuthenticationClientOptions

Index

Properties

telemetry? clientInfo? fetch? agent? headers? timeoutDuration? retry?

Properties

`Optional`telemetry

telemetry?: boolean

`Optional`clientInfo

clientInfo?: { name: string; [key: string]: unknown }

`Optional`fetch

fetch?: FetchAPI

Provide your own fetch implementation.

`Optional`agent

agent?: Dispatcher

Pass your own http agent to support proxies.

`Optional`headers

headers?: HTTPHeaders

Custom headers that will be added to every request.

`Optional`timeoutDuration

timeoutDuration?: number

Timeout in ms before aborting the request (default 10,000)

`Optional`retry

retry?: RetryConfiguration

Retry configuration.