Skip to content

Commit

Permalink
Fixes examples in docs (consumet#89)
Browse files Browse the repository at this point in the history
* fix 9anime example's

* Fix example code in anilist docs

* Fix example code in animefox docs

* Fix example code in animepahe docs

* Fix example code in animixplay docs

* Fix example code in enime docs

* Fix example code in flixhq docs

* Fix example code in gogoanime docs

* Fix example code in mangadex docs

* Fix example code in mangahere docs

* Fix example code in mangakakalot docs

* Fix example code in mangasee123 docs

* Fix example code in readlightnovels docs

* Fix example code in zoro docs
  • Loading branch information
illusionTBA authored Oct 17, 2022
1 parent a2ccabe commit cad58af
Show file tree
Hide file tree
Showing 14 changed files with 66 additions and 66 deletions.
10 changes: 5 additions & 5 deletions docs/providers/9anime.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ const nineanime = await ANIME.NineAnime.create();
```ts
nineanime.search("ojisan").then(data => {
console.log(data);
}
})
```

returns a promise which resolves into an array of anime. (*[`Promise<ISearch<IAnimeResult[]>>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L13-L26)*)\
Expand Down Expand Up @@ -69,7 +69,7 @@ output:
```ts
nineanime.fetchAnimeInfo("uncle-from-another-world.oj9q8").then(data => {
console.log(data);
}
})
```

returns a promise which resolves into an anime info object (including the episodes). (*[`Promise<IAnimeInfo>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L28-L42)*)\
Expand Down Expand Up @@ -127,7 +127,7 @@ In this example, we're getting the sources for the first episode of Overlord IV.
```ts
nineanime.fetchEpisodeSources("155250").then(data => {
console.log(data);
}
})
```

returns a promise which resolves into an array of episode sources. (*[`Promise<ISource>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L210-L214)*)\
Expand All @@ -147,7 +147,7 @@ lol jk. it doesnt work yet :).
```ts
nineanime.fetchEpisodeServers("155250").then(data => {
console.log(data);
}
})
```
returns a promise which resolves into an array of episode servers. (*[`Promise<IEpisodeServer[]>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L54-L57)*)\
output:
Expand Down Expand Up @@ -176,4 +176,4 @@ output:
]
```

<p align="end">(<a href="https://github.com/consumet/extensions/blob/master/docs/guides/anime.md#">back to anime providers list</a>)</p>
<p align="end">(<a href="https://github.com/consumet/extensions/blob/master/docs/guides/anime.md#">back to anime providers list</a>)</p>
14 changes: 7 additions & 7 deletions docs/providers/anilist.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ const anilist = new META.Anilist();
```ts
anilist.search("Classroom of the elite").then(data => {
console.log(data);
}
})
```

returns a promise which resolves into an array of anime. (*[`Promise<ISearch<IAnimeResult[]>>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L13-L26)*)\
Expand Down Expand Up @@ -82,7 +82,7 @@ output:
```ts
anilist.fetchTrendingAnime().then(data => {
console.log(data);
}
})
```

returns a promise which resolves into an array of anime. (*[`Promise<ISearch<IAnimeResult[]>>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L13-L26)*)\
Expand Down Expand Up @@ -144,7 +144,7 @@ output:
```ts
anilist.fetchPopularAnime().then(data => {
console.log(data);
}
})
```

returns a promise which resolves into an array of anime. (*[`Promise<ISearch<IAnimeResult[]>>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L13-L26)*)\
Expand Down Expand Up @@ -207,7 +207,7 @@ output:
```ts
anilist.fetchAnimeInfo("98659").then(data => {
console.log(data);
}
})
```

returns a promise which resolves into an anime info object (including the episodes). (*[`Promise<IAnimeInfo>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L28-L42)*)\
Expand Down Expand Up @@ -291,7 +291,7 @@ output:
anilist.fetchAnimeGenres(["Action", "Adventure"])
.then(data => {
console.log(data);
}
})
```
returns a promise which resolves into an array of anime. (*[`Promise<ISearch<IAnimeResult[]>>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L13-L26)*)\
output:
Expand Down Expand Up @@ -337,7 +337,7 @@ output:
```ts
anilist.fetchAiringSchedule(1 , 20, 1660047922, 1661832000, true).then(data => {
console.log(data);
}
})
```

returns a promise which resolves into an array of anime. (*[`Promise<ISearch<IAnimeResult[]>>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L13-L26)*)\
Expand Down Expand Up @@ -406,7 +406,7 @@ In this example, we're getting the sources for the first episode of classroom of
```ts
anilist.fetchEpisodeSources("youkoso-jitsuryoku-shijou-shugi-no-kyoushitsu-e-tv-episode-12").then(data => {
console.log(data);
}
})
```

returns a promise which resolves into an array of episode sources. (*[`Promise<ISource>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L210-L214)*)\
Expand Down
10 changes: 5 additions & 5 deletions docs/providers/animefox.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ const animefox = new ANIME.AnimeFox();
```ts
animefox.fetchRecentEpisodes().then(data => {
console.log(data);
}
})
```


Expand Down Expand Up @@ -70,7 +70,7 @@ animefox.fetchRecentEpisodes().then(data => {
```ts
animefox.search("Overlord IV").then(data => {
console.log(data);
}
})
```

returns a promise which resolves into an array of anime. (*[`Promise<ISearch<IAnimeResult[]>>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L13-L26)*)\
Expand Down Expand Up @@ -114,7 +114,7 @@ output:
```ts
animefox.fetchAnimeInfo("overlord-iv").then(data => {
console.log(data);
}
})
```

returns a promise which resolves into an anime info object (including the episodes). (*[`Promise<IAnimeInfo>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L28-L42)*)\
Expand Down Expand Up @@ -162,7 +162,7 @@ In this example, we're getting the sources for the first episode of Overlord IV.
```ts
animefox.fetchEpisodeSources("overlord-iv").then(data => {
console.log(data);
}
})
```

returns a promise which resolves into an array of episode sources. (*[`Promise<ISource>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L210-L214)*)\
Expand All @@ -184,4 +184,4 @@ output:

Make sure to check the `headers` property of the returned object. It contains the referer header, which might be needed to bypass the 403 error and allow you to stream the video without any issues.

<p align="end">(<a href="https://github.com/consumet/extensions/blob/master/docs/guides/anime.md#">back to anime providers list</a>)</p>
<p align="end">(<a href="https://github.com/consumet/extensions/blob/master/docs/guides/anime.md#">back to anime providers list</a>)</p>
8 changes: 4 additions & 4 deletions docs/providers/animepahe.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ const animepahe = new ANIME.AnimePahe();
```ts
animepahe.search("Overlord IV").then(data => {
console.log(data);
}
})
```

returns a promise which resolves into an array of anime. (*[`Promise<ISearch<IAnimeResult[]>>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L13-L26)*)\
Expand Down Expand Up @@ -66,7 +66,7 @@ output:
```ts
animepahe.fetchAnimeInfo("adb84358-8fec-fe80-1dc5-ad6218421dc1").then(data => {
console.log(data);
}
})
```

returns a promise which resolves into an anime info object (including the episodes). (*[`Promise<IAnimeInfo>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L28-L42)*)\
Expand Down Expand Up @@ -111,7 +111,7 @@ In this example, we're getting the sources for the first episode of Overlord IV.
```ts
animepahe.fetchEpisodeSources("c673b4d6cedf5e4cd1900d30d61ee2130e23a74e58f4401a85f21a4e95c94f73").then(data => {
console.log(data);
}
})
```

