Socket
Socket
Sign inDemoInstall

twitch-api-ts

Package Overview
Dependencies
9
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    twitch-api-ts

Modern wrapper for the Twitch API with typings.


Version published
Weekly downloads
6
Maintainers
1
Install size
573 kB
Created
Weekly downloads
 

Readme

Source

Twitch API

Modern wrapper for the Twitch API with typings.

💻 Getting started

# With npm:
npm install twitch-api-ts

# With yarn:
yarn add twitch-api-ts

📚 Usage

As a ES Module

import { TwitchAPI } from 'twitch-api-ts';

// Initialize client.
const client = new TwitchOAuth({
  clientId: '..............',
  accessToken: '..........',
});

As CJS Module

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

📝 To Do

  • Bits:
    • Get bits leaderboard.
    • Get Cheermotes.
    • Get Extension Transactions.
  • Channels:
    • Get channel information.
    • Modify channel information.
    • Get channel editors.
  • Channel Points:
    • Create custom rewards.
    • Get custom rewards.
    • Get rewards redemptions.
    • Delete custom rewards.
    • Update custom rewards.
    • Update redemption status.
  • Charity:
    • Get charity campaign.
    • Get charity campaign donations.
  • Chat:
    • Get chatters.
    • Get channel emotes.
    • Get global emotes.
    • Get emote sets.
    • Get channel chat badges.
    • Get chat settings.
    • Update chat settings.
    • Get user chat color.
    • Update user chat color.
  • Clips:
    • Create clip.
    • Get clips.
  • Entitlements:
    • Get code status.
    • Get drrops entitlements.
    • Update drops entitlements.
    • Redeem code. Users:
    • Get users. And more...

🤝 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

📝 License

Copyright © 2022 Sammwy.
This project is MIT licensed.

Keywords

FAQs

Last updated on 05 Jun 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc