https://github.com/promisependingapis/twitch.js

Twitchʲˢ is a [UNOFFICIAL] api to interact with Twitch IRC
https://github.com/promisependingapis/twitch.js

javascript nodejs twitch twitchdev

Last synced: 26 days ago
JSON representation

Twitchʲˢ is a [UNOFFICIAL] api to interact with Twitch IRC

• Host: GitHub
• URL: https://github.com/promisependingapis/twitch.js
• Owner: promisependingapis
• License: mit
• Created: 2020-11-05T04:33:36.000Z (about 4 years ago)
• Default Branch: release
• Last Pushed: 2024-05-22T11:21:54.000Z (7 months ago)
• Last Synced: 2024-08-13T22:14:16.709Z (4 months ago)
• Topics: javascript, nodejs, twitch, twitchdev
• Language: TypeScript
• Homepage: https://twitch.js.org
• Size: 1.73 MB
• Stars: 40
• Watchers: 1
• Forks: 7
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-twitch-dev - twitchapis/twitch.js - Twitchjs is an unofficial powerful Node.js module that allows you to easily interact with Twitch. (Libraries / Python)

README

        


  

  

  

  

  






  Table of Contents

  


    


      About The Project

    

    


      Getting Started

      


        
NPM Installation

        
YARN Installation

      

    

    
Usage

    
Contributors

    
Authors

  


## About

Twitchʲˢ is a [UNOFFICIAL] api to interact with Twitch IRC.

- Object-oriented

- Predictable abstractions

- Performant

## Installing

**Node.js 12.22.X or newer is required.**

- npm:

```bat

npm i @twitchapis/twitch.js

```

- yarn:

```bat

yarn add @twitchapis/twitch.js

```

## Example Usage

```javascript

const { Client } = require('@twitchapis/twitch.js');

const client = new Client({

    channels: ['space_interprise', 'lobometalurgico'],

});

client.on('ready', () => {

    console.log(`Logged in as ${client.user.name}!`);

});

client.on('message', (msg) => {

    if (msg.content === 'ping') {

        msg.channel.send('pong');

    }

});

client.login('token');

```

## Contributors

### Thanks to all of the [contributors](https://github.com/twitchapis/twitch.js/graphs/contributors)!

## Authors

| [
Lobo Metalurgico](https://github.com/LoboMetalurgico) | [
Space_Interprise](https://github.com/emanuelfranklyn) |

| :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |