### Getting Started with consumet.ts

Source: https://github.com/consumet/consumet.ts/blob/master/docs/README.md

An introductory tutorial for new users of consumet.ts. This guide covers the initial setup and basic usage of the library.

```markdown
- [Getting Started](./guides/getting-started.md): Introduction tutorial for consumet.ts. This is where beginners should start.
```

--------------------------------

### Install consumet.ts with yarn

Source: https://github.com/consumet/consumet.ts/blob/master/docs/guides/getting-started.md

Installs the consumet.ts library using yarn.

```yarn
yarn add @consumet/extensions
```

--------------------------------

### Install consumet.ts with npm

Source: https://github.com/consumet/consumet.ts/blob/master/docs/guides/getting-started.md

Installs the consumet.ts library using npm.

```sh
npm i @consumet/extensions
```

--------------------------------

### Search Results Example

Source: https://github.com/consumet/consumet.ts/blob/master/docs/providers/dramacool.md

Example output structure for the search method, showing pagination details and a list of media results.

```js
{
  currentPage: 1, // current page number
  totalPages: 1,
  hasNextPage: false, // boolean to indicate if there's a next page
  results: [
    {
      id: 'drama-detail/vincenzo', // media id
      title: 'Vincenzo (2021)',
      url: 'https://dramacool.com.pa/drama-detail/vincenzo',
      image: 'https://asianimg.pro/cover/vincenzo.png'
    }
  ]
}
```

--------------------------------

### Media Information Output Example

Source: https://github.com/consumet/consumet.ts/blob/master/docs/providers/dramacool.md

Example output structure for the fetchMediaInfo method, detailing various aspects of a media item.

```js
{
  id: 'drama-detail/vincenzo',
  title: 'Vincenzo (2021)',
  status: 'Completed',
  genres: ['Comedy', 'Crime','Drama',...],
  otherNames: [ '빈센조', 'Binsenjo' ],
  image: 'https://asianimg.pro/cover/vincenzo.png',
  description: 'At the age of 8, Park Ju Hyeong is adopted and sent off to Italy.  Now an adult, he is known as Vincenzo Casano.',
  releaseDate: '2021',
  contentRating: '',
  airsOn: '',
  director: 'kim hee won [김희원]',
  originalNetwork: 'netflix; tvn',
  trailer: {
    url: 'https://www.youtube.com/embed/vO8rFbTtJNI',
    id: 'vO8rFbTtJNI'
  },
  characters: [
    {
      url: 'https://dramacool.com.pa/star/ok-taecyeon',
      imageUrl: 'https://asianimg.pro/star/ok-taecyeon.png',
      title: 'Ok Taecyeon (1988)'
    },
    {...},
      ...
  ],
  episodes: [
   {
      id: 'vincenzo-2021-episode-1',
      title: 'Episode 1',
      episode: 1,
      subType: 'SUB',
      releaseDate: '2021-02-20 07:17:21',
      url: 'https://dramacool.com.pa/vincenzo-2021-episode-1.html'
    },
    {...},
    ...
  ]
}
```

--------------------------------

### Install consumet.ts

Source: https://github.com/consumet/consumet.ts/blob/master/README.md

Installs the @consumet/extensions package using either Yarn or npm.

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

--------------------------------

### Anime Info Object Example

Source: https://github.com/consumet/consumet.ts/blob/master/docs/providers/animepahe.md

Example output of the `fetchAnimeInfo` method, detailing an anime's ID, title, images, description, genres, status, release information, studios, total episodes, and a list of episodes with their details.

