Skip to main content

Interface: ClientOptions

Options for a Client

Hierarchy​

Properties​

keys​

• Optional keys: string[]

Keys from Clash of Clans API developer site.

Defined in​

types/lib.ts:14

baseURL​

• Optional baseURL: string

Base URL of the Clash of Clans API.

Defined in​

types/lib.ts:17

retryLimit​

• Optional retryLimit: number

How many times to retry on 5XX errors.

Defined in​

types/lib.ts:22

cache​

• Optional cache: boolean | Store<any>

Whether enable or disable internal caching.

Example

const client = new Client({ cache: true });

Defined in​

types/lib.ts:31

restRequestTimeout​

• Optional restRequestTimeout: number

Time to wait before cancelling a REST request, in milliseconds.

Defined in​

types/lib.ts:34

throttler​

• Optional throttler: null | QueueThrottler | BatchThrottler

Throttler class which handles rate-limit

Example

const client = new Client({ throttler: new QueueThrottler(1000 / 10) });

Example

const client = new Client({ throttler: new BatchThrottler(30) });

Defined in​

types/lib.ts:47