Documentation

-=Documentation for the kasu.nhentaiapi.js=-

Overview

install
Basic use

kasu.nhentaiapi.js

Class
- Properties
  - class.url
  - class.connection
    - connection.start()
    - connection.close()
  - class.IsDiscord
  - class.blockedWords
  - class.ReRollonFail
  - class.IgnoreNone
- Methods

Json Object

Json Interface
pPage Interface

CLI

`Return bacc`

Get started

npm i kasu.nhentaiapi.js

Basics

const Example = require('kasu.nhentaiapi.js');
const ExampleApi = new Example();
/**
 * or const ExampleApi = new Example('start', "https://nhentai.net");
 * If you don't want to add the url and connection.start() after it.
 * because it automatically start the connection.
 * 
 * Check the documentation for more info.
*/

//          ----number | strings can do----
const ID = 228922 //or "228922" or "https://nhentai.net/g/228922"
async function json(){

    // start the connection
    ExampleApi.url = "https://nhentai.net"
    ExampleApi.connection.start()

    const val = await ExampleApi.getID(ID).json()
    val.url
    // OR
    ExampleApi.getID(ID).json(data=>{data.url})
    // OR
    (await ExampleApi.getID(ID).json()).url
    // result: https://nhentai.net/g/228922/

    // closes the connection
    ExampleApi.connection.close()
}

`⠀Constructor(connection, url, debug)⠀`

connection has 1 inputs that can be accepted, start. Same as the connection function below. It just automatically start the connection without calling the connection property.

url see the url property below.

debug see the connection's debug below.

Property classes

`⠀url⠀` : string

As of the 3.5.0 update the domain .to is now supported, The Inputted URL will be used to connect.
https://nhentai.net or https://nhentai.to only.

`⠀connection⠀` : object

If you want to start the connection provided by the url.
⠀⠀- ⠀start( debug )⠀ : function
⠀⠀⠀⠀• start the connection.
⠀⠀- ⠀close( debug )⠀ : function
⠀⠀⠀⠀• close the connection.

The debug on the start, close functions is a boolean. If set to true It will show a log that shows that it is working and connected.

`⠀IsDiscord⠀` : boolean

If you're using this API on your DiscordBot Enabling this will block some tags that is inappropriate or violates DiscordTOS.
default bool set is false.

`⠀blockedWords⠀` : string

Add more tags that will be blocked.

  blockedWords = "crossdressing brutality penetration"

`⠀ReRollonFail⠀` : boolean

If you're using IsDiscord and don't wanna do your own retry function use this.
note: By enabling this it might slow down the process unless if you have a fast internet or processor.
default bool set is false.

`⠀IgnoreNone⠀` : boolean

Ignore showing empty / none tags on the json object.

default bool set is false.

// false
{
  "tag": "none",
  "parodies": "konosuba"
}
// true
{
  "parodies": "konosuba"
}

Method classes

`⠀getID( string )⠀`

string can be a string or a number or even the link itself. Example of this method can be seen on the Basics
returns a json object.

`⠀pRandID()⠀`

Generate random ID based on the website's button 'Random'.
returns an ID only!

`⠀pRandSpecificTags( string, fn )⠀`

It uses the Nhentai Searchbar functionality.

returns a json object.

//gets the data of the given tags
await api.pRandSpecificTags("konosuba aqua sole female", data=>{
  /* data.[json object] */
})

pRand's

`⠀pRandTag( tag, fn )⠀`

`⠀pRandParody( tag, fn )⠀`

`⠀pRandArtist( tag, fn )⠀`

`⠀pRandGroup( tag, fn )⠀`

Tag, Parody, Artist, Group shares the same function it generate random ID based on the Given Tag.
NOTE: It only accepts 1 tag/name that exist on the Nhentai database.

returns a json object.

//returns a link | id
await pRandtag("<name of the tag>").link | .id
//get data of the random generated ID of the given tag
await pRandtag("<name of the tag>", data=>{
  /* data.[json object] */
})

`⠀pRandom( fn )⠀`

Generate random ID based on the website's button 'Random'.

returns a json object.

// gives random number
await api.pRandom()
// you can get the random number's data
await api.pRandom(data=>{
  data.images.cover
})

`⠀pHomepage( int )⠀`

int specifies the page. Shows the Homepage of the selected URL.
returns a json object

`⠀pLanguagePage( str, int )⠀`

str only accepts 4 string japanese, english, chinese and translated (is this even a language). it also accepts shortcuts like jp, japan, eng, china. int specifies the page.
returns a json object

`⠀pSearch( str, int )⠀`

Shows some list of the searched string of str. int specifies the page.
returns a json object

`⠀pTagPage( str, int )⠀`

Shows some list of the searched tag string of str. int specifies the page.
returns a json object

Json Object

This object is also used on pRand's data functions.