```js
{
  id: 'adb84358-8fec-fe80-1dc5-ad6218421dc1',
  title: 'Overlord IV',
  image: 'https://i.animepahe.com/posters/cb77e1e2a76b985a7c9d9b90a497fee65d89fa9c41d0e9e6fab4608d10313ddf.jpg',
  cover: 'https://i.animepahe.com/covers/cover_default3.jpg',
  description: 'Fourth season of Overlord.',
  genres: [ 'Action', 'Fantasy', 'Supernatural' ],
  status: 'Ongoing',
  type: 'TV',
  releaseDate: 'Jul 05, 2022',
  aired: 'Jul 05, 2022 to ?',
  studios: [ 'Madhouse' ],
  totalEpisodes: NaN, // NaN means that the anime is ongoing.
  episodes: [
    {
      id: 'c673b4d6cedf5e4cd1900d30d61ee2130e23a74e58f4401a85f21a4e95c94f73',
      number: 1,
      title: '',
      image: 'https://i.animepahe.com/snapshots/8b3499c66e59e4c266485b54b78ad8469a520d9957dbe5a117f8d0934a93817a.jpg',
      duration: '00:23:40'
    }
  ],
  episodePages: 1 // 1 means that there is only one page of episodes.
}
```

--------------------------------

### Fetch Anime Information Output Example

Source: https://github.com/consumet/consumet.ts/blob/master/docs/providers/animekai.md

Example of the output structure when fetching detailed anime information. It includes comprehensive details about the anime, its recommendations, related anime, genres, status, and a list of episodes with their respective URLs.

```js
{
  id: 'jujutsu-kaisen-4gm6',
  title: 'JUJUTSU KAISEN',
  japaneseTitle: 'Jujutsu Kaisen',
  image: 'https://static.animekai.to/7b/i/f/d2/67664a638ddda.jpg',
  description: 'Idly indulging in baseless paranormal activities with the ....',
  type: 'TV',
  url: 'https://animekai.to/watch/jujutsu-kaisen-4gm6',
  recommendations: [
    {
      id: 'chainsaw-man-2nmr',
      title: 'Chainsaw Man',
      url: 'https://animekai.to/watch/chainsaw-man-2nmr',
      image: 'https://static.animekai.to/e7/i/f/19/676649a842295@300.jpg',
      japaneseTitle: 'Chainsaw Man',
      type: 'TV',
      sub: 12,
      dub: 12,
      episodes: 12
    },
  ],
  relatedAnime: [
    {
      id: 'jujutsu-kaisen-0-xxn3',
      title: 'JUJUTSU KAISEN 0',
      url: 'https://animekai.to/watch/jujutsu-kaisen-0-xxn3',
      image: 'https://static.animekai.to/b7/i/d/0f/67664a6c4ae80@300.jpg',
      japaneseTitle: 'Jujutsu Kaisen 0',
      type: 'MOVIE',
      sub: 1,
      dub: 1,
      episodes: 1
    },
  ],
  subOrDub: 'both',
  hasSub: true,
  hasDub: true,
  genres: [
    'Genres:  School, Shounen, Action, Supernatural, Drama, Magic, Martial Arts, Demons, Super Power'
  ],
  status: 'Completed',
  season: 'Fall 2020',
  totalEpisodes: 24,
  episodes: [
    {
      id: 'jujutsu-kaisen-4gm6#ep=1?token=30nW30ysAuVpjobTutx2',
      number: 1,
      title: 'Ryoumen Sukuna',
      url: 'https://animekai.to/watch/jujutsu-kaisen-4gm6#ep=1'
    },
    {
      id: 'jujutsu-kaisen-4gm6#ep=2?token=lRDAkRGtUbo9jJTQvJxw',
      number: 2,
      title: 'For Myself',
      url: 'https://animekai.to/watch/jujutsu-kaisen-4gm6#ep=2'
    },
    {...}
  ]
}
```

--------------------------------

### Using Light Novel Providers in consumet.ts

Source: https://github.com/consumet/consumet.ts/blob/master/docs/README.md

A guide on how to leverage the light novel providers available in consumet.ts for accessing light novel content.

```markdown
- [Light Novels](./guides/light-novels.md): How to use light novel providers.
```

--------------------------------

### Search Anime Output Example

Source: https://github.com/consumet/consumet.ts/blob/master/docs/providers/animekai.md

Example of the output structure when searching for anime. It includes pagination details and a list of anime results, each with an ID, title, URL, image, and episode information.

```js
{
  currentPage: 0,
  hasNextPage: false,
  totalPages: 0,
  results: [
    {
      id: 'dan-da-dan-vmly',
      title: 'DAN DA DAN',
      url: 'https://animekai.to/watch/dan-da-dan-vmly',
      image: 'https://static.animekai.to/1c/i/1/e3/6766499c2467e@300.jpg',
      japaneseTitle: 'Dandadan',
      type: 'TV',
      sub: 12,
      dub: 12,
      episodes: 12
    },
    {...}
  ]
}
```

--------------------------------

### Anime Info Result Example

Source: https://github.com/consumet/consumet.ts/blob/master/docs/providers/animesaturn.md

Example output of the fetchAnimeInfo method, showing detailed anime information including title, genres, images, description, and a list of episodes with their numbers and IDs.

```js
{
    id: 'Tokyo-Revengers-aaaaaa',
    title: 'Tokyo Revengers Sub ITA',
    genres: [ 'Azione', 'Drammatico', 'Scolastico', 'Shounen', 'Soprannaturale' ],
    image: 'https://cdn.animesaturn.tv/static/images/locandine/Zkczy.png',
    cover: 'https://s4.anilist.co/file/anilistcdn/media/anime/banner/120120-oRfDsJjrpoQ4.jpg',
    description: '',
    episodes: [
        { number: 1, id: 'Tokyo-Revengers-ep-1' },
        { number: 2, id: 'Tokyo-Revengers-ep-2' },
        { number: 3, id: 'Tokyo-Revengers-ep-3' },
        { number: 4, id: 'Tokyo-Revengers-ep-4' },
        { number: 5, id: 'Tokyo-Revengers-ep-5' },
        { number: 6, id: 'Tokyo-Revengers-ep-6' },
        { number: 7, id: 'Tokyo-Revengers-ep-7' },
        { number: 8, id: 'Tokyo-Revengers-ep-8' },
        { number: 9, id: 'Tokyo-Revengers-ep-9' },
        { number: 10, id: 'Tokyo-Revengers-ep-10' },
        { number: 11, id: 'Tokyo-Revengers-ep-11' },
        { number: 12, id: 'Tokyo-Revengers-ep-12' },
        { number: 13, id: 'Tokyo-Revengers-ep-13' },
        { number: 14, id: 'Tokyo-Revengers-ep-14' },
        { number: 15, id: 'Tokyo-Revengers-ep-15' },
        { number: 16, id: 'Tokyo-Revengers-ep-16' },
        { number: 17, id: 'Tokyo-Revengers-ep-17' },
        { number: 18, id: 'Tokyo-Revengers-ep-18' },
        { number: 19, id: 'Tokyo-Revengers-ep-19' },
        { number: 20, id: 'Tokyo-Revengers-ep-20' },
        { number: 21, id: 'Tokyo-Revengers-ep-21' },
        { number: 22, id: 'Tokyo-Revengers-ep-22' },
        { number: 23, id: 'Tokyo-Revengers-ep-23' },
        { number: 24, id: 'Tokyo-Revengers-aszb-ep-24' }
    ]
}
```

--------------------------------

### Anime Search Result Example

Source: https://github.com/consumet/consumet.ts/blob/master/docs/providers/animepahe.md

Example output of the `search` method, showing an array of anime results with their IDs, titles, images, ratings, release dates, and types.

```js
{
  results: [
    {
      id: 'adb84358-8fec-fe80-1dc5-ad6218421dc1',
      title: 'Overlord IV',
      image: 'https://i.animepahe.com/posters/cb77e1e2a76b985a7c9d9b90a497fee65d89fa9c41d0e9e6fab4608d10313ddf.jpg',
      rating: 8.3,
      releaseDate: 2022,
      type: 'TV'
    },
    {
      id: 'a0d776d3-48d2-5487-971d-f5d8dada5c42',
      title: 'Overlord',
      image: 'https://i.animepahe.com/posters/e78bf21dfd4e382dbc985501edb0f57bda7d5305b87863fe8991a5e658c9c1a8.jpg',
      rating: 7.92,
      releaseDate: 2015,
      type: 'TV'
    },
    {...}
    ...
  ]
}
```

--------------------------------

### Using Manga Providers in consumet.ts

Source: https://github.com/consumet/consumet.ts/blob/master/docs/README.md

This guide explains how to interact with manga providers using consumet.ts. Learn how to find and read manga through the library.

```markdown
- [Manga](./guides/manga.md): How to use manga providers.
```

--------------------------------

### FlixHQ Media Info Example

Source: https://github.com/consumet/consumet.ts/blob/master/docs/providers/flixhq.md

Example of the data structure returned by the `fetchMediaInfo` method, detailing a TV series with its ID, title, image, description, release date, genres, cast, production company, duration, rating, and a list of episodes.

```js
{
  id: 'tv/watch-vincenzo-67955', // media id
  title: 'Vincenzo',
  url: 'https://flixhq.to/tv/watch-vincenzo-67955', // media url
  image: 'https://img.flixhq.to/xxrz/250x400/379/79/6b/796b32989cf1308b9e0619524af5b022/796b32989cf1308b9e0619524af5b022.jpg',
  description: '\n' +
    '        At age of 8, Park Joo-Hyung went to Italy after he was adopted. He is now an adult and has the name of Vincenzo Cassano. ...\n' +
    '    ',
  type: 'TV Series',
  releaseDate: '2021-02-20',
  genres: [ 'Action', 'Adventure', '...' ],
  casts: [
    'Kwak Dong-yeon',
    'Kim Yeo-jin',
      ...
  ],
  tags: [
    'Watch Vincenzo Online Free,',
    'Vincenzo Online Free,',
    ...
  ],
  production: 'Studio Dragon',
  duration: '60 min',
  rating: 8.4,
  episodes: [
    {
      id: '1167571',
      title: 'Eps 1: Episode #1.1',
      number: 1,
      season: 1, // the number of episodes resets to 1 every season
      url: 'https://flixhq.to/ajax/v2/episode/servers/1167571'
    },
    {...},
    ...
  ]
}
```

--------------------------------

### FlixHQ Search Results Example

Source: https://github.com/consumet/consumet.ts/blob/master/docs/providers/flixhq.md

Example of the data structure returned by the `search` method, including pagination information and a list of media results with their IDs, titles, URLs, images, and types.

```js
{
  currentPage: 1, // current page
  hasNextPage: false, // if there is a next page
  results: [
    {
      id: 'tv/watch-vincenzo-67955', // media id
      title: 'Vincenzo',
      url: 'https://flixhq.to/tv/watch-vincenzo-67955', // media url
      image: 'https://img.flixhq.to/xxrz/250x400/379/79/6b/796b32989cf1308b9e0619524af5b022/796b32989cf1308b9e0619524af5b022.jpg',
      type: 'TV Series'
    }
    {...},
    ...
  ]
}
```

--------------------------------

### Initialize 9Anime Provider

Source: https://github.com/consumet/consumet.ts/blob/master/docs/providers/9anime.md

Demonstrates how to create an instance of the 9Anime provider. This is the first step before using any of its methods.

```ts
const nineanime = await ANIME.NineAnime.create();
```

--------------------------------

### Contributing to consumet.ts

Source: https://github.com/consumet/consumet.ts/blob/master/docs/README.md

Details and guidelines for developers who wish to contribute to the consumet.ts project. This includes information on setting up the development environment and contribution process.

```markdown
- [Contributing](./guides/contributing.md): Details about how to contribute to consumet.ts.
```

--------------------------------

### Manga Search Results Example

Source: https://github.com/consumet/consumet.ts/blob/master/docs/providers/mangareader.md

Example output structure for manga search results, containing manga ID, title, image URL, and genres.

```js
{
    results: [
        {
          id: 'one-piece-colored-edition-55493',
          title: 'One Piece (Colored Edition)',
          image: 'https://img.mreadercdn.com/_m/300x400/100/58/59/5859e56db55fb29a12696a926419e815/5859e56db55fb29a12696a926419e815.jpg',
          genres: [ 'Action', 'Adventure', 'Comedy' ]
        },
        {
          id: 'one-piece-3',
          title: 'One Piece',
          image: 'https://img.mreadercdn.com/_m/300x400/100/62/16/6216bad614899d8dc66cf8b2cb8047d9/6216bad614899d8dc66cf8b2cb8047d9.jpg',
          genres: [ 'Action', 'Adventure', 'Comedy' ]
        }
        {...},
    ]
}
```

--------------------------------

### Anime Search Result Example

Source: https://github.com/consumet/consumet.ts/blob/master/docs/providers/animesaturn.md

Example output of the search method, showing a list of anime results with their IDs, titles, images, and URLs.

```js
{
    hasNextPage: false,
    results: [
        {
            id: 'Tokyo-Revengers-aaaaaa',
            title: 'Tokyo Revengers',
            image: 'https://cdn.animesaturn.tv/static/images/copertine/4af2d1048aeb86aeb9b585f3619275601626143497_full.jpg',
            url: 'https://www.animesaturn.tv/anime/Tokyo-Revengers-aaaaaa'
        },
        {
            id: 'Tokyo-Revengers-ITA-aa',
            title: 'Tokyo Revengers (ITA)',
            image: 'https://cdn.animesaturn.tv/static/images/copertine/4af2d1048aeb86aeb9b585f3619275601626143497_full.jpg',
            url: 'https://www.animesaturn.tv/anime/Tokyo-Revengers-ITA-aa'
        },
        {
            id: 'Tokyo-Revengers-Seiya-Kessen-hen-aa',
            title: 'Tokyo Revengers: Seiya Kessen-hen',
            image: 'https://cdn.animesaturn.tv/static/images/copertine/26084_1_1.png',
            url: 'https://www.animesaturn.tv/anime/Tokyo-Revengers-Seiya-Kessen-hen-aa'
        }
    ]
}
```

--------------------------------

### Search for Books using Libgen Provider

Source: https://github.com/consumet/consumet.ts/blob/master/docs/guides/getting-started.md

Demonstrates how to search for books using the Libgen provider in consumet.ts. It includes creating a provider instance, searching for a book by title, and scraping detailed information from a book's page.

```typescript
// ESM
import { BOOKS } from "@consumet/extensions"
// CommonJS
const { BOOKS } = require("@consumet/extensions");

const main = async () => {
  // Create a new instance of the Libgen provider
  const books = new BOOKS.Libgen();
  // Search for a book. In this case, "Pride and Prejudice"
  const results = await books.search('pride and prejudice');
  // Print the results
  console.log(results);
  // Get the first book info
  const firstBook = results[0];
  const bookInfo = await books.scrapePage(firstBook.link);
  // Print the info
  console.log(bookInfo);
};

main();
```

--------------------------------

### Initialize Book Provider

Source: https://github.com/consumet/consumet.ts/blob/master/docs/guides/books.md

Demonstrates how to import and initialize a book provider from the '@consumet/extensions' library. Replace `<providerName>` with the desired provider, such as 'Libgen'.

```ts
// ESM
import { BOOKS } from '@consumet/extensions';

// <providerName> is the name of the provider you want to use. list of the proivders is below.
const bookProvider = BOOKS.<providerName>();
```

--------------------------------

### Manga Information Output Example

Source: https://github.com/consumet/consumet.ts/blob/master/docs/providers/mangareader.md

Example output structure for manga information, including ID, title, image, description, genres, and a list of chapters with their respective IDs, titles, and chapter numbers.

```js
{
      id: 'one-piece-colored-edition-55493',
      title: 'One Piece (Colored Edition)',
      image: 'https://img.mreadercdn.com/_m/300x400/100/58/59/5859e56db55fb29a12696a926419e815/5859e56db55fb29a12696a926419e815.jpg',
      description: 'Gol D. Roger, a man referred to as the \"Pirate King,\" is set to be executed by the World Government. But just before his demise, he confirms the existence of a great treasure, One Piece, located somewhere within the vast ocean known as the Grand Line. Announcing that One Piece can be claimed by anyone worthy enough to reach it, the Pirate King is executed and the Great Age of Pirates begins.  Twenty-two years later, a young man by the name of Monkey D. Luffy is ready to embark on his own adventure, searching for One Piece and striving to become the new Pirate King. Armed with just a straw hat, a small boat, and an elastic body, he sets out on a fantastic journey to gather his own crew and a worthy ship that will take them across the Grand Line to claim the greatest status on the high seas.  [Written by MAL Rewrite]',
      genres: [
        'Action',
        'Adventure',
        'Comedy',
        'Fantasy',
        'Shounen',
        'Super Power'
      ],
      chapters: [
        {
          id: 'one-piece-colored-edition-55493/en/chapter-1004',
          title: 'Chapter 1004: MILLET DUMPLINGS',
          chapter: '1004'
        },
        {
          id: 'one-piece-colored-edition-55493/en/chapter-1003',
          title: 'Chapter 1003: THE NIGHT BEFORE THE FESTIVAL',
          chapter: '1003'
        },
        {...},
      ]
}
```

--------------------------------

### Using Book Providers in consumet.ts

Source: https://github.com/consumet/consumet.ts/blob/master/docs/README.md

Instructions on how to use the book providers integrated with consumet.ts. This covers searching for and accessing book-related information.

```markdown
- [Books](./guides/books.md): How to use book providers.
```

--------------------------------

### Search for Anime using Gogoanime Provider

Source: https://github.com/consumet/consumet.ts/blob/master/docs/guides/getting-started.md

Demonstrates how to search for anime using the Gogoanime provider in consumet.ts. It covers creating a provider instance, searching for anime, fetching detailed anime information, and retrieving episode stream links.

```typescript
// ESM
import { ANIME } from "@consumet/extensions"
// CommonJS
const { ANIME } = require("@consumet/extensions");

const main = async () => {
  // Create a new instance of the Gogoanime provider
  const gogoanime = new ANIME.Gogoanime();
  // Search for a anime. In this case, "One Piece"
  const results = await gogoanime.search("One Piece");
  // Print the results
  console.log(results);
  // Get the first anime info
  const firstAnime = results.results[0];
  const animeInfo = await gogoanime.fetchAnimeInfo(firstAnime.id);
  // Print the info
  console.log(animeInfo);
  // get the first episode stream link. By default, it chooses goload server.
  const episodes = await gogoanime.fetchEpisodeSources(animeInfo.episodes[0].id);
  // get the available streaming servers for the first episode
  const streamingServers = await gogoanime.fetchEpisodeServers(animeInfo.episodes[0].id);
}
```

--------------------------------

### Initialize MangaPill Provider

Source: https://github.com/consumet/consumet.ts/blob/master/docs/providers/mangapill.md

Initializes a new instance of the MangaPill provider. This is the first step to interact with the MangaPill service.

```ts
const mangaPill = new MANGA.MangaPill();
```

--------------------------------

### Initialize META Provider

Source: https://github.com/consumet/consumet.ts/blob/master/docs/guides/meta.md

Demonstrates how to import and initialize a META provider using its name. This is the entry point for interacting with specific custom providers.

```ts
// ESM
import { META } from '@consumet/extensions';

// <providerName> is the name of the provider you want to use. list of the proivders is below.
const metaProvider = META.<providerName>();
```

--------------------------------

### Initialize ReadManga

Source: https://github.com/consumet/consumet.ts/blob/master/docs/providers/readmanga.md

Initializes the ReadManga class from the MANGA namespace. This is the starting point for all manga-related operations.

```ts
import * as MANGA from '@consumet/extensions/dist/manga';

const readManga = new MANGA.ReadManga();
```

--------------------------------

### Initialize Light Novel Provider

Source: https://github.com/consumet/consumet.ts/blob/master/docs/guides/light-novels.md

Demonstrates how to import and initialize a light novel provider from the @consumet/extensions library using the LIGHT_NOVELS category. Replace <providerName> with the desired provider.

```ts
// ESM
import { LIGHT_NOVELS } from '@consumet/extensions';

// <providerName> is the name of the provider you want to use. list of the proivders is below.
const lightnovelProvider = LIGHT_NOVELS.<providerName>();
```

--------------------------------

### TMDB API Documentation

Source: https://github.com/consumet/consumet.ts/blob/master/docs/providers/tmdb.md

Provides documentation for the TMDB provider's methods, including parameters, return types, and usage examples.

```APIDOC
TMDB Provider Methods:

- fetchTrending(type: string, timePeriod?: string, page?: number): Promise<ISearch<(IMovieResult | IAnimeResult | IPeopleResult)[]>>
  - Fetches trending movies, TV series, or people.
  - Parameters:
    - type: Type of trending option ('movie', 'tv series', 'people', or 'all').
    - timePeriod (optional): Duration for trending ('day' or 'week').
    - page (optional): Page number for results.
  - Returns: A promise resolving to an array of trending media results.
  - Example:
    ```ts
    tmdb.fetchTrending("the flash").then(data => {
      console.log(data);
    })
    ```
  - Output Example:
    ```js
    {
      currentPage: 1,
      results: [
            {
              id: 848326,
              title: 'Rebel Moon - Part One: A Child of Fire',
              image: 'https://image.tmdb.org/t/p/original/ui4DrH1cKk2vkHshcUcGt2lKxCm.jpg',
              type: 'Movie',
              rating: 6.457,
              releaseDate: '2023'
            },
            // ... more results
      ]
    }
    ```

- search(query: string, page?: number): Promise<ISearch<IMovieResult[]>>
  - Searches for media based on a query.
  - Parameters:
    - query: The search term (e.g., 'Classroom of the elite').
    - page (optional): Page number for search results.
  - Returns: A promise resolving to an array of search results.
  - Example:
    ```ts
    tmdb.search("the flash").then(data => {
      console.log(data);
    })
    ```
  - Output Example:
    ```js
    {
      currentPage: 1,
      results: [
        {
          "id": 60735,
          "title": "The Flash",
          "image": "https://image.tmdb.org/t/p/original/lJA2RCMfsWoskqlQhXPSLFQGXEJ.jpg",
          "type": "TV Series",
          "rating": 7.807,
          "releaseDate": "2014"
        },
        // ... more results
      ]
    }
    ```

- fetchMediaInfo(mediaId: number, type: string): Promise<any>
  - Fetches detailed information about a specific media item.
  - Parameters:
    - mediaId: The ID of the movie or TV series.
    - type: The type of media ('movie' or 'tv').

- fetchEpisodeSources(episodeId: string, mediaType: string): Promise<any>
  - Fetches the sources for a specific episode.
  - Parameters:
    - episodeId: The ID of the episode.
    - mediaType: The type of media ('movie' or 'tv').
```

--------------------------------

### SFlix Initialization

Source: https://github.com/consumet/consumet.ts/blob/master/docs/providers/sflix.md

Initializes the SFlix client for accessing movie and TV show data. This is the starting point for all interactions with the SFlix API.

