holodex-api v0.2.9-beta
holodexAPI
holodexAPI is a wrapper for the holodex API, written in TypeScript.
Documentation
You can view the docs here
Installation
Use NPM to install holodex-api.
npm i holodex-api
Example
Also view examples
import {holodex} from 'holodex-api';
const client = new holodex({
apiKey: 'APIKEY',
})
client.getChannel('UCoSrY_IQQVpmIRZ9Xf-y93g').then(channel => {
console.log(channel.name); // 'Gawr Gura Ch. hololive-EN'
console.log(channel.englishName); // 'Gawr Gura'
console.log(channel.type); // 'vtuber'
});
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
Testing
If you are going to working with a local copy, you are going to be using the test script a lot. To setup the test script, set the HOLODEX_API_KEY environment variable to your api key. In this example, we will use DOTENV, which the project already uses.
In the root dir, make a .env file.
HOLODEX_API_KEY="API_KEY"
Thats it!
License
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago