Skip to content

Commit

Permalink
docs: add getAZList method documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ghoshRitesh12 committed Dec 21, 2024
1 parent d69b052 commit 08ef794
Showing 1 changed file with 60 additions and 0 deletions.
60 changes: 60 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
- [Example Usage](#example-usage)
- [Documentation](#documentation)
- [getHomePage](#gethomepage)
- [getAZList](#getazlist)
- [getAnimeAboutInfo](#getanimeaboutinfo)
- [getAnimeSearchResults](#getanimesearchresults)
- [getAnimeSearchSuggestion](#getanimesearchsuggestion)
Expand Down Expand Up @@ -266,6 +267,65 @@ hianime

<summary>

### `getAZList`

</summary>

#### Parameters

| Parameter | Type | Description | Required? | Default |
| :----------: | :----: | :-------------------------------------------------------------------------------------------------: | :-------: | :-----: |
| `sortOption` | string | The az-list sort option. Possible values include: "all", "other", "0-9" and all english alphabets . | Yes | -- |
| `page` | number | The page number of the result. | No | `1` |

#### Sample Usage

```javascript
import { HiAnime } from "aniwatch";

const hianime = new HiAnime.Scraper();

hianime
.getAZList("0-9", 1)
.then((data) => console.log(data))
.catch((err) => console.error(err));
```

#### Response Schema

```javascript
{
sortOption: "0-9",
animes: [
{
id: string,
name: string,
jname: string,
poster: string,
duration: string,
type: string,
rating: string,
episodes: {
sub: number ,
dub: number
}
},
{...}
],
totalPages: 1,
currentPage: 1,
hasNextPage: false
}
```

[🔼 Back to Top](#table-of-contents)

</details>

<details>

<summary>

### `getAnimeAboutInfo`

</summary>
Expand Down

0 comments on commit 08ef794

Please sign in to comment.