https://github.com/freaktechnik/twitchbots-base
Generic API consumer for https://twitchbots.info. Independent of request method.
https://github.com/freaktechnik/twitchbots-base
Last synced: over 1 year ago
JSON representation
Generic API consumer for https://twitchbots.info. Independent of request method.
- Host: GitHub
- URL: https://github.com/freaktechnik/twitchbots-base
- Owner: freaktechnik
- License: mit
- Created: 2016-01-04T00:40:10.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2020-07-17T22:06:46.000Z (about 6 years ago)
- Last Synced: 2025-03-17T17:44:04.485Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/twitchbots-base
- Size: 159 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# twitchbots-base
[](https://travis-ci.org/freaktechnik/twitchbots-base) [](https://codecov.io/gh/freaktechnik/twitchbots-base) [](https://dependencyci.com/github/freaktechnik/twitchbots-base)
This is a base-module for using the [twitchbots.info](https://twitchbots.info)
API with JS. It requires a request function to be passed in. For modules with a
request method built in, see
[jetpack-twitchbots](https://www.npmjs.com/package/jetpack-twitchbots) and
[twitchbots-node](https://www.npmjs.com/package/twitchbots-node).
## Usage
To instantiate, construct the global export of the module, with one argument,
an object of the following form:
```js
{
request: function(url) {
return new Promise(function(resolve, reject) {
//TODO make request. Resolve with parsed JSON on 200 status code,
// else reject with an error that has a "code" attribute with the
// error code.
});
}
}
```
## Methods
All methods resolve to promises.
The return values are explained later on.
- `getBot(username)`: Bot
- `getBots(usernames)`: array
- `getAllBots()`: array (returns only true bots)
- `getAllBotsByType(typeId)`: array (returns only true bots)
- `getType(typeId)`: Type
## Return Values
### Bot
An object with the following properties:
- `isBot`: boolean
- `username`: string
- `type`: typeId (number)
### Type
An object with the following properties:
- `id`: typeId (number)
- `name`: string
- `multiChannel`: boolean
- `url`: string
## License
This project is licensed under the MIT License.