@tdanks2000/anilist-wrapper NPM

The AniList Api Wrapper simplifies the process of making API requests to AniList, a popular anime and manga database. It encapsulates functionality related to various API endpoints, such as activity, lists, media, people, recommendations, search, threads, and user-related features. With this wrapper, developers can quickly integrate AniList functionality into their TypeScript projects.

Installation

To install the AniList TypeScript Wrapper, follow these steps:

Run the following command in your project directory:

// npm
npm install @tdanks2000/anilist-wrapper
// yarn
yarn add @tdanks2000/anilist-wrapper
// pnpm
pnpm i @tdanks2000/anilist-wrapper

Usage

To use the AniList TypeScript Wrapper in your TypeScript project, import the necessary classes and functions:

import { Anilist } from "@tdanks2000/anilist-wrapper";

Then, create an instance of the AniList class, optionally providing an access token:

const anilist = new Anilist("YOUR_ACCESS_TOKEN");

You can now use the anilist object to access various functionalities of the AniList API. See the next section for details on available functionality.

Authentication

Authentication is required to access certain endpoints and perform actions on behalf of a user. To authenticate with the AniList API, you need to obtain an access token. Visit the AniList website and follow their documentation to generate an access token. When creating an instance of the AniList class, you can provide the access token as a parameter to enable authenticated access to specific features.

Functionality

The AniList Api Wrapper provides the following functionality through dedicated services:

anime: Access anime-related information, including details, characters, staff, recommendations, and relations.
character: Retrieve information about specific characters.
manga: Access manga-related information, similar to the anime service.
media: General media functions, potentially overlapping with anime/manga but may offer broader searches or combined results.
mediaList: Manage user's media lists (anime and manga).
staff: Retrieve information about staff members (voice actors, directors, etc.).
user: Access user profiles, statistics, and lists.

Contributing

Contributions to the AniList TypeScript Wrapper are welcome! If you find a bug, have a feature suggestion, or want to contribute improvements, please follow the contribution guidelines outlined in the repository.

License

The AniList TypeScript Wrapper is licensed under the MIT License. Make sure to review the license file for detailed terms and conditions.

Feel free to use, modify, and distribute this library as per the license terms.

Thank you for using the AniList Api Wrapper! If you have any questions or need further assistance, please contact the project team or refer to the documentation available in the repository.