{
    "id": 228922,
    "url": "https://nhentai.net/g/228922/",
    "title": { 
        "origin": "エログロス Vol.2",
        "translated": "EROGROS Vol. 2",
        "originFull": "[アンソロジー] エログロス Vol.2 [DL版]",
        "translatedFull": "[Anthology] EROGROS Vol. 2 [Digital]"
    },
    "images": { 
        "cover": "https://t.nhentai.net/galleries/1205270/cover.jpg",
        "pages_source": "https://t.nhentai.net/galleries/1205270",
        "pages": [Function: pages]
    },
    "tag_table": {
        "parodies": "none",
        "characters": "none",
        // bruh
        "tag": "anal birth, balls expansion, big balls, big breasts, big penis, dickgirl on male, impregnation, lactation, shotacon, transformation, abortion, ahegao, amputee, bondage, cannibalism, collar, daughter, futanari, glasses, guro, human pet, lolicon, monster girl, necrophilia, piercing, pregnant, randoseru, ryona, sister, snuff, tentacles, anthology, group, incest, birth, urethra insertion, breast expansion, multiple breasts, torture, dick growth, yaoi",
        "artists": "uziga waita, horihone saizou, momoiro manjiru, tksn, faith, zero punch, hayami kuro, ai7n, senmu",
        "groups": "none",
        "languages": "japanese",
        "categories": "manga"
    },
    "favorites": 2900,
    "number_pages": 244,
    "uploaded": "2 years, 1 month ago"
}

Json Interface

NOTE: Some of it is literally nonsense because this is what is in the declaration file.

`⠀id⠀` : number

ID or Code or whatever you call.

`⠀url⠀` : string

Url of the selected code.

`⠀title⠀` : object

titles?
⠀⠀- ⠀origin⠀ : string
⠀⠀⠀⠀• original
⠀⠀- ⠀translated⠀ : string
⠀⠀⠀⠀• トランスレイト??? wait it's supposed to be in english cuz' it's translated.
⠀⠀- ⠀originFull⠀ : string
⠀⠀⠀⠀• original but its full version of it.
⠀⠀- ⠀translatedFull⠀ : string
⠀⠀⠀⠀• YES ITS FULL VERSION OF THE TRANSLATED TITLE OF IT.

`⠀images⠀` : object

images?
⠀⠀- ⠀cover⠀ : string
⠀⠀⠀⠀• Doujin cover image.
⠀⠀- ⠀pages_source⠀ : string
⠀⠀⠀⠀• Doujin image source.
⠀⠀- ⠀pages⠀ : function
⠀⠀⠀⠀• Usage: page( int ). Int specifies the image number page.

`⠀tag_table⠀` : object

tags?
⠀⠀- ⠀parodies⠀ : string
⠀⠀⠀⠀• I Like konosuba
⠀⠀- ⠀characters⠀ : string
⠀⠀⠀⠀• I love megumin
⠀⠀- ⠀tag⠀ : string
⠀⠀⠀⠀• what?
⠀⠀- ⠀artist⠀ : string
⠀⠀⠀⠀• I don't really know about this
⠀⠀- ⠀groups⠀ : string
⠀⠀⠀⠀• Can't think 1 group tag.
⠀⠀- ⠀languages⠀ : string
⠀⠀⠀⠀• english ofc.
⠀⠀- ⠀categories⠀ : string
⠀⠀⠀⠀• ca

`⠀favorites⠀` : number

damn that many people ey?

`⠀number_pages⠀` : number

haha 69 pages seems cool.

`⠀uploaded⠀` : string

Hokusai made The Dream of the Fisherman's Wife in 1814, the earliest known Tentacle hentai.
In 1722 the government made a law banning hentai manga, which means it was common even earlier.
Suzumi-fune is probobly the oldest hentai anime, it's from 1932.

pPage Json

This object will show on pHomepage, pLanguagePage, pSearch, pTagPage.

// using nhentai.to for this example
[
  {
    "CurrentUrl": "https://nhentai.to",
    "typePage": "language / japanese",
    "CurrentPage": 1,
    "Total": 25,
    "TotalPage": 8524
  },

  {
    "id": 374305,
    "title":  "[LV43 (Shia)] Onee-sama, Kore ga Hoshiino (Jinrou Judgement) [Digital]",
    "thumbnail":  "https://t.dogehls.xyz/galleries/2018823/thumb.jpg",
    "url":  "https://nhentai.to/g/374305",
    "languages":  "japanese"
  },
  {
    //and more...
  }
]

pPage Interface

`⠀CurrentUrl⠀` : string

Gives the Url.

`⠀typePage⠀` : string

idk.

`⠀CurrentPage⠀` : number

Gives an index number of what page you are currently in.

`⠀Total⠀` : number

Total arrays.

`⠀TotalPage⠀` : number

Total Pages ofc.

`⠀id⠀` : number

ID or Code or whatever you call.

`⠀title⠀` : string

taitoru.

`⠀thumbnail⠀` : string

Cover picture.

`⠀url⠀` : string

It's just the combination of the currenturl with id innit.

`⠀languages⠀` : string

NANI TTE-

