Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@consumet/extensions

consumet2.3kMIT1.8.1TypeScript support: included

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, scraper, streaming, anime, books, comics, movies, manga, light-novels, news, meta

readme

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.

npm (scoped) npm (scoped) Prs are welcome Discord GitHub

Table of Contents

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)
})

Example - 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

Ecosystem

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

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

License

Licensed under MIT.

changelog

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

Generated by auto-changelog.

v1.4.16

Commits

  • add fmovies to providers-list 9ab35e2

v1.4.16 - 2023-03-13

Merged

  • Added Fmovies to index.ts #306
  • Fixed 9anime's search #304
  • chore(build) yarn build #303
  • change tld to .gr #302
  • Added Fmovies #300
  • chore(build) yarn build #299
  • Fixed vizcloud #298
  • Fix 9anime search #294
  • Build #291
  • 9anime fix #290

v1.4.15 - 2023-03-04

Merged

  • Fix unused imports for ComicK #288
  • Added ComicK #287
  • Fix Vizcloud #286
  • Qualities for Vizcloud #283
  • fix: scraping sub/dub info now works for nineanime #279
  • fixed spelling error of subOrDub (was suborsub) #277
  • fix base-parser causing some routes to fail #276
  • Added API keys #275
  • chore(marin): remove logging 🙏 #274

Commits

v1.4.14 - 2023-02-26

Merged

  • v1.4.14 #273
  • proxy config to 9anime #272

v1.4.13 - 2023-02-25

Merged

  • v1.4.13 #271
  • Added intros and fixed some bugs (9anime) #270
  • chore(build) yarn build #268
  • Fixed 9anime #267

Commits

v1.4.12 - 2023-02-23

Merged

Commits

  • refactor 9anime ed817a3
  • feat (base parser): rotate proxies if given an array ca0dfdf

v1.4.10 - 2023-02-16

Merged

v1.4.9 - 2023-02-14

Merged

  • added ops and eds to mal #258
  • chore(dist): update build #256
  • chore(prettier): fix prettier config #255
  • fix(marin): fix in case anime doesn't has synonyms #254
  • Apply fixes from CodeFactor #251
  • feat(anilist) add colour to functions #253

v1.4.8 - 2023-02-11

Merged

v1.4.7 - 2023-02-11

Merged

  • A NEW NEW NEW NEW VERSION #249
  • Update package.json #248

v1.4.6 - 2023-02-11

Merged

v1.4.5 - 2023-02-11

Merged

v1.4.3 - 2023-02-11

Merged

v1.4.2 - 2023-02-10

Merged

  • feat (zoro): added totalPages count #240
  • Fixes #241
  • fix(zoro): hasNextPage returning true, when it's false #237
  • Update streamsb #236

Commits

  • chore: bump version 1.4.1 -> 1.4.2 038456c

v1.4.1 - 2023-02-05

Merged

  • v1.4.1 #234
  • feat(anilist) add currentEpisodeCount #233
  • Zoro fix #232

Commits

v1.4.0 - 2023-02-03

Merged

v1.3.8 - 2023-02-03

Merged

  • Mal popularity #227
  • added popularity to mal #226

v1.3.7 - 2023-02-02

Merged

  • v1.3.7 #225
  • fixed base parser/cors config and fixed animepahe test #224

v1.3.6 - 2023-01-30

Merged

  • v1.3.6 #218
  • fix wrong cors proxy in mangasee123 #214
  • fix kwik extractor wrong cors url #212
  • fix mal is undefined #211

Commits

  • feat (gogoanime): add a method to get anime id from episode id(#216) 2eb4908

v1.3.5 - 2023-01-28

Merged

  • chore (gogoanime): Stop sending errors to the console #210
  • Add proxy change method #205
  • feat: add MAL ID to zoro anime info #193
  • 👺 bye, kamyroll! optimised tests slightly. #207

Commits

v1.3.4 - 2023-01-23

Merged

  • Bump to v1.3.4 #204
  • Write tests for animepahe #203
  • fix streamsb and kamyroll logo #202
  • fix gogohd.pro being defunct #199
  • Update nodejs-ci.yml #201
  • Update nodejs-ci.yml #200
  • subtitles now returns when using enime, if available #198

v1.3.3 - 2023-01-23

Merged

  • Bump to 1.3.3 #197
  • Add workflow to remove npm version #196
  • Fixed minor issues with some providers #195
  • ignore axios in dependabot #192
  • add workflow dispatch for releases #190

v1.3.1 - 2023-01-17

Merged

  • Undo version to 1.3.1 #189
  • Update npm-publish.yml #186
  • version bump #185
  • 👋 Tenshi, さよなら! #184
  • Kamyroll and Crunchyroll as Providers #182
  • fix(Tenshi): sources returning empty array #180
  • fix kamyroll #179
  • fix typo #178
  • feat(Tenshi) add Tenshi as a provider #177
  • fix gogocdn undefined issue #175
  • fix(MAL, mangasee123): mangasee123 duplicate items & MAL findAnimeSlug #174
  • fixe non-correct logos for website #173
  • add isReleased to tvShows seasons #170
  • Use non-cached pages to get the keys #169
  • Change default Gogo Server to VidStreaming #167
  • Add more info to TMDB #166
  • Fix anilist episodes mappings #164
  • Updated rapidclown key URL #163
  • feat(tmdb) add episode Id to movie info #162
  • fix(TMDB): fix page and add other pagination values #161

v1.3.0 - 2022-12-26

Merged

  • feat(dramacool) add dramacool provider #158
  • Add TMDB Provider #154
  • feat(flixhq): add recommendations and cover image to the info method #155
  • 👋 AniMixPlay, さよなら! #153
  • Refactor BaseParser #148
  • feat(flixhq): add trending and fix recent #147
  • positive look-behind issue [iOS/Expo] #145
  • fix(mixdrop): positive look-behind issue [iOS/Expo] #144
  • feat(MangaReader): Add MangaReader provider #143
  • feat(MangaPill): Add MangaPill provider #142
  • refactor(mangadex): reverse chapter order #141
  • chore(yarn): yarn build & version change #140

Commits

  • chore: bump version 1.2.13-rc -> 1.3.0 c3497c8

v1.2.12 - 2022-12-14

v1.2.12-rc - 2022-12-14

Merged

  • chore(yarn): yarn build & version change #140
  • bump package version #138
  • Added Common Methods to docs #135
  • apply codefactor fixes #133
  • fixed mal stuff #132
  • fix(MAL): Aad null safety #131
  • feat(gogoanime): Add download url to episode sources #129
  • Apply fixes from CodeFactor #128
  • feat(gogoanime): Add Genres #127

Commits

v1.2.11 - 2022-12-03

Merged

  • removed useless hasDub #125

Commits

v1.2.10 - 2022-12-01

Merged

  • Fix StreamSB headers #123
  • StreamSB Fix #122

Commits

  • feat(anilist): Add air date for episodes bf44977
  • update build f5a950a
  • feat(anilist): add external provider mappings dbe5c98

v1.2.9 - 2022-11-27

Merged

  • Update package-lock.json #120
  • MAL and Tenshi #119
  • Update index.ts #118
  • fix(mal): fixed search math #116
  • MAL #115
  • Update README.md #112
  • feat(viewAsian): add viewAsian provider #110

Commits

v1.2.8 - 2022-11-13

Merged

  • Improvements #109
  • fixed mangadex page numbers #108
  • R.I.P. Z-Library 💀 #105

Commits

v1.2.7 - 2022-11-09

Merged

  • Dub mapping Improvements #104
  • feat(animepahe): fixed by adding cors proxy #102

Commits

v1.2.6 - 2022-11-05

Merged

  • feat: bug fixes #99
  • chore(deps): bump actions/setup-node from 3.5.0 to 3.5.1 #88
  • feat(anilist): added VA language to characters* #97
  • feature (anilist): added voice actor language to characters #95

Commits

  • added language to anilist info d3cec3b
  • feat(mangapark): added mangapark provider, tests & docs (#100 🎉) 29b8e02
  • fix bilibili on anilist route df4b006

v1.2.5 - 2022-11-01

Commits

v1.2.4 - 2022-11-01

Merged

  • feat(mangadex): add cover image #94

Commits

v1.2.3 - 2022-10-26

Commits

  • fix crunchyroll on anilist 5047e6f

v1.2.2 - 2022-10-24

Merged

  • Add support for zoro dubs #93

Commits

v1.2.1 - 2022-10-21

Commits

v1.2.0 - 2022-10-21

Merged

  • fix mangadex typo #92

Commits

v1.1.9 - 2022-10-18

Merged

  • Fixes examples in docs #89

Commits

  • Fix undefined ids on anilist recent releases(#91) e78731e

v1.1.8 - 2022-10-15

Commits

  • fix gogo source crashing on mp4 a2ccabe

v1.1.7 - 2022-10-13

Commits

v1.1.6 - 2022-10-13

Merged

  • Add proxy & feat gogo sources resolutions on enime #87
  • fix: dub episodes returning a sub id despite not having dub episodes #84

Commits

v1.1.5 - 2022-10-05

Commits

v1.1.4 - 2022-10-04

Commits

  • refactor consumet-app.herokuapp.com -> api.consumet.org a0006b4
  • chore: bump version 1.1.3 -> 1.1.4 59e4df0

v1.1.3 - 2022-10-01

Merged

  • chore: bump version from 1.1.2 -> 1.1.3 #80
  • feat GogoCDN: parse m3u8 file to extract resolutions #79

v1.1.2 - 2022-10-01

Merged

  • chore(deps): bump actions/setup-node from 3.4.1 to 3.5.0 #77

Commits

v1.1.1 - 2022-09-26

Merged

  • chore(deps): bump ws from 8.8.1 to 8.9.0 #76
  • add missing fields to info and data & change character voice actor sorting #74
  • not sure what i build, but i did it #73
  • Fix zoro #72

Commits

  • feat(anilist): add manga mapping 337028b
  • feat(anilist): add season to advanced search & fix airing schedule 7ff0077
  • fix: vidcloud & vizcloud + 9anime 858c1ad

v1.1.0 - 2022-08-27

Merged

  • Add Anime News Network provider #70
  • Added total Episodes to anilist #69
  • Added color field to fetchAnimeInfo #67

Commits

  • feat(anilist): added filtering by status & year 6aacad1
  • feat(anilist): added seperate methods from anime info and episodes c7fc35f
  • feat(anilist): added enime 2020 anime & characterInfo method d2ba9d5

v1.0.10 - 2022-08-18

Merged

  • (feat) new provider: Mangasee123 #62
  • feat(anilist): CountryOrigin filtering on airing schedule #60
  • chore: build dist #59
  • feat(anilist): Added country to airingschedule #58
  • Genres Functionality #53
  • Added AnimeFox #52
  • feat (anilist): added airing schedule & nextAiringEpisode property to Anime Info #49
  • Added AniMixPlay #42
  • fix (anilist): fix episodes number bug #46
  • feat (zoro): added fetch recently updated anime #45
  • fix Mangadex docs' typo #43
  • feat (anilist): added fetch popular anime #41
  • feat (anilist): added recommendations #40

Commits

  • fix(anilist): airing schedule(#61) 629da2e
  • fix(9anime): fixed keys & added prettier 10e8edd
  • feat(anime): added enime 435bd42

v1.0.9 - 2022-08-04

Commits

v1.0.8 - 2022-07-31

Merged

  • feat (anime): 9anime experimental #35
  • build(deps): bump actions/setup-node from 2.2.0 -> 3.4.1 #34

Commits

  • fix workflow 0a1d3b4
  • chore: bump patch version 1.0.6 -> 1.0.7 85f77aa
  • feat (anilist): added cover property 09cc457

v1.0.7 - 2022-07-25

Merged

  • chore (dist): zoro.to #32
  • feat (anime): added zoro.to #31
  • build (dist)* #30
  • feat: MangaKakalot #25
  • fix (mangahere): file clean up #29
  • fix: handle copyright issue #28

Commits

v1.0.6 - 2022-07-20

Merged

  • FEAT: changed comic result #27
  • FIX: increased speed of libgen scrapper #24
  • feat: MangaHere #23

Commits

  • feat (anilist): added studios to object response d821cfa
  • build: new dist 626506a
  • feat [skip ci]: added CODEOWNDERS 683864a

v1.0.5 - 2022-07-17

Merged

  • chore: bump patch version 1.0.4 -> 1.0.5 #22
  • FIX: fixed getComcis page #21

Commits

  • chore: bump dist build 73d2f27
  • refactor [skip ci]: consumet extensions -> consumet.ts e53078e
  • refactor (issue_template): new dropbox 0e5f282

v1.0.4 - 2022-07-13

Merged

  • feat: new meta provider #14

Commits

  • temp commit c18f14f
  • chore: bump patch version 1.0.3 -> 1.0.4 0dcb825

v1.0.3 - 2022-07-10

Commits

  • chore: bump patch version 1.0.2 -> 1.0.3 e3ca4b3
  • feat(anime): added animepahe provider 19fd07d
  • feat(anime): added animepahe provider 8bcdbd1

v1.0.2 - 2022-07-06

Commits

  • FIX: added a package-lock.json 6e1e2e2
  • build(deps-dev): bump ts-jest from 28.0.4 to 28.0.5 d9dc1b1
  • build(deps-dev): bump typescript from 4.6.4 to 4.7.4 790158c

v1.0.1 - 2022-06-22

Commits

  • started zlibrary provider c33c055
  • [skip ci] fixed providers-list 8cee088
  • feat: documentation cleanup 94e1ef9