Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Created getUser() method #85

Merged
merged 12 commits into from
Nov 30, 2022
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ Tables of content:
- * [getRecommendationsList()](https://github.com/Kylart/MalScraper/blob/master/README.md#getrecommendationslist)
- * [getStats()](https://github.com/Kylart/MalScraper/blob/master/README.md#getstats)
- * [getPictures()](https://github.com/Kylart/MalScraper/blob/master/README.md#getpictures)
- * [getUser()](https://github.com/Kylart/MalScraper/blob/master/README.md#getuser)
- * [Official API Constructor](https://github.com/Kylart/MalScraper/blob/master/README.md#official-api-constructor)
- - * [checkCredentials()](https://github.com/Kylart/MalScraper/blob/master/README.md#checkcredentials)
- - * [search()](https://github.com/Kylart/MalScraper/blob/master/README.md#search)
Expand Down Expand Up @@ -470,6 +471,20 @@ malScraper.getPictures(name)

Returns: An array of [Anime pictures data model](https://github.com/Kylart/MalScraper/blob/master/README.md#anime-pictures-data-model) objects

### getUser()
| Parameter | Type | Description |
| --- | --- | --- |
| name | string | The username of the user |

``` javascript
const malScraper = require('mal-scraper')

malScraper.getUser('Kame-nos')
.then((data) => console.log(data))
.catch((err) => console.log(err))
```
Returns: A [User data model]()

### Official API constructor
> This requires a valid MyAnimeList account

Expand Down
Loading