paheal
> #### Simple and User-Friendly API for [rule34 paheal](https://rule34.paheal.net/).
> #### Recommended for REST API, Bots, Sites
#### Table of content:
* **[Installation](#installation)**
* **[Usage](#usage)**
* **[Methods](#methods)**
* [search()](#search)
* [getMedia()](#getMedia)
* [byAuthor()](#byAuthor)
* **[Data models](#data-models)**
* [Media](#media)
* [Search Class](#search-class)
* [Search Result](#Search-Result)
* **[Catching Errors without .catch()](#Catching-Errors-without-catch)**
* **[Discord Support](#Support)**
* **[License](#license)**
## Installation
```bash
$ npm install paheal
```
## Usage
```js
// in async function
const paheal = require('paheal')
const API = new paheal
// Get a Random Doujin
await API.search().then(search => console.log(search.results))
// Get a indicated Doujin
await API.getMedia(1).then(media => console.log(media))
// Searching
await API.byAuthor('dev').then(search => console.log(search.results))
// Next Page
const search = await API.search('devil')
const nextPage = await search.next()
console.log(nextPage.results)
```
## Methods
### search()
> *Returns the **[not full object](#Search-Result)** of a post.*
> | Param | Type | Description |
> | --- | --- | --- |
> | tags | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Tags into Search |
>
> Usage example:
> ```js
> // in async function
> const search = await paheal.search('devil')
> console.log(search.results)
> ```
>
> ###### *Returns: [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Search model](#search-class) [object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>*
---
### getMedia()
> | Param | Type | Description |
> | --- | --- | --- |
> | id | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)/[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) | ID of Media Post |
>
> Usage example:
> ```js
> // in async function
> const media = await paheal.getMedia(1)
> console.log(media.href)
> ```
>
> ###### *Returns: [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Media model](#media) [object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>*
---
### byAuthor()
> *Returns the **[not full object](#Search-Result)** of a post.*
> | Param | Type | Description |
> | --- | --- | --- |
> | name | [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | Find posts by some Author |
>
> Usage example:
> ```js
> // in async function
> const search = await paheal.byAuthor('noname')
> console.log(search.results)
> ```
>
> ###### *Returns: [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Search model](#search-class) [object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>*
---
## Data Models
### Media
```js
{
author: String,
tags: String[],
src: String,
href: String
}
```
### Search Class
```js
searchResult {
results: Array
lastPage: Number,
currentPage: Number
}
```
### Search Result
```js
{
id: Number,
tags: String[],
href: String
}
```
## Catching Errors without .catch()
In a Node.JS 15.x, reject use a strict mode. So, when Promise returns a reject, your app crashes.
So, my library is user-friendly, and i don't want crash your app, if some wrong. So, how you can catch a errors?
For Example:
```js
// in async function
let search = await paheal.search('devil')
if (search.status) return console.error(search.message);
```
And, your app don't be crashes :)
## Support
[Discord Server](https://discord.gg/Cak7GBJ)
---
## License
MIT License
Copyright © Mikun Hatsune