bachig26 / consumet.ts

Nodejs library that provides high-level APIs for obtaining information on various entertainment media such as books, movies, comic books, anime, manga, and so on.

consumet.ts

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.

Table of Contents

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

Quick Start

Installation

To use consumet.ts in your project, run:

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

Usage

Example - searching for a book using the libgen provider.

import { BOOKS } from "@consumet/extensions"

// Create a new instance of the Libgen provider
const books = new BOOKS.Libgen();
// Search for a book. In this case, "Pride and Prejudice"
const data = books.search('pride and prejudice').then(data => {
  // print results
  console.log(data)
})

Exmaple - searching for anime using the gogoanime provider.

import { ANIME } from "@consumet/extensions"

// Create a new instance of the Gogoanime provider
const gogoanime = new ANIME.Gogoanime();
// Search for an anime. In this case, "One Piece"
const results = gogoanime.search("One Piece").then(data => {
  // print results
  console.log(data);
})

Do you want to know more? Head to the Getting Started.

Documentation

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

Ecosystem

• 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.

Provider Request

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

Contributing

Check out contributing guide to get an overview of consumet.ts development.

Support

You can contact the maintainers of consumet.ts via email, or join the discord server (Recommended).

Contributors ✨

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

Credits

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

License

Licensed under MIT.