returns a promise which resolves into an array of episode sources. (*[`Promise<ISource>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L210-L214)*)\
Expand Down Expand Up @@ -144,4 +144,4 @@ output:

Make sure to check the `headers` property of the returned object. It contains the referer header, which is needed to bypass the 403 error and allow you to stream the video without any issues.

<p align="end">(<a href="https://github.com/consumet/extensions/blob/master/docs/guides/anime.md#">back to anime providers list</a>)</p>
<p align="end">(<a href="https://github.com/consumet/extensions/blob/master/docs/guides/anime.md#">back to anime providers list</a>)</p>
8 changes: 4 additions & 4 deletions docs/providers/animixplay.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ const animixplay = new ANIME.AniMixPlay();
```ts
animixplay.search("Overlord IV").then(data => {
console.log(data);
}
})
```

returns a promise which resolves into an array of anime. (*[`Promise<ISearch<IAnimeResult[]>>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L13-L26)*)\
Expand Down Expand Up @@ -55,7 +55,7 @@ output:
```ts
animixplay.fetchAnimeInfo("/v1/overlord-iv").then(data => {
console.log(data);
}
})
```

returns a promise which resolves into an anime info object (including the episodes). (*[`Promise<IAnimeInfo>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L28-L42)*)\
Expand Down Expand Up @@ -97,7 +97,7 @@ In this example, we're getting the sources for the first episode of Overlord IV.
```ts
animixplay.fetchEpisodeSources("MTg4NzY5").then(data => {
console.log(data);
}
})
```

returns a promise which resolves into an array of episode sources. (*[`Promise<ISource>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L210-L214)*)\
Expand All @@ -117,4 +117,4 @@ output:
}
```

<p align="end">(<a href="https://github.com/consumet/extensions/blob/master/docs/guides/anime.md#">back to anime providers list</a>)</p>
<p align="end">(<a href="https://github.com/consumet/extensions/blob/master/docs/guides/anime.md#">back to anime providers list</a>)</p>
8 changes: 4 additions & 4 deletions docs/providers/enime.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ const enime = new ANIME.Enime();
```ts
enime.search("Overlord IV").then(data => {
console.log(data);
}
})
```

returns a promise which resolves into an array of anime. (*[`Promise<ISearch<IAnimeResult[]>>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L13-L26)*)\
Expand Down Expand Up @@ -76,7 +76,7 @@ output:
```ts
enime.fetchAnimeInfo("cl6k4l2xt000nh4lu54mqankt").then(data => {
console.log(data);
}
})
```

returns a promise which resolves into an anime info object (including the episodes). (*[`Promise<IAnimeInfo>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L28-L42)*)\
Expand Down Expand Up @@ -142,7 +142,7 @@ In this example, we're getting the sources for the first episode of Overlord IV.
```ts
enime.fetchEpisodeSources("cl6m9svrt380392sm8x1u89gzh").then(data => {
console.log(data);
}
})
```

returns a promise which resolves into an array of episode sources. (*[`Promise<ISource>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L210-L214)*)\
Expand All @@ -163,4 +163,4 @@ output:

Make sure to check the `headers` property of the returned object. It contains the referer header, which is needed to bypass the 403 error and allow you to stream the video without any issues.

<p align="end">(<a href="https://github.com/consumet/extensions/blob/master/docs/guides/anime.md#">back to anime providers list</a>)</p>
<p align="end">(<a href="https://github.com/consumet/extensions/blob/master/docs/guides/anime.md#">back to anime providers list</a>)</p>
10 changes: 5 additions & 5 deletions docs/providers/flixhq.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ const flixhq = new MOVIES.FlixHQ();
```ts
flixhq.search("Vincenzo").then(data => {
console.log(data);
}
})
```

