Skip to content

Latest commit

 

History

History
138 lines (123 loc) · 4.32 KB

mangadex.md

File metadata and controls

138 lines (123 loc) · 4.32 KB

Mangadex 

const mangadex = new MANGA.MangaDex();

Methods

search

Note: This method is a subclass of the BaseParser class. meaning it is available across most categories.

Parameters

Parameter Type Description
query string query to search for. (In this case, We're searching for Tomodachi Gamee)
page (optional) number page number (default: 1)
limit (optional) number limit of results (default: 20) 
mangadex.search("Tomodachi Game").then(data => {
  console.log(data);
})

returns a promise which resolves into an array of manga. (Promise<ISearch<IMangaResult[]>>)
output:

{
  currentPage: 1,
  results: [
    {
      id: 'b35f67b6-bfb9-4cbd-86f0-621f37e6cb41', // manga id
      title: 'Tomodachi Game',
      altTitles: [
         { en: 'Friends Games' },
         { ja: 'トモダチゲーム' },
         {...},
         ...
      ],
      description: "Katagiri Yuichi believes that friends are more important than money, but he also knows the hardships of not having enough funds. He works hard to save up in ...",
      status: 'ongoing',
      releaseDate: 2013,
      contentRating: 'suggestive',
      lastVolume: null,
      lastChapter: null
    },
    {...}
    ...
  ]
}

fetchMangaInfo

Parameters

Parameter Type Description
mangaId string manga id.(manga id can be found in the manga search results) 
managdex.fetchMangaInfo("b35f67b6-bfb9-4cbd-86f0-621f37e6cb41").then(data => {
  console.log(data);
})

returns a promise which resolves into an manga info object (including the chapters). (Promise<IMangaInfo>)
output:

{
  id: 'b35f67b6-bfb9-4cbd-86f0-621f37e6cb41',
  title: 'Tomodachi Game',
  altTitles: [
    { en: 'Friends Games' },
    { ja: 'トモダチゲーム' },
    {...},
    ...
  ],
  description: {
    en: "Katagiri Yuichi believes that friends are more important than money, but he also knows the hardships ...',
    pl: 'Dziękujemy za wpłatę dwudziestu milionów jenów! W ten sposób dołączyliście do jedynej w swoim rodzaju gry przyjaciół! Witajcie...",
    ...
  },
  genres: [ 'Psychological', 'Drama', '...' ],
  themes: [ 'Survival' ],
  status: 'Ongoing',
  releaseDate: 2013,
  chapters: [
    {
      id: 'a79255c8-21b5-4a8c-a586-48469fa87020',
      title: 'Accomplice',
      pages: 35
    },
    {
      id: '7633dee8-cd6d-4b6d-9335-1aec7646833e',
      title: "The Game's Origins",
      pages: 37
    },
    {...}
    ...
  ]
}

fetchChapterPages

Parameters

Parameter Type Description
chapterId string chapter id.(chapter id can be found in the manga info) 
mangadex.fetchChapterPages("a79255c8-21b5-4a8c-a586-48469fa87020").then(data => {
  console.log(data);
})

returns an array of pages. (Promise<IMangaChapterPage[]>)
output:

[
  {
    img: 'https://uploads.mangadex.org/data/67823e99a5e1b53bb44761c5bdcc7f33/1-6d943848bde48cdc712585fa45d97bbbe5a0432c8ecdfa4e673d53ea6fb8fb28.png',
    page: 1
  },
  {
    img: 'https://uploads.mangadex.org/data/67823e99a5e1b53bb44761c5bdcc7f33/2-060d75ddda24ef3d0848b5517572c8dc3ff0a5fe44f90798f7c71a4f7ce23fd9.png',
    page: 2
  },
  {...}
  ...
]

(back to manga providers list)