nhentai-api
Version:
nHentai Node.JS API client.
2,265 lines • 119 kB
JSON
{
"version": "1.0.0",
"metadata": {
"linker": "(unsigned)",
"siteRoot": "nhentai-api"
},
"root": {
"id": "root-nYEo_kj5NQUnVr8qGvfEL",
"name": "",
"type": "RootDoc",
"members": [
{
"id": "pB1xAVEPYELX8Q-n5fo3D",
"name": "API",
"brief": "",
"type": "ClassDoc",
"description": "<p>Class used for interaction with nHentai API.</p>",
"members": [
{
"id": "STyYi8odmdnET6eoo3UMW",
"name": "APIPath",
"brief": "",
"access": "private",
"scope": "static",
"type": "PropertyDoc",
"description": "<p>API path class</p>"
},
{
"id": "sAp9AGKeN1R604Het7K5N",
"name": "agent",
"brief": "",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>HTTP(S) agent.</p>",
"members": [
{
"id": "QIuJj2DFP2aFHxpMnmcZP",
"name": "",
"brief": "",
"access": "public",
"scope": "static",
"type": "PropertyDoc"
}
]
},
{
"id": "sp02cEZrQwVCbdRDsS7UK",
"name": "hosts",
"brief": "",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>Hosts</p>"
},
{
"id": "fVSue1HUhV4tc9nTFWMmd",
"name": "net",
"brief": "",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>Get http(s) module depending on <code>options.ssl</code>.</p>"
},
{
"id": "zemIsAVKv0ghe9f3iUyDD",
"name": "ssl",
"brief": "",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>Prefer HTTPS over HTTP.</p>"
},
{
"id": "dhtjAOOYdzVQxYUp2xdrY",
"name": "constructor",
"brief": "",
"scope": "instance",
"type": "MethodDoc",
"description": "<p>Applies provided options on top of defaults.</p>",
"params": [
{
"identifier": "options",
"optional": true,
"default": "{}",
"description": "<p>Options to apply.</p>",
"dataType": {
"tokens": [
{
"value": "?nHentaiOptions",
"kind": "canonical"
},
{
"value": "nHentaiOptions",
"kind": "link"
}
],
"template": "?%1"
}
}
],
"returns": []
},
{
"id": "r25RPcr1PBjqGeGwvmz2Z",
"name": "getBook",
"brief": "",
"scope": "instance",
"type": "MethodDoc",
"description": "<p>Get book by id.</p>",
"params": [
{
"identifier": "bookID",
"optional": false,
"description": "<p>Book ID.</p>",
"dataType": {
"tokens": [
{
"value": "number",
"kind": "canonical"
},
{
"value": "number",
"kind": "canonical"
}
],
"template": "%1"
}
}
],
"returns": [
{
"description": "<p>Book instance.</p>",
"dataType": {
"tokens": [
{
"value": "Promise<Book>",
"kind": "canonical"
},
{
"value": "Promise",
"kind": "canonical"
},
{
"value": "Book",
"kind": "link"
}
],
"template": "%1<%2>"
}
}
]
},
{
"id": "Yyx8_U7CIS0v2iClZDmTu",
"name": "getImageURL",
"brief": "",
"scope": "instance",
"type": "MethodDoc",
"description": "<p>Get image URL.</p>",
"params": [
{
"identifier": "image",
"optional": false,
"description": "<p>Image.</p>",
"dataType": {
"tokens": [
{
"value": "Image",
"kind": "canonical"
},
{
"value": "Image",
"kind": "link"
}
],
"template": "%1"
}
}
],
"returns": [
{
"description": "<p>Image URL.</p>",
"dataType": {
"tokens": [
{
"value": "string",
"kind": "canonical"
}
],
"template": "string"
}
}
]
},
{
"id": "A7zU0onkU-Q-ob8SISPFB",
"name": "getRandomBook",
"brief": "",
"scope": "instance",
"type": "MethodDoc",
"description": "<p>Get random book.</p>",
"params": [],
"returns": [
{
"description": "<p>Book instance.</p>",
"dataType": {
"tokens": [
{
"value": "Promise<Book>",
"kind": "canonical"
},
{
"value": "Promise",
"kind": "canonical"
},
{
"value": "Book",
"kind": "link"
}
],
"template": "%1<%2>"
}
}
]
},
{
"id": "L-HYVHlt7P-JmGockpTVI",
"name": "getThumbURL",
"brief": "",
"scope": "instance",
"type": "MethodDoc",
"description": "<p>Get image thumbnail URL.</p>",
"params": [
{
"identifier": "image",
"optional": false,
"description": "<p>Image.</p>",
"dataType": {
"tokens": [
{
"value": "Image",
"kind": "canonical"
},
{
"value": "Image",
"kind": "link"
}
],
"template": "%1"
}
}
],
"returns": [
{
"description": "<p>Image thumbnail URL.</p>",
"dataType": {
"tokens": [
{
"value": "string",
"kind": "canonical"
}
],
"template": "string"
}
}
]
},
{
"id": "dvkcTUgfwRF3RalZOJLv0",
"name": "request",
"brief": "",
"scope": "instance",
"type": "MethodDoc",
"description": "<p>JSON get request.</p>",
"params": [
{
"identifier": "options",
"optional": false,
"description": "<p>HTTP(S) request options.</p>",
"dataType": {
"tokens": [
{
"value": "object",
"kind": "canonical"
}
],
"template": "object"
}
},
{
"identifier": "options.host",
"description": "<p>Host.</p>",
"dataType": {
"tokens": [
{
"value": "string",
"kind": "canonical"
}
],
"template": "string"
}
},
{
"identifier": "options.path",
"description": "<p>Path.</p>",
"dataType": {
"tokens": [
{
"value": "string",
"kind": "canonical"
}
],
"template": "string"
}
}
],
"returns": [
{
"description": "<p>Parsed JSON.</p>",
"dataType": {
"tokens": [
{
"value": "Promise<object>",
"kind": "canonical"
},
{
"value": "Promise",
"kind": "canonical"
}
],
"template": "%1<object>"
}
}
],
"members": [
{
"id": "MbXMNZzOqzJ2J615OzBD_",
"name": "response",
"brief": "",
"readonly": true,
"type": "PropertyDoc"
}
]
},
{
"id": "h-NrZ3pVCFWGGVXvv27bh",
"name": "search",
"brief": "",
"scope": "instance",
"type": "MethodDoc",
"description": "<p>Search by query.</p>",
"params": [
{
"identifier": "query",
"optional": false,
"description": "<p>Query.</p>",
"dataType": {
"tokens": [
{
"value": "string",
"kind": "canonical"
}
],
"template": "string"
}
},
{
"identifier": "page",
"optional": true,
"default": "1",
"description": "<p>Page ID.</p>",
"dataType": {
"tokens": [
{
"value": "?number",
"kind": "canonical"
},
{
"value": "number",
"kind": "canonical"
}
],
"template": "?%1"
}
},
{
"identifier": "sort",
"optional": true,
"default": "''",
"description": "<p>Search sort mode.</p>",
"dataType": {
"tokens": [
{
"value": "?SearchSortMode",
"kind": "canonical"
},
{
"value": "SearchSortMode",
"kind": "link"
}
],
"template": "?%1"
}
}
],
"returns": [
{
"description": "<p>Search instance.</p>",
"dataType": {
"tokens": [
{
"value": "Promise<Search>",
"kind": "canonical"
},
{
"value": "Promise",
"kind": "canonical"
},
{
"value": "Search",
"kind": "link"
}
],
"template": "%1<%2>"
}
}
]
},
{
"id": "VvWTH6nnKvY0Ttfodn6sw",
"name": "searchAlike",
"brief": "",
"scope": "instance",
"type": "MethodDoc",
"description": "<p>Search related books.</p>",
"params": [
{
"identifier": "book",
"optional": false,
"description": "<p>Book instance or Book ID.</p>",
"dataType": {
"tokens": [
{
"value": "number | Book",
"kind": "canonical"
},
{
"value": "number",
"kind": "canonical"
},
{
"value": "Book",
"kind": "link"
}
],
"template": "%1 | %2"
}
}
],
"returns": [
{
"description": "<p>Search instance.</p>",
"dataType": {
"tokens": [
{
"value": "Promise<Search>",
"kind": "canonical"
},
{
"value": "Promise",
"kind": "canonical"
},
{
"value": "Search",
"kind": "link"
}
],
"template": "%1<%2>"
}
}
]
},
{
"id": "znUxe4AAvCSl1_VH-S81A",
"name": "searchGenerator",
"brief": "",
"scope": "instance",
"type": "MethodDoc",
"description": "<p>Search by query.</p>",
"params": [
{
"identifier": "query",
"optional": false,
"description": "<p>Query.</p>",
"dataType": {
"tokens": [
{
"value": "string",
"kind": "canonical"
}
],
"template": "string"
}
},
{
"identifier": "page",
"optional": true,
"default": "1",
"description": "<p>Starting page ID.</p>",
"dataType": {
"tokens": [
{
"value": "?number",
"kind": "canonical"
},
{
"value": "number",
"kind": "canonical"
}
],
"template": "?%1"
}
},
{
"identifier": "sort",
"optional": true,
"default": "''",
"description": "<p>Search sort mode.</p>",
"dataType": {
"tokens": [
{
"value": "?SearchSortMode",
"kind": "canonical"
},
{
"value": "SearchSortMode",
"kind": "link"
}
],
"template": "?%1"
}
}
],
"returns": [
{
"dataType": {
"tokens": [
{
"value": "AsyncGenerator<Search, Search, Search>",
"kind": "canonical"
},
{
"value": "AsyncGenerator",
"kind": "canonical"
},
{
"value": "Search",
"kind": "link"
},
{
"value": "Search",
"kind": "link"
},
{
"value": "Search",
"kind": "link"
}
],
"template": "%1<%4, %2, %3>"
}
}
]
},
{
"id": "ClVTVjjc1EBV9pz9A-Jt1",
"name": "searchTagged",
"brief": "",
"scope": "instance",
"type": "MethodDoc",
"description": "<p>Search by tag id.</p>",
"params": [
{
"identifier": "tag",
"optional": false,
"description": "<p>Tag or Tag ID.</p>",
"dataType": {
"tokens": [
{
"value": "number | Tag",
"kind": "canonical"
},
{
"value": "number",
"kind": "canonical"
},
{
"value": "Tag",
"kind": "link"
}
],
"template": "%1 | %2"
}
},
{
"identifier": "page",
"optional": true,
"default": "1",
"description": "<p>Page ID.</p>",
"dataType": {
"tokens": [
{
"value": "?number",
"kind": "canonical"
},
{
"value": "number",
"kind": "canonical"
}
],
"template": "?%1"
}
},
{
"identifier": "sort",
"optional": true,
"default": "''",
"description": "<p>Search sort mode.</p>",
"dataType": {
"tokens": [
{
"value": "?SearchSortMode",
"kind": "canonical"
},
{
"value": "SearchSortMode",
"kind": "link"
}
],
"template": "?%1"
}
}
],
"returns": [
{
"description": "<p>Search instance.</p>",
"dataType": {
"tokens": [
{
"value": "Promise<Search>",
"kind": "canonical"
},
{
"value": "Promise",
"kind": "canonical"
},
{
"value": "Search",
"kind": "link"
}
],
"template": "%1<%2>"
}
}
]
},
{
"id": "P7__YPujT8x0agOe-39UF",
"name": "getAPIArgs",
"brief": "",
"access": "private",
"scope": "instance",
"type": "MethodDoc",
"description": "<p>Get API arguments.\nThis is internal method.</p>",
"params": [
{
"identifier": "hostType",
"optional": false,
"description": "<p>Host type.</p>",
"dataType": {
"tokens": [
{
"value": "string",
"kind": "canonical"
}
],
"template": "string"
}
},
{
"identifier": "api",
"optional": false,
"description": "<p>Endpoint type.</p>",
"dataType": {
"tokens": [
{
"value": "string",
"kind": "canonical"
}
],
"template": "string"
}
}
],
"returns": [
{
"description": "<p>API arguments.</p>",
"dataType": {
"tokens": [
{
"value": "APIArgs",
"kind": "canonical"
},
{
"value": "APIArgs",
"kind": "link"
}
],
"template": "%1"
}
}
]
}
]
},
{
"id": "pwzTS7oA7SHzwAkNjNH9q",
"name": "APIError",
"brief": "",
"type": "ClassDoc",
"extends": [
"Error"
],
"members": [
{
"id": "a8Xeh52sT2ZHrVpSvLFPO",
"name": "httpResponse",
"brief": "",
"defaultValue": "null",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>HTTP response.</p>"
},
{
"id": "8Fb_xJZYCMjXsuln_8Wrq",
"name": "originalError",
"brief": "",
"defaultValue": "null",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>Original error.</p>"
},
{
"id": "28bumB7leunwkwpQtve6p",
"name": "absorb",
"brief": "",
"scope": "static",
"type": "MethodDoc",
"description": "<p>Absorb error.</p>",
"params": [
{
"identifier": "error",
"optional": true,
"default": "null",
"description": "<p>Original error.</p>",
"dataType": {
"tokens": [
{
"value": "Error",
"kind": "canonical"
},
{
"value": "Error",
"kind": "canonical"
}
],
"template": "%1"
}
},
{
"identifier": "httpResponse",
"optional": true,
"default": "null",
"description": "<p>HTTP response.</p>",
"dataType": {
"tokens": [
{
"value": "?IncomingMessage",
"kind": "canonical"
},
{
"value": "IncomingMessage",
"kind": "canonical"
}
],
"template": "?%1"
}
}
],
"returns": [
{
"dataType": {
"tokens": [
{
"value": "APIError",
"kind": "canonical"
},
{
"value": "APIError",
"kind": "link"
}
],
"template": "%1"
}
}
]
},
{
"id": "UdNhEnJsw7ANOt2WeTFWU",
"name": "constructor",
"brief": "",
"scope": "instance",
"type": "MethodDoc",
"description": "<p>Error message.</p>",
"params": [
{
"identifier": "message",
"optional": false,
"default": "'Unknown error'",
"description": "<p>Message.</p>",
"dataType": {
"tokens": [
{
"value": "string",
"kind": "canonical"
}
],
"template": "string"
}
}
],
"returns": []
}
]
},
{
"id": "KhfSzSLwHHapKKE4aAHeD",
"name": "APIPath",
"brief": "",
"type": "ClassDoc",
"description": "<p>Class used for building URL paths to nHentai API endpoints.\nThis class is internal and has only static methods.</p>",
"members": [
{
"id": "ury4yxZcMxifl-LvahWvV",
"name": "book",
"brief": "",
"scope": "static",
"type": "MethodDoc",
"description": "<p>Book content endpoint.</p>",
"params": [
{
"identifier": "bookID",
"optional": false,
"description": "<p>Book ID.</p>",
"dataType": {
"tokens": [
{
"value": "number",
"kind": "canonical"
},
{
"value": "number",
"kind": "canonical"
}
],
"template": "%1"
}
}
],
"returns": [
{
"description": "<p>URL path.</p>",
"dataType": {
"tokens": [
{
"value": "string",
"kind": "canonical"
}
],
"template": "string"
}
}
]
},
{
"id": "ZSCW9yHtM9WVchDVl2sIz",
"name": "bookCover",
"brief": "",
"scope": "static",
"type": "MethodDoc",
"description": "<p>Book's cover image endpoint.</p>",
"params": [
{
"identifier": "mediaID",
"optional": false,
"description": "<p>Media ID.</p>",
"dataType": {
"tokens": [
{
"value": "number",
"kind": "canonical"
},
{
"value": "number",
"kind": "canonical"
}
],
"template": "%1"
}
},
{
"identifier": "extension",
"optional": false,
"description": "<p>Image extension.</p>",
"dataType": {
"tokens": [
{
"value": "string",
"kind": "canonical"
}
],
"template": "string"
}
}
],
"returns": [
{
"description": "<p>URL path.</p>",
"dataType": {
"tokens": [
{
"value": "string",
"kind": "canonical"
}
],
"template": "string"
}
}
]
},
{
"id": "5htN50aoUAp7K5jW5dHul",
"name": "bookPage",
"brief": "",
"scope": "static",
"type": "MethodDoc",
"description": "<p>Book's page image endpoint.</p>",
"params": [
{
"identifier": "mediaID",
"optional": false,
"description": "<p>Media ID.</p>",
"dataType": {
"tokens": [
{
"value": "number",
"kind": "canonical"
},
{
"value": "number",
"kind": "canonical"
}
],
"template": "%1"
}
},
{
"identifier": "page",
"optional": false,
"description": "<p>Page ID.</p>",
"dataType": {
"tokens": [
{
"value": "number",
"kind": "canonical"
},
{
"value": "number",
"kind": "canonical"
}
],
"template": "%1"
}
},
{
"identifier": "extension",
"optional": false,
"description": "<p>Image extension.</p>",
"dataType": {
"tokens": [
{
"value": "string",
"kind": "canonical"
}
],
"template": "string"
}
}
],
"returns": [
{
"description": "<p>URL path.</p>",
"dataType": {
"tokens": [
{
"value": "string",
"kind": "canonical"
}
],
"template": "string"
}
}
]
},
{
"id": "zjb-u4R35wa9nUUcxJl1v",
"name": "bookThumb",
"brief": "",
"scope": "static",
"type": "MethodDoc",
"description": "<p>Book's page's thumbnail image endpoint.</p>",
"params": [
{
"identifier": "mediaID",
"optional": false,
"description": "<p>Media ID.</p>",
"dataType": {
"tokens": [
{
"value": "number",
"kind": "canonical"
},
{
"value": "number",
"kind": "canonical"
}
],
"template": "%1"
}
},
{
"identifier": "page",
"optional": false,
"description": "<p>Page ID.</p>",
"dataType": {
"tokens": [
{
"value": "number",
"kind": "canonical"
},
{
"value": "number",
"kind": "canonical"
}
],
"template": "%1"
}
},
{
"identifier": "extension",
"optional": false,
"description": "<p>Image extension.</p>",
"dataType": {
"tokens": [
{
"value": "string",
"kind": "canonical"
}
],
"template": "string"
}
}
],
"returns": [
{
"description": "<p>URL path.</p>",
"dataType": {
"tokens": [
{
"value": "string",
"kind": "canonical"
}
],
"template": "string"
}
}
]
},
{
"id": "foTH_ErbMYWKOhOSsStBy",
"name": "randomBookRedirect",
"brief": "",
"scope": "static",
"type": "MethodDoc",
"description": "<p>Redirect to random book at website.</p>",
"params": [],
"returns": [
{
"description": "<p>URL path.</p>",
"dataType": {
"tokens": [
{
"value": "string",
"kind": "canonical"
}
],
"template": "string"
}
}
]
},
{
"id": "v1wiHAnHIPWK9Xd1qUjWD",
"name": "search",
"brief": "",
"scope": "static",
"type": "MethodDoc",
"description": "<p>Search by query endpoint.</p>",
"params": [
{
"identifier": "query",
"optional": false,
"description": "<p>Search query.</p>",
"dataType": {
"tokens": [
{
"value": "string",
"kind": "canonical"
}
],
"template": "string"
}
},
{
"identifier": "page",
"optional": true,
"default": "1",
"description": "<p>Page ID.</p>",
"dataType": {
"tokens": [
{
"value": "?number",
"kind": "canonical"
},
{
"value": "number",
"kind": "canonical"
}
],
"template": "?%1"
}
},
{
"identifier": "sort",
"optional": true,
"default": "''",
"description": "<p>Search sort mode.</p>",
"dataType": {
"tokens": [
{
"value": "?SearchSortMode",
"kind": "canonical"
},
{
"value": "SearchSortMode",
"kind": "link"
}
],
"template": "?%1"
}
}
],
"returns": [
{
"description": "<p>URL path.</p>",
"dataType": {
"tokens": [
{
"value": "string",
"kind": "canonical"
}
],
"template": "string"
}
}
]
},
{
"id": "PkfSKN3rApPidijTDFOsM",
"name": "searchAlike",
"brief": "",
"scope": "static",
"type": "MethodDoc",
"description": "<p>Search alike endpoint.</p>",
"params": [
{
"identifier": "bookID",
"optional": false,
"description": "<p>Book ID.</p>",
"dataType": {
"tokens": [
{
"value": "number",
"kind": "canonical"
},
{
"value": "number",
"kind": "canonical"
}
],
"template": "%1"
}
}
],
"returns": [
{
"description": "<p>URL path.</p>",
"dataType": {
"tokens": [
{
"value": "string",
"kind": "canonical"
}
],
"template": "string"
}
}
]
},
{
"id": "90nv7397NwXgbRyxvFVoi",
"name": "searchTagged",
"brief": "",
"scope": "static",
"type": "MethodDoc",
"description": "<p>Search by tag endpoint.</p>",
"params": [
{
"identifier": "tagID",
"optional": false,
"description": "<p>Tag ID.</p>",
"dataType": {
"tokens": [
{
"value": "number",
"kind": "canonical"
},
{
"value": "number",
"kind": "canonical"
}
],
"template": "%1"
}
},
{
"identifier": "page",
"optional": true,
"default": "1",
"description": "<p>Page ID.</p>",
"dataType": {
"tokens": [
{
"value": "?number",
"kind": "canonical"
},
{
"value": "number",
"kind": "canonical"
}
],
"template": "?%1"
}
}
],
"returns": [
{
"description": "<p>URL path.</p>",
"dataType": {
"tokens": [
{
"value": "string",
"kind": "canonical"
}
],
"template": "string"
}
}
]
},
{
"id": "KuinzaVvS7ssgo7XZau_M",
"name": "constructor",
"brief": "",
"access": "public",
"scope": "instance",
"type": "MethodDoc"
}
]
},
{
"id": "fMdJi9PbufEfeJj4tZh9v",
"name": "Book",
"brief": "",
"type": "ClassDoc",
"description": "<p>Class representing Book.</p>",
"members": [
{
"id": "jmBLiXkPLjuaK54cAkiht",
"name": "Unknown",
"brief": "",
"scope": "static",
"type": "PropertyDoc",
"description": "<p>Unknown book instance.</p>"
},
{
"id": "x7fU2stuREqaj3LP0GnDf",
"name": "UnknownBook",
"brief": "",
"scope": "static",
"type": "PropertyDoc",
"description": "<p>UnknownBook class.</p>"
},
{
"id": "6xHLnTSQo3Yo001Pqv4ml",
"name": "artists",
"brief": "",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>Artist tags.</p>"
},
{
"id": "Jgab2TfjxKRbZJwVa9ym-",
"name": "categories",
"brief": "",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>Category tags.</p>"
},
{
"id": "_X_o0ITRHBDXtbHdnpe9j",
"name": "characters",
"brief": "",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>Character tags.</p>"
},
{
"id": "7raV7NFREWFj35p39_Rab",
"name": "cover",
"brief": "",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>Book cover.</p>"
},
{
"id": "NKkqBEsitq9H_OdG2MCGa",
"name": "favorites",
"brief": "",
"defaultValue": "0",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>Book favours count.</p>"
},
{
"id": "9d0ZMjeczQ7TqE1g9GaIe",
"name": "groups",
"brief": "",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>Group tags.</p>"
},
{
"id": "0BIHBb0kjKBwRF-GhBRAO",
"name": "id",
"brief": "",
"defaultValue": "0",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>Book ID.</p>"
},
{
"id": "CTfg4mInpzDLAB75kH4j-",
"name": "isKnown",
"brief": "",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>Check whatever book is known.</p>"
},
{
"id": "FQ_NwJfws3At1F6WBrFzZ",
"name": "languages",
"brief": "",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>Language tags.</p>"
},
{
"id": "muZXKsu_35okqRzmXs5fF",
"name": "media",
"brief": "",
"defaultValue": "0",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>Book Media ID.</p>"
},
{
"id": "jlbpkFY7EL6ssfo0cFmAE",
"name": "pages",
"brief": "",
"defaultValue": "[]",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>Book pages.</p>"
},
{
"id": "RRs6igbOBHRrt8eC2RvfV",
"name": "parodies",
"brief": "",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>Parody tags.</p>"
},
{
"id": "BdmwJ4UtNOXoHFaTznXL5",
"name": "pureTags",
"brief": "",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>Pure tags (with type {TagType.Tag}).</p>"
},
{
"id": "mBvsRM92zIZNB1xlupEjF",
"name": "scanlator",
"brief": "",
"defaultValue": "''",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>Book scanlator.</p>"
},
{
"id": "2zxIj1JOlr5Ee1CrTEifM",
"name": "tags",
"brief": "",
"defaultValue": "[]",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>Book tags.</p>"
},
{
"id": "ER0oh2oWAG65DyChabW_y",
"name": "title",
"brief": "",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>Book title.</p>"
},
{
"id": "5T0E5Ms42FXYwu7nx0rWQ",
"name": "uploaded",
"brief": "",
"defaultValue": "new Date(0)",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>Book upload date.</p>"
},
{
"id": "JAx7aWA9CPOWJosGbTuZj",
"name": "parse",
"brief": "",
"scope": "static",
"type": "MethodDoc",
"description": "<p>Parse book object into class instance.</p>",
"params": [
{
"identifier": "book",
"optional": false,
"description": "<p>Book.</p>",
"dataType": {
"tokens": [
{
"value": "APIBook",
"kind": "canonical"
},
{
"value": "APIBook",
"kind": "link"
}
],
"template": "%1"
}
}
],
"returns": [
{
"description": "<p>Book instance.</p>",
"dataType": {
"tokens": [
{
"value": "Book",
"kind": "canonical"
},
{
"value": "Book",
"kind": "link"
}
],
"template": "%1"
}
}
]
},
{
"id": "1GVEkWVr-r0kx9Hy_mA8h",
"name": "constructor",
"brief": "",
"scope": "instance",
"type": "MethodDoc",
"description": "<p>Create book.</p>",
"params": [
{
"identifier": "params",
"optional": true,
"description": "<p>Book parameters.</p>",
"dataType": {
"tokens": [
{
"value": "object",
"kind": "canonical"
}
],
"template": "object"
}
},
{
"identifier": "params.title",
"optional": true,
"description": "<p>Book title.</p>",
"dataType": {
"tokens": [
{
"value": "BookTitle",
"kind": "canonical"
},
{
"value": "BookTitle",
"kind": "link"
}
],
"template": "%1"
}
},
{
"identifier": "params.id",
"optional": true,
"default": "0",
"description": "<p>Book ID.</p>",
"dataType": {
"tokens": [
{
"value": "number",
"kind": "canonical"
},
{
"value": "number",
"kind": "canonical"
}
],
"template": "%1"
}
},
{
"identifier": "params.media",
"optional": true,
"default": "0",
"description": "<p>Book Media ID.</p>",
"dataType": {
"tokens": [
{
"value": "number",
"kind": "canonical"
},
{
"value": "number",
"kind": "canonical"
}
],
"template": "%1"
}
},
{
"identifier": "params.favorites",
"optional": true,
"default": "0",
"description": "<p>Book favours count.</p>",
"dataType": {
"tokens": [
{
"value": "number",
"kind": "canonical"
},
{
"value": "number",
"kind": "canonical"
}
],
"template": "%1"
}
},
{
"identifier": "params.scanlator",
"optional": true,
"default": "''",
"description": "<p>Book scanlator.</p>",
"dataType": {
"tokens": [
{
"value": "string",
"kind": "canonical"
}
],
"template": "string"
}
},
{
"identifier": "params.uploaded",
"optional": true,
"description": "<p>Book upload date.</p>",
"dataType": {
"tokens": [
{
"value": "Date",
"kind": "canonical"
},
{
"value": "Date",
"kind": "canonical"
}
],
"template": "%1"
}
},
{
"identifier": "params.tags",
"optional": true,
"default": "[]",
"description": "<p>Book tags.</p>",
"dataType": {
"tokens": [
{
"value": "Array<Tag> | TagsArray",
"kind": "canonical"
},
{
"value": "Array",
"kind": "canonical"
},
{
"value": "Tag",
"kind": "link"
},
{
"value": "TagsArray",
"kind": "link"
}
],
"template": "%1<%2> | %3"
}
},
{
"identifier": "params.cover",
"optional": true,
"description": "<p>Book cover.</p>",
"dataType": {
"tokens": [
{
"value": "Image",
"kind": "canonical"
},
{
"value": "Image",
"kind": "link"
}
],
"template": "%1"
}
},
{
"identifier": "params.pages",
"optional": true,
"default": "[]",
"description": "<p>Book pages.</p>",
"dataType": {
"tokens": [
{
"value": "Array<Image>",
"kind": "canonical"
},
{
"value": "Array",
"kind": "canonical"
},
{
"value": "Image",
"kind": "link"
}
],
"template": "%1<%2>"
}
}
],
"returns": []
},
{
"id": "Bv7wAGsocLFJIzaoQg5rn",
"name": "getTagsWith",
"brief": "",
"scope": "instance",
"type": "MethodDoc",
"description": "<p>Get any tags with certain properties.</p>",
"params": [
{
"identifier": "tag",
"optional": false,
"description": "<p>Tag.</p>",
"dataType": {
"tokens": [
{
"value": "object | Tag",
"kind": "canonical"
},
{
"value": "Tag",
"kind": "link"
}
],
"template": "object | %1"
}
}
],
"returns": [
{
"dataType": {
"tokens": [
{
"value": "TagsArray",
"kind": "canonical"
},
{
"value": "TagsArray",
"kind": "link"
}
],
"template": "%1"
}
}
]
},
{
"id": "iinMxixjT3Nf0Ky4b8eOZ",
"name": "hasTag",
"brief": "",
"scope": "instance",
"type": "MethodDoc",
"description": "<p>Check if book has certain tag.</p>",
"params": [
{
"identifier": "tag",
"optional": false,
"description": "<p>Tag</p>",
"dataType": {
"tokens": [
{
"value": "Tag",
"kind": "canonical"
},
{
"value": "Tag",
"kind": "link"
}
],
"template": "%1"
}
},
{
"identifier": "strict",
"optional": true,
"default": "false",
"description": "<p>Strict comparison.</p>",
"dataType": {
"tokens": [
{
"value": "boolean",
"kind": "canonical"
}
],
"template": "boolean"
}
}
],
"returns": []
},
{
"id": "awIHVioyUYA_ylVgrU361",
"name": "hasTagWith",
"brief": "",
"scope": "instance",
"type": "MethodDoc",
"description": "<p>Check if book has any tags with certain properties.</p>",
"params": [
{
"identifier": "tag",
"optional": false,
"description": "<p>Tag.</p>",
"dataType": {
"tokens": [
{
"value": "object | Tag",
"kind": "canonical"
},
{
"value": "Tag",
"kind": "link"
}
],
"template": "object | %1"
}
}
],
"returns": []
},
{
"id": "mpFixNI_1WWJ01FNxLtq8",
"name": "pushPage",
"brief": "",
"access": "private",
"scope": "instance",
"type": "MethodDoc",
"description": "<p>Push image to book pages.</p>",
"params": [
{
"identifier": "page",
"optional": false,
"description": "<p>Image.</p>",
"dataType": {
"tokens": [
{
"value": "Image",
"kind": "canonical"
},
{
"value": "Image",
"kind": "link"
}
],
"template": "%1"
}
}
],
"returns": [
{
"description": "<p>Whatever page was added.</p>",
"dataType": {
"tokens": [
{
"value": "boolean",
"kind": "canonical"
}
],
"template": "boolean"
}
}
]
},
{
"id": "2ZNY17lrS39rycP4wL-51",
"name": "pushTag",
"brief": "",
"access": "private",
"scope": "instance",
"type": "MethodDoc",
"description": "<p>Push tag to book tags.</p>",
"params": [
{
"identifier": "tag",
"optional": false,
"description": "<p>Tag.</p>",
"dataType": {
"tokens": [
{
"value": "Tag",
"kind": "canonical"
},
{
"value": "Tag",
"kind": "link"
}
],
"template": "%1"
}
}
],
"returns": [
{
"description": "<p>Whatever tag was added.</p>",
"dataType": {
"tokens": [
{
"value": "boolean",
"kind": "canonical"
}
],
"template": "boolean"
}
}
]
},
{
"id": "dmyxxPJuJQJUsm8b5QnT9",
"name": "setCover",
"brief": "",
"access": "private",
"scope": "instance",
"type": "MethodDoc",
"description": "<p>Set book cover image.</p>",
"params": [
{
"identifier": "cover",
"optional": false,
"description": "<p>Image.</p>",
"dataType": {
"tokens": [
{
"value": "Image",
"kind": "canonical"
},
{
"value": "Image",
"kind": "link"
}
],
"template": "%1"
}
}
],
"returns": [
{
"description": "<p>Whatever cover was set.</p>",
"dataType": {
"tokens": [
{
"value": "boolean",
"kind": "canonical"
}
],
"template": "boolean"
}
}
]
}
]
},
{
"id": "YYI1TeOydiO5P6TatHbIj",
"name": "Image",
"brief": "",
"type": "ClassDoc",
"description": "<p>Class representing image.</p>",
"members": [
{
"id": "kYQSpHAMW2YsOyr_McaQS",
"name": "types",
"brief": "",
"scope": "static",
"type": "PropertyDoc",
"description": "<p>Image types.</p>",
"members": [
{
"id": "pKVgH8dyGjkCiRGkePqsH",
"name": "known",
"brief": "",
"scope": "static",
"type": "PropertyDoc",
"description": "<p>Known image types.</p>"
},
{
"id": "WiBBC0gTOQ-A1yMlAy448",
"name": "get",
"brief": "",
"scope": "instance",
"type": "MethodDoc",
"description": "<p>Get image type class instance by name.</p>",
"params": [
{
"identifier": "type",
"optional": false,
"description": "<p>Image type.</p>",
"dataType": {
"tokens": [
{
"value": "string",
"kind": "canonical"
}
],
"template": "string"
}
}
],
"returns": [
{
"description": "<p>Image type class instance.</p>",
"dataType": {
"tokens": [
{
"value": "ImageType | UnknownImageType",
"kind": "canonical"
},
{
"value": "ImageType",
"kind": "link"
},
{
"value": "UnknownImageType",
"kind": "link"
}
],
"template": "%1 | %2"
}
}
]
}
]
},
{
"id": "I5jjLSWuX7DX4vkYa2gB1",
"name": "book",
"brief": "",
"defaultValue": "Book.Unknown",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>Image parent book.</p>"
},
{
"id": "YbBWLOsuniXm_JZVQUQ0b",
"name": "filename",
"brief": "",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>Image filename.</p>"
},
{
"id": "gKLlmocfZQZIiuGxidFYL",
"name": "height",
"brief": "",
"defaultValue": "0",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>Image height.</p>"
},
{
"id": "Z_BoKCsFJR0b7-abmx0fQ",
"name": "id",
"brief": "",
"defaultValue": "0",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>Image ID.</p>"
},
{
"id": "WBELkUKygji1bi-2sZnBP",
"name": "isCover",
"brief": "",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>Whatever this image is book cover.</p>"
},
{
"id": "ARNcgoCYF3wdfEfnpiVAV",
"name": "type",
"brief": "",
"defaultValue": "ImageTypes.JPEG",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>Image type.</p>"
},
{
"id": "IPatMNFRMsU1rC_4BA-AJ",
"name": "width",
"brief": "",
"defaultValue": "0",
"scope": "instance",
"type": "PropertyDoc",
"description": "<p>Image width.</p>"
},
{
"id": "TozTMyJ2WgSOwHMVFSWfo",
"name": "parse",
"brief": "",
"scope": "static",
"type": "MethodDoc",
"description": "<p>Parse pure image object from API into class instance.</p>",
"params": [
{
"identifier": "image",
"optional": false,
"description": "<p>Image object</p>",
"dataType": {
"tokens": [
{
"value": "APIImage",
"kind": "canonical"
},
{
"value": "APIImage",
"kind": "link"
}
],
"template": "%1"
}
},
{
"identifier": "id",
"optional": true,
"default": "0",
"description": "<p>Image id (a.k.a. page number).</p>",
"dataType": {
"tokens": [
{
"value": "number",
"kind": "canonical"
},
{
"value": "number",
"kind": "canonical"
}
],
"template": "%1"
}
}
],
"returns": [
{
"description": "<p>Image instance.</p>",
"dataType": {
"tokens": [
{
"value": "Image",
"kind": "canonical"
},
{
"value": "Image",
"kind": "link"
}
],
"template": "%1"
}
}
]
},
{
"id": "QonFHPPrBh-dm-XZ_vC-d",
"name": "constructor",
"brief": "",
"scope": "instance",
"type": "MethodDoc",
"description": "<p>Create image.</p>",
"params": [
{
"identifier": "params",
"optional": true,
"description": "<p>Image parameters.</p>",
"dataType": {
"tokens": [
{
"value": "object",
"kind": "canonical"
}
],
"template": "object"
}
},
{
"identifier": "params.id",
"optional": true,
"default": "0",
"description": "<p>Image ID.</p>",
"dataType": {
"tokens": [
{
"value": "number",
"kind": "canonical"
},
{
"value": "number",
"kind": "canonical"
}
],
"template": "%1"
}
},
{
"identifier": "params.width",
"optional": true,
"default": "0",
"description": "<p>Image width.</p>",
"dataType": {
"tokens": [
{
"value": "number",
"kind": "canonical"
},
{
"value": "number",
"kind": "canonical"
}
],
"template": "%1"
}
},
{
"identifier": "params.height",
"optional": true,
"default": "0",
"description": "<p>Image height.</p>",
"dataType": {
"tokens": [
{
"value": "number",
"kind": "canonical"
},
{
"value": "number",
"kind": "canonical"
}
],
"template": "%1"
}
},
{
"identifier": "params.type",
"optional": true,
"default": "ImageTypes.JPEG",
"description": "<p>Image type.</p>",
"dataType": {
"tokens": [
{
"value": "string | ImageType",
"kind": "canonical"
},
{
"value": "ImageType",
"kind": "link"
}
],
"template": "string | %1"
}
},
{
"ide