Creating a client instance
The first thing you do is create an authentication provider. The easiest way to get one is to supply static credentials. From that, you can create your Twitch API client.
import { ApiClient } from 'twitch';
import { StaticAuthProvider } from 'twitch-auth';
const clientId = '123abc';
const accessToken = 'def456';
const authProvider = new StaticAuthProvider(clientId, accessToken);
const apiClient = new ApiClient({ authProvider });
You can also have the client refresh the tokens automatically if necessary by wrapping it in a RefreshableAuthProvider with the necessary data:
import { ApiClient } from 'twitch';
import { AccessToken, RefreshableAuthProvider, StaticAuthProvider } from 'twitch-auth';
const clientId = '123abc';
const accessToken = 'def456';
const clientSecret = 'foobar';
const refreshToken = '999999';
const authProvider = new RefreshableAuthProvider(
new StaticAuthProvider(clientId, accessToken),
{
clientSecret,
refreshToken,
onRefresh: (token: AccessToken) => {
// do things with the new token data, e.g. save them in your database
}
}
);
const apiClient = new ApiClient({ authProvider });
There's a more elaborated example on how to make auto refreshing work in the twitch-chat-client documentation.
If you don't need any user scopes, you may also create the client using client credentials:
import { ApiClient } from 'twitch';
import { ClientCredentialsAuthProvider } from 'twitch-auth';
const clientId = '123abc';
const clientSecret = 'foobar';
const authProvider = new ClientCredentialsAuthProvider(clientId, clientSecret);
const apiClient = new ApiClient({ authProvider });
The following sections assume that you have created an
apiClient already.