Repository files navigation

consumet.ts is a Node library which provides high-level APIs to get information about several entertainment mediums like books, movies, comics, anime, manga, etc.

• Quick Start
  • Installation
  • Usage
• Documentation
• Ecosystem
• Provider Request
• Contributing
• Support
• Contributors ✨
  • Credits
• License

To use consumet.ts in your project, run:

yarn add @consumet/extensions# or "npm i @consumet/extensions"

Example - searching for a book using the libgen provider.

import{BOOKS}from"@consumet/extensions"// Create a new instance of the Libgen providerconstbooks=newBOOKS.Libgen();// Search for a book. In this case, "Pride and Prejudice"constdata=books.search('pride and prejudice').then(data=>{// print resultsconsole.log(data)})

Example - searching for anime using the gogoanime provider.

import{ANIME}from"@consumet/extensions"// Create a new instance of the Gogoanime providerconstgogoanime=newANIME.Gogoanime();// Search for an anime. In this case, "One Piece"constresults=gogoanime.search("One Piece").then(data=>{// print resultsconsole.log(data);})

Do you want to know more? Head to theGetting Started.

• Getting Started
• Guides
• Anime
• Manga
• Books
• Movies
• Light Novels
• Comics
• Meta
• News

• Rest-API Reference - public rest api documentation
• Examples - examples of using consumet.ts.
• Provider Status - A list of providers and their status.
• Changelog - See the latest changes.
• Discord Server - Join our discord server and chat with the maintainers.

Make a newissue with the name of the provider on the title, as well as a link to the provider in the body paragraph.

Check outcontributing guide to get an overview of consumet.ts development.

You can contact the maintainers of consumet.ts viaemail, orjoin the discord server (Recommended).

Thanks to the following people for keeping this project alive and thriving.

• Anify API - Used as a caching layer for the meta/anilist provider to speed up responses.

Licensed underGPL-3.0.