```ts
const sflix = new MOVIES.SFlix();
```

--------------------------------

### Setting up a New Provider

Source: https://github.com/consumet/consumet.ts/blob/master/CONTRIBUTING.md

Instructions for creating and integrating a new provider into the Consumet project. This involves creating a new file, importing an abstract class, writing the provider code, and registering it.

```typescript
src/providers/<category>/<provider-name>.ts
src/models/<category>-parser.ts
src/providers/<category>/index.ts
```

--------------------------------

### Initialize FlixHQ Parser

Source: https://github.com/consumet/consumet.ts/blob/master/docs/providers/flixhq.md

Initializes the FlixHQ parser for accessing movie and TV show data. This is the starting point for all FlixHQ related operations.

```ts
const flixhq = new MOVIES.FlixHQ();
```

--------------------------------

### Initialize Anilist Provider

Source: https://github.com/consumet/consumet.ts/blob/master/docs/providers/anilist.md

Demonstrates how to create an instance of the Anilist provider. The constructor can optionally accept an AnimeParser object for custom episode parsing.

```ts
const anilist = new META.Anilist();
```

--------------------------------

### Provider Abstract Classes

Source: https://github.com/consumet/consumet.ts/blob/master/CONTRIBUTING.md

Lists the abstract parser classes available in the `src/models/` directory, which are extended by specific providers to implement their functionality. Examples include `AnimeParser`, `BookParser`, and `MangaParser`.

```typescript
src/models/anime-parser.ts # AnimeParser
src/models/book-parser.ts  # BookParser
src/models/lightnovel-parser.ts  # LightNovelParser
src/models/comic-parser.ts # ComicParser
src/models/manga-parser.ts # MangaParser
src/models/movie-parser.ts # MovieParser
```

--------------------------------

### Anilist Provider Properties

Source: https://github.com/consumet/consumet.ts/blob/master/docs/guides/meta.md

Details the common properties available for a provider within the META category, using Anilist as an example. These properties provide metadata about the provider's capabilities and status.

```APIDOC
Anilist Provider Properties:

  languages: string
    - The language of the current provider. Returns language code, example: 'en'.

  isNSFW: boolean
    - Indicates if the provider offers NSFW content. 'true' if it does, 'false' otherwise.

  isWorking: boolean
    - A boolean to identify the state of the current provider. 'true' if the provider is working, 'false' otherwise.

  isDubAvailableSeparately: boolean
    - Indicates if the provider offers dubbed content separately. 'true' if it does.

  name: string
    - The name of the current provider, example: 'Anilist'.

  baseUrl: string
    - The URL to the base URL of the current provider.

  logo: string
    - The URL to the logo image of the current provider.

  classPath: string
    - The file path to the provider's class.
```

--------------------------------

### ReadLightNovels Initialization

Source: https://github.com/consumet/consumet.ts/blob/master/docs/providers/readlightnovels.md

Initializes the ReadLightNovels provider. This is the first step before calling any other methods.

```ts
const readlightnovels = new LIGHT_NOVELS.ReadLightNovels();
```

--------------------------------

### Initialize Gogoanime Parser

Source: https://github.com/consumet/consumet.ts/blob/master/docs/providers/gogoanime.md

Initializes the Gogoanime parser instance. This is the first step to interact with the Gogoanime API.

```typescript
const gogoanime = new ANIME.Gogoanime();
```

--------------------------------

### Commit Message Guidelines

Source: https://github.com/consumet/consumet.ts/blob/master/CONTRIBUTING.md

Guidelines for writing effective commit messages, including recommended prefixes for different types of changes (feat, fix, refactor, test, docs, chore) and examples.

```git
feat: <description>
fix: <description>
refactor: <description>
test: <description>
docs: <description>
chore: <description>

Examples:
feat: Speed up parsing with new technique
fix: Fix 9anime search
refactor: Reformat code at 9anime.ts
```