paheal
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.3 • Public • Published
    paheal

    paheal

    Discord Support License NPM downloads NPM version

    Simple and User-Friendly API for rule34 paheal.

    Recommended for REST API, Bots, Sites

    Table of content:

    Installation

    $ npm install paheal

    Usage

    // 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 of a post.

    Param Type Description
    tags string Tags into Search

    Usage example:

    // in async function
    const search = await paheal.search('devil')
    console.log(search.results)
    Returns: Promise<Search model object>

    getMedia()

    Param Type Description
    id string/number ID of Media Post

    Usage example:

    // in async function
    const media = await paheal.getMedia(1)
    console.log(media.href)
    Returns: Promise<Media model object>

    byAuthor()

    Returns the not full object of a post.

    Param Type Description
    name string Find posts by some Author

    Usage example:

    // in async function
    const search = await paheal.byAuthor('noname')
    console.log(search.results)
    Returns: Promise<Search model object>

    Data Models

    Media

    {
        author: String,
        tags: String[],
        src: String,
        href: String 
    }

    Search Class

    searchResult {
        results: Array<SearchResult>
        lastPage: Number,
        currentPage: Number
    }

    Search Result

    {
        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:

    // 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


    License

    MIT License

    Copyright © Mikun Hatsune

    Install

    npm i paheal

    DownloadsWeekly Downloads

    7

    Version

    1.0.3

    License

    ISC

    Unpacked Size

    17 kB

    Total Files

    12

    Last publish

    Collaborators

    • mikun_hatsune