returns a promise which resolves into an array of movies/tv series. (*[`Promise<ISearch<IMovieResult[]>>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L233-L241)*)\
Expand Down Expand Up @@ -59,7 +59,7 @@ output:
```ts
flixhq.fetchMediaInfo("tv/watch-vincenzo-67955").then(data => {
console.log(data);
}
})
```

returns a promise which resolves into an anime info object (including the episodes). (*[`Promise<IMovieInfo>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L243-L254)*)\
Expand Down Expand Up @@ -117,7 +117,7 @@ output:
```ts
flixhq.fetchEpisodeSources("1167571", "tv/watch-vincenzo-67955").then(data => {
console.log(data);
}
})
```
returns a promise which resolves into an array of episode sources and subtitles. (*[`Promise<ISource>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L210-L214)*)\
output:
Expand Down Expand Up @@ -157,7 +157,7 @@ output:
```ts
flixhq.fetchEpisodeServers('1167571', 'tv/watch-vincenzo-67955').then(data => {
console.log(data);
}
})
```
returns a promise which resolves into an array of episode servers. (*[`Promise<IEpisodeServer[]>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L54-L57)*)\
output:
Expand All @@ -184,4 +184,4 @@ output:
]
```

<p align="end">(<a href="https://github.com/consumet/extensions/blob/master/docs/guides/movies.md#">back to movie providers list</a>)</p>
<p align="end">(<a href="https://github.com/consumet/extensions/blob/master/docs/guides/movies.md#">back to movie providers list</a>)</p>
14 changes: 7 additions & 7 deletions docs/providers/gogoanime.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ const gogoanime = new ANIME.Gogoanime();
```ts
gogoanime.search("One Piece").then(data => {
console.log(data);
}
})
```

returns a promise which resolves into an array of anime. (*[`Promise<ISearch<IAnimeResult[]>>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L13-L26)*)\
Expand Down Expand Up @@ -71,7 +71,7 @@ output:
```ts
gogoanime.fetchRecentEpisodes().then(data => {
console.log(data);
}
})
```

output:
Expand Down Expand Up @@ -107,7 +107,7 @@ return top airing anime list.
```ts
gogoanime.fetchTopAiring().then(data => {
console.log(data);
}
})
```

output:
Expand Down Expand Up @@ -140,7 +140,7 @@ output:
```ts
gogoanime.fetchAnimeInfo("one-piece").then(data => {
console.log(data);
}
})
```

returns a promise which resolves into an anime info object (including the episodes). (*[`Promise<IAnimeInfo>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L28-L42)*)\
Expand Down Expand Up @@ -193,7 +193,7 @@ output:
```ts
gogoanime.fetchEpisodeSources("one-piece-episode-1022").then(data => {
console.log(data);
}
})
```
returns a promise which resolves into an array of episode sources. (*[`Promise<ISource>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L210-L214)*)\
output:
Expand Down Expand Up @@ -226,7 +226,7 @@ output:
```ts
gogoanime.fetchEpisodeServers("one-piece-episode-1022").then(data => {
console.log(data);
}
})
```
returns a promise which resolves into an array of episode servers. (*[`Promise<IEpisodeServer[]>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L54-L57)*)\
output:
Expand All @@ -246,4 +246,4 @@ output:
]
```

<p align="end">(<a href="https://github.com/consumet/extensions/blob/master/docs/guides/anime.md#">back to anime providers list</a>)</p>
<p align="end">(<a href="https://github.com/consumet/extensions/blob/master/docs/guides/anime.md#">back to anime providers list</a>)</p>
8 changes: 4 additions & 4 deletions docs/providers/mangadex.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ const mangadex = new MANGA.MangaDex();
```ts
mangadex.search("Tomodachi Game").then(data => {
console.log(data);
}
})
```
returns a promise which resolves into an array of manga. (*[`Promise<ISearch<IMangaResult[]>>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L97-L106)*)\
output:
Expand Down Expand Up @@ -65,7 +65,7 @@ output:
```ts
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>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L115-L120)*)\
output:
Expand Down Expand Up @@ -116,7 +116,7 @@ output:
```ts
mangadex.fetchChapterPages("a79255c8-21b5-4a8c-a586-48469fa87020").then(data => {
console.log(data);
}
})
```
returns an array of pages. (*[`Promise<IMangaChapterPage[]>`](https://github.com/consumet/extensions/blob/master/src/models/types.ts#L122-L126)*)\
output:
Expand All @@ -135,4 +135,4 @@ output:
]
```

<p align="end">(<a href="https://github.com/consumet/extensions/blob/master/docs/guides/manga.md#">back to manga providers list</a>)</p>
<p align="end">(<a href="https://github.com/consumet/extensions/blob/master/docs/guides/manga.md#">back to manga providers list</a>)</p>
Loading

0 comments on commit cad58af

Please sign in to comment.