/mal-ts

TypeScript-safe MyAnimeList Public API wrapper

Primary LanguageTypeScriptMIT LicenseMIT

mal-ts

TypeScript-safe MyAnimeList Public API wrapper

Installation

# npm
npm install mal-ts

# yarn
yarn add mal-ts

Usage

// commonjs
const MyAnimeList = require('mal-ts');
const mal = new MyAnimeList('client_id');
...

// module
import MyAnimeList from 'mal-ts'
const mal = new MyAnimeList('client_id');
...

Replace client_id with your MyAnimeList Application's Client ID

API

Method Description
defaultFields Default fields
anime(id[, fields]) Get anime details
manga(id[, fields]) Get manga details

Promises

mal-ts depends on a native ES6 Promise implementation to be supported. If your environment doesn't support ES6 Promises, you can polyfill.

TypeScript

mal-ts includes TypeScript definitions.

TSDoc (JSDoc) descriptions are derived from the MyAnimeList API reference

License

MIT