TwurpleAuthenticationGetting dataExamplesFAQMigration

Main classes

ApiConfig

Configuration for an ApiClient instance.

{
An authentication provider that supplies tokens to the client.
The time that should be waited before a batch is executed, in milliseconds.
batchDelay?: number
Additional options to pass to the fetch method.
Options to pass to the logger.
logger?: Partial<LoggerOptions>
The port your local mock server (from the Twitch CLI) runs on.
}

Properties

authProvider

Type: AuthProvider

An authentication provider that supplies tokens to the client.

For more information, see the AuthProvider documentation.

batchDelay

Type: ?number

The time that should be waited before a batch is executed, in milliseconds.

Defaults to 0 (executes immediately after all synchronous tasks are finished).

fetchOptions

Type: ?TwitchApiCallFetchOptions

Additional options to pass to the fetch method.

logger

Type: ?Partial<LoggerOptions>

Options to pass to the logger.

mockServerPort

Type: ?number

The port your local mock server (from the Twitch CLI) runs on.

Do not set this if you want to use the real production Twitch API.