nhentai-node-api v1.1.2

An unofficial API for nHentai.

Table of content:

• Installation
• Usage
• Methods
  • search()
  • getDoujin()
  • getPopular()
  • getLatest()
  • exists()
• Data models
  • Search
  • Doujin
• License

Installation

$ npm install nhentai-node-api

Usage

const nhentai = require('nhentai-node-api')

Methods

search()

Usage example:

nhentai.search('metamorphosis', 'popular-week', 1)
  .then(results => {
    //do things with the results
  })
  .catch(err => console.log(err))

Returns: Search model object

getDoujin()

Returns the full object of a precise doujin.

Usage example:

nhentai.getDoujin(177013)
  .then(data => {
    //do things with the data
  })
  .catch(err => console.log(err))

Returns: Doujin model object

getPopular()

Returns the 5 doujins in the Popular Now field on the homepage of nhentai.

Usage example:

nhentai.getPopular()
  .then(results => {
    //do things with the results
  })
  .catch(err => console.log(err))

Returns: Search model object

getLatest()

Returns the latest added doujins on the website.

Usage example:

nhentai.getLatest() //will return the results of the first page as the 'page' parameter isn't specified
  .then(results => {
    //do things with the results
  })
  .catch(err => console.log(err))

Returns: Search model object

exists()

Simply checks if a doujin url or id exists.

Usage example:

nhentai.exists(177013)
  .then(result => {
    if (result) console.log('This doujin exists!')
    else console.log('This doujin doesn\'t exists!')
  })
  .catch(err => console.log(err))

Returns: a boolean

Data models

Search

Search data models are arrays of objects.

[
  {
    id: Number,
    title: String, //original title of the doujin
    language: String, //language of the doujin, can be either: english, japanese or chinese
    thumbnail: String, //url of the cover image
  },
  //etc
]

Doujin

Doujin data models are objects.

{
  id: Number,
  title: {
    default: String, //complete original title
    pretty: String, //pretty version of the title
    native: String //title in its native language (japanese most of the time)
  },
  language: String, //language of the doujin, can be either: english, japanese or chinese
  cover: String, //image url of the cover
  details: { /*this section is a bit special. Each property correspond to a field underneath the title of the doujin on the website page. If the 'simplified' parameter of getDoujin() is set to true, it will just put strings in the array. But if it's set to false (by default tho), it'll populate the arrays with objects like this:
    {
      name: String, //the value itself
      count: Number, //the number of other doujins that also have this property
      link: String, //the link to the specific page of this property on the website
    }
    */
    parodies: [],
    characters: [],
    tags: [],
    artists: [],
    groups: [],
    categories: [],
  },
  pages: [String], //images urls of the pages
  thumbnails: [String], //images urls of the thumbnails
  favorites: Number, //number of favorites on this doujin
  uploaded: Date, //upload date
  link: String //link to the doujin
}

License

MIT License

Copyright (c) barthofu