jshelix
v2.0.17
Published
Typescript Helix API
Downloads
35
Readme
jsHelix
jsHelix is a Typescript wrapper to the Twitch Helix API.
Requirements
- Tested against New Twitch API (Helix)
- For Node.js you will need the xmlhttprequest library.
- A Twitch token, get yours here: https://twitchtokengenerator.com
Documentation
Getting Started
If you are using Node.js, install jsHelix using npm:
$ npm install jshelix
You can now require and use jshelix like so:
import jsHelix from "jshelix";
const TWITCH_CLIENT = process.env.TWITCH_CLIENT;
const TWITCH_TOKEN = process.env.TWITCH_TOKEN;
const hapi = jsHelix(TWITCH_CLIENT!, TWITCH_TOKEN);
hapi
.getUsers({ login: "Sighmir" })
.then((users) => {
hapi
.getUserFollows({ from_id: users.data![0].id })
.then((data) => {
console.log(data);
})
.catch((err) => console.log(err));
})
.catch((err) => console.log(err));
Refer to the Helix API Documentation and the jsHelix Example for more information.
Browser
You can also load this script on your browser like so:
<script src="https://cdn.jsdelivr.net/npm/jshelix/dist/bundle.js"></script>
You can now use jsHelix normally on the page, like you would on Node.js.
License
jsHelix - Helix API Javascript Library.
Copyright (C) 2019 Guilherme Caulada (Sighmir)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.