Class Client

The Base CLient used for asyncdagpi

param token: Your dagpi token

Hierarchy

Client

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Client(token: string): Client

- Defined in src/client.ts:28
Construct a new dagpi client

Parameters
- token: string
Returns Client

Properties

Private http

http: AxiosInstance

ratelimits

ratelimits: RatelimitInfo

token

token: string

version

version: string

Methods

captcha

captcha(): Promise<captcha>

- Defined in src/client.ts:102
Get a random captcha

Returns Promise<captcha>

eight_ball

eight_ball(): Promise<Eightball>

- Defined in src/client.ts:92
Get a random fact

Returns Promise<Eightball>

fact

fact(): Promise<fact>

- Defined in src/client.ts:87
Get a random fact

Returns Promise<fact>

headline

headline(): Promise<headline>

- Defined in src/client.ts:97
Get a random headline

Returns Promise<headline>

image_process

image_process(feature: ImageFeature, parmas: image_props): Promise<image>

- Defined in src/client.ts:122
Process a dagpi image

Parameters
- feature: ImageFeature
  
  The feature chose for manipulation
- parmas: image_props
Returns Promise<image>
image - contains a dagpijs image class

Private image_request

image_request(path: string, params: image_props): Promise<image>

- Defined in src/client.ts:155
Private function to make Http request

Parameters
- path: string
  
  route to be taken
- params: image_props
  
  additional prarams
Returns Promise<image>
[description]

joke

joke(): Promise<joke>

- Defined in src/client.ts:51
Get a random joke

Returns Promise<joke>

logo

logo(): Promise<logo>

- Defined in src/client.ts:77
get a logo object

Returns Promise<logo>

pickup_line

pickup_line(): Promise<pickupline>

- Defined in src/client.ts:72
get a pickupline object

Returns Promise<pickupline>

Private request

request<T>(url: string): Promise<T>

- Defined in src/client.ts:185
Request

Type parameters
- T
Parameters
- url: string
Returns Promise<T>

roast

roast(): Promise<roast>

- Defined in src/client.ts:61
Get a roast object

Returns Promise<roast>

special_image

special_image(parmas: image_props): Promise<image>

- Defined in src/client.ts:133
Process a special dagpi feature!

Parameters
- parmas: image_props
Returns Promise<image>
image - contains a dagpijs image class

typeracer

typeracer(): Promise<typeracer>

- Defined in src/client.ts:107
Get a random typeracer game data payload with sentence, and image

Returns Promise<typeracer>

Private validate

validate(url: string): boolean

- Defined in src/client.ts:143
Validate a Url against regex

Parameters
- url: string
  
  url supplied
Returns boolean
wether valid or not

waifu

waifu(): Promise<any>

- Defined in src/client.ts:82
Get a waifu object

Returns Promise<any>

wtp

wtp(): Promise<wtp>

- Defined in src/client.ts:56
Get json with WTP data

Returns Promise<wtp>

yomama

yomama(): Promise<yomama>

- Defined in src/client.ts:66
Get a yomama joke object

Returns Promise<yomama>

Generated using TypeDoc