Operation reference
This reference lists each public AniLink operation for both providers. The scripts/generate-operation-reference.ts script builds the per-operation catalog from source metadata during npm run docs:generate.
What each operation page shows
Every operation entry has the same sections:
| Section | Contents |
|---|---|
| Signature | The callable TypeScript signature |
| Request | Variables (AniList GraphQL) or path/query/options parameters (MAL REST), with type, required flag, and description |
| Response | The return type and its documented fields |
| Auth | Whether an access token is required and which credential slot supplies it |
| Errors | Thrown error classes and when each occurs |
| Example | A runnable sample extracted from the source JSDoc |
| Links | The TypeDoc page and the upstream AniList or MAL reference |
Catalogs
- AniList operation catalog covers queries, page queries, mutations, and
custom(). - MyAnimeList operation catalog covers anime, manga, user, and forum operations.