Class API

Hierarchy

API

Index

Constructors

constructor

Properties

options

Methods

Constructors

constructor

new API(options?: {}): API

- Defined in src/api.ts:11
Constuct a new API wrapper

Parameters
- options: {} = {}
Returns API

Properties

options

options: {} = {}

Type declaration

Methods

doujinExists

doujinExists(id: string | number): Promise<boolean>

- Defined in src/api.ts:31
Check if a doujin exists

Parameters
- id: string | number
  
  ID of the doujin
Returns Promise<boolean>

Private fetch

fetch(path: string): Promise<unknown>

- Defined in src/api.ts:18
Node-fetch wrapper that handles api errors

Parameters
- path: string
  
  API path
Returns Promise<unknown>

parsed JSON

fetchDoujin

fetchDoujin(id: string | number): Promise<null | Doujin>

- Defined in src/api.ts:53
Fetch a doujin

Parameters
- id: string | number
  
  ID of the doujin.
Returns Promise<null | Doujin>

fetchHomepage

fetchHomepage(page?: string | number, sort?: SortMethods): Promise<SearchResult>

- Defined in src/api.ts:70
Fetch homepage doujins

Parameters
- page: string | number = 1
- sort: SortMethods = ...
Returns Promise<SearchResult>

randomDoujin

randomDoujin(): Promise<Doujin>

- Defined in src/api.ts:140
Fetch a random doujin

Returns Promise<Doujin>

randomDoujinID

randomDoujinID(): Promise<number>

- Defined in src/api.ts:129
Fetch a random doujin ID

Returns Promise<number>

search

search(query: string, page?: string | number, sort?: SortMethods): Promise<SearchResult>

- Defined in src/api.ts:77
Search by string query

Parameters
- query: string
- page: string | number = 1
- sort: SortMethods = ...
Returns Promise<SearchResult>

searchByTagID

searchByTagID(id: string | number, page?: string | number, sort?: SortMethods): Promise<SearchResult>

- Defined in src/api.ts:93
Search doujins with this tag

Parameters
- id: string | number
  
  Tag ID
- page: string | number = 1
  
  Page number
- sort: SortMethods = ...
  
  API sort method
Returns Promise<SearchResult>

searchRelated

searchRelated(id: string | number, page?: string | number): Promise<SearchResult>

- Defined in src/api.ts:115
Find similar doujins

Parameters
- id: string | number
  
  Doujin ID
- page: string | number = 1
  
  Page number
Returns Promise<SearchResult>

Generated using TypeDoc