JSPM

  • Created
  • Published
  • Downloads 1268
  • Score
    100M100P100Q103663F
  • License MIT

Javascript library for the Twitch Messaging Interface.

Package Exports

  • twitch-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-js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

TwitchJS

Travis branch npm npm GitHub issues Coverage Status

A community-centric, community-supported version of tmi.js.

Contribution guidelines

If you wish to contribute, please see the CONTRIBUTING doc.

Getting started

Installation

CommonJS

If you are using a module bundler, such Webpack, Browserify, or a in a Node environment:

  1. Add TwitchJS to your project:
    npm install --save twitch-js
  2. Import TwitchJS
    // ES2015 syntax
    import Twitch from 'twitch-js';
    
    // OR ES5 syntax
    var twitch = require('twitch-js');

UMD

If you are not using a module bundler, precompiled builds are available in the dist folder:

  1. Include a script tag in your HTML:
    <script src="//https://unpkg.com/twitch-js/"></script>
  2. Consume the library:
    <script type="javascript">
    windows.TwitchJS ...
    </script>

For more information, please see the original tmi.js documentation.

Special thanks

Schmoopiie and all the original contributors of tmi.js.

License

MIT