CLI⠀`prototype`

![]() the CLI of the module is still WIP. You may experience weird bugs or other, Use it if you want.
nhentai to run, add help for options/how to.

Documentation

Return bacc

Get started

Basics

⠀Constructor(connection, url, debug)⠀

Property classes

⠀url⠀ : string

⠀connection⠀ : object

⠀⠀- ⠀start( debug )⠀ : function

⠀⠀- ⠀close( debug )⠀ : function

⠀IsDiscord⠀ : boolean

⠀blockedWords⠀ : string

⠀ReRollonFail⠀ : boolean

⠀IgnoreNone⠀ : boolean

Method classes

⠀getID( string )⠀

⠀pRandID()⠀

⠀pRandSpecificTags( string, fn )⠀

pRand's

⠀pRandTag( tag, fn )⠀

⠀pRandParody( tag, fn )⠀

⠀pRandArtist( tag, fn )⠀

⠀pRandGroup( tag, fn )⠀

⠀pRandom( fn )⠀

⠀pHomepage( int )⠀

⠀pLanguagePage( str, int )⠀

⠀pSearch( str, int )⠀

⠀pTagPage( str, int )⠀

Json Object

Json Interface

⠀id⠀ : number

⠀url⠀ : string

⠀title⠀ : object

⠀⠀- ⠀origin⠀ : string

⠀⠀- ⠀translated⠀ : string

⠀⠀- ⠀originFull⠀ : string

⠀⠀- ⠀translatedFull⠀ : string

⠀images⠀ : object

⠀⠀- ⠀cover⠀ : string

⠀⠀- ⠀pages_source⠀ : string

⠀⠀- ⠀pages⠀ : function

⠀tag_table⠀ : object

⠀⠀- ⠀parodies⠀ : string

⠀⠀- ⠀characters⠀ : string

⠀⠀- ⠀tag⠀ : string

⠀⠀- ⠀artist⠀ : string

⠀⠀- ⠀groups⠀ : string

⠀⠀- ⠀languages⠀ : string

⠀⠀- ⠀categories⠀ : string

⠀favorites⠀ : number

⠀number_pages⠀ : number

⠀uploaded⠀ : string

pPage Json

pPage Interface

⠀CurrentUrl⠀ : string

⠀typePage⠀ : string

⠀CurrentPage⠀ : number

⠀Total⠀ : number

⠀TotalPage⠀ : number

⠀id⠀ : number

⠀title⠀ : string

⠀thumbnail⠀ : string

⠀url⠀ : string

⠀languages⠀ : string

CLI⠀prototype

clicky buttons

`Return bacc`

`⠀Constructor(connection, url, debug)⠀`

`⠀url⠀` : string

`⠀connection⠀` : object

⠀⠀- `⠀start( debug )⠀` : function

⠀⠀- `⠀close( debug )⠀` : function

`⠀IsDiscord⠀` : boolean

`⠀blockedWords⠀` : string

`⠀ReRollonFail⠀` : boolean

`⠀IgnoreNone⠀` : boolean

`⠀getID( string )⠀`

`⠀pRandID()⠀`

`⠀pRandSpecificTags( string, fn )⠀`

`⠀pRandTag( tag, fn )⠀`

`⠀pRandParody( tag, fn )⠀`

`⠀pRandArtist( tag, fn )⠀`

`⠀pRandGroup( tag, fn )⠀`

`⠀pRandom( fn )⠀`

`⠀pHomepage( int )⠀`

`⠀pLanguagePage( str, int )⠀`

`⠀pSearch( str, int )⠀`

`⠀pTagPage( str, int )⠀`

`⠀id⠀` : number

`⠀url⠀` : string

`⠀title⠀` : object

⠀⠀- `⠀origin⠀` : string

⠀⠀- `⠀translated⠀` : string

⠀⠀- `⠀originFull⠀` : string

⠀⠀- `⠀translatedFull⠀` : string

`⠀images⠀` : object

⠀⠀- `⠀cover⠀` : string

⠀⠀- `⠀pages_source⠀` : string

⠀⠀- `⠀pages⠀` : function

`⠀tag_table⠀` : object

⠀⠀- `⠀parodies⠀` : string

⠀⠀- `⠀characters⠀` : string

⠀⠀- `⠀tag⠀` : string

⠀⠀- `⠀artist⠀` : string

⠀⠀- `⠀groups⠀` : string

⠀⠀- `⠀languages⠀` : string

⠀⠀- `⠀categories⠀` : string

`⠀favorites⠀` : number

`⠀number_pages⠀` : number

`⠀uploaded⠀` : string

`⠀CurrentUrl⠀` : string

`⠀typePage⠀` : string

`⠀CurrentPage⠀` : number

`⠀Total⠀` : number

`⠀TotalPage⠀` : number

`⠀id⠀` : number

`⠀title⠀` : string

`⠀thumbnail⠀` : string

`⠀url⠀` : string

`⠀languages⠀` : string

CLI⠀`prototype`