@nekolab/hanime
v0.2.0
Published
Fast and efficient hanime.tv API wrapper written in TypeScript.
Downloads
15
Readme
Installation
Install the library with tool of your choice!
npm
npm i @nekolab/hanime
pnpm
pnpm i @nekolab/hanime
yarn
yarn add @nekolab/hanime
Usage
Here is a simple example of how you can use the library:
import { HanimeClient } from '@nekolab/hanime';
const client = new HanimeClient();
const loginResult = await client.login('[email protected]', 'password');
console.log('Logged in as', loginResult.user.name);
This code will have the following output:
Logged in as User
Features
Currently, the library supports the following features:
- 👤 Login/password authentication without captcha;
- 📹 Videos search, retrieval and download;
- 💬 Comments retrieval;
- 🏠 Home page retrieval;
- 🪙 Coins retrieval;
- 📺 User and channel retrieval.
Planned Features
Here is the list of features that are planned to be implemented in the future:
- 💬 Comments posting and deletion;
- 🔍 Search, search page, filters;
- 🔥 Trending and seasons pages;
- ✏️ Channel management;
- 🖼️ Media upload to Hanime CDN;
- 👑 Hanime premium purchase.
Documentation
The library provides you with a comprehensive documentation on all methods and features.
Contributing
Feel free to contribute, as long as you remember the following simple rules:
- Use conventional commits;
- Follow currently defined file strucutre - there is no need to create new folders under
/src
; - Document both public and private methods;
Scripts
The library has some scripts that will help you in case you want to contribute. After you have finished with your code, use them in the following order:
- Prettify - prettify your code to make it better.
npm run prettify
- Lint - lint code to check for style issues.
npm run lint
- Build - build the library for local testing.
npm run build