• lib
• ClientOptions

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

Optionaltelemetry

telemetry?: boolean

OptionalclientInfo

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

Optionalfetch

fetch?: FetchAPI

Provide your own fetch implementation.

Optionalagent

agent?: Dispatcher

Pass your own http agent to support proxies.

Optionalheaders

headers?: HTTPHeaders

Custom headers that will be added to every request.

OptionaltimeoutDuration

timeoutDuration?: number

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

Optionalretry

retry?: RetryConfiguration

Retry configuration.

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties telemetryclientInfofetchagentheaderstimeoutDurationretry