Package Exports

twitch-oauth
twitch-oauth/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (twitch-oauth) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Twitch OAuth

Authenticate users with Twitch.

💻 Getting started

# With npm:
npm install twitch-oauth

# With yarn:
yarn add twitch-oauth

📚 Usage

As a ES Module

import { TwitchOAuth } from 'twitch-oauth';

// Initialize client.
const client = new TwitchOAuth({
  clientId: '..............',
  clientSecret: '..........',
  redirectUri: '...........',
  scope: [
    "user:read:email",
    "......"
  ],
  // Optional, can be "token" or "code" (code is by default and recommended)
  method: "code"
});

// Get the auth redirect url.
client.authenticate(); // Returns https://id.twitch.tv/oauth2/authorize?....

// Get access and refresh token using the code that twitch sends the frontend.
client.verifyCodeResponse(code: string)
    .then(console.log);

// Check if access token still valid.
client.validate(access_token: string);

// Refresh expired token.
client.refresh(refresh_token: string);

As CJS Module

// If uses require function you will need to use .default
// For import in typescript, this is not required
const { TwitchOAuth } = require('twitch-oauth').default;

🤝 Contributing

Contributions, issues and feature requests are welcome! Feel free to check issues page.

❤️ Show your support

Give a ⭐️ if this project helped you!

Or buy me a coffeelatte 🙌🏾

Ko-fi | Patreon

twitch-oauth