Skip to content

Documentation


Documentation / @blizzard-api/client / ClientOptions

Interface: ClientOptions ​

Defined in: client/src/client/types.ts:56

A client configuration object.

Example ​

ts
const options: ClientOptions = {
 key: 'client',
 kyOptions: { ... },
 secret: 'secret',
 origin: 'eu',
 locale: 'en_GB',
 token: 'access'
};

Properties ​

key ​

key: string

Defined in: client/src/client/types.ts:57


kyOptions? ​

optional kyOptions?: KyOptions

Defined in: client/src/client/types.ts:58


locale? ​

optional locale?: Locales

Defined in: client/src/client/types.ts:59


maxAttempts? ​

optional maxAttempts?: number

Defined in: client/src/client/types.ts:60


origin ​

origin: Origins

Defined in: client/src/client/types.ts:61


retryOnRateLimit? ​

optional retryOnRateLimit?: boolean

Defined in: client/src/client/types.ts:62


secret ​

secret: string

Defined in: client/src/client/types.ts:63


token? ​

optional token?: string

Defined in: client/src/client/types.ts:64