@davidqf555/mal.js v1.2.2

MAL.js

A strongly-typed TypeScript wrapper for the official MyAnimeList API.

Installation

npm install @davidqf555/mal.js

Usage

A client ID can be registered here.

The documentation for the API can be found here.

Example

import MALClient, { FieldsParser } from '@davidqf555/mal.js';

// Create client to access MyAnimeList API
const client = new MALCLient(client_id, client_secret);

// Generate URL for client to authenticate with randomly generated verifer
const { url, code_verifier } = client.requestAuthorization();

// Retrieve token after client authenticates and receives code
const { access_token } = await client.retrieveAuthorizationToken(code, code_verifier);

// Get anime list from a query
const { data } = await client.getAnimeList({ q: 'Sword Art Online', fields: new FieldsParser({ mean: true, rank: true }) });

// Get user anime list of access token owner
const { data } = await client.getUserAnimeList('@me', { status: 'watching' }, access_token);

Client Methods

There is support for user authentication and every documented endpoint.

User Authentication

The supported user authentication methods follow the OAuth 2.0 procedure outlined in the MyAnimeList API documentation.

Endpoint Methods

Each method corresponds to a documented endpoint in the MyAnimeList API.