Class XKCDAPI

Index

Constructors

Properties

apiClient options

Methods

getByIndex getLatest getRandom

Constructors

constructor

new XKCDAPI(apiClient: APIClient, options: ClientOptions): XKCDAPI
Parameters
- apiClient: APIClient
- options: ClientOptions
Returns XKCDAPI
- Defined in XKCDAPI.ts:11

Properties

`Protected` `Readonly`apiClient

apiClient: APIClient

`Protected` `Readonly`options

options: ClientOptions

Methods

getByIndex

getByIndex(
index: number,
options: { withData: true },
): Promise<XKCDResultWithData>
Get a comic by index.
Parameters
- index: number
  Index number
- options: { withData: true }
  Request options
Returns Promise<XKCDResultWithData>
- Defined in XKCDAPI.ts:24
getByIndex(index: number, options?: RequestOptions): Promise<XKCDResultWithData>
Get a comic by index.
Parameters
- index: number
  Index number
- Optionaloptions: RequestOptions
  Request options
Returns Promise<XKCDResultWithData>
- Defined in XKCDAPI.ts:25

getLatest

getLatest(options: { withData: true }): Promise<XKCDResultWithData>
Get the latest comic.
Parameters
- options: { withData: true }
  Request options
Returns Promise<XKCDResultWithData>
- Defined in XKCDAPI.ts:48
getLatest(options?: RequestOptions): Promise<XKCDResultWithData>
Get the latest comic.
Parameters
- Optionaloptions: RequestOptions
  Request options
Returns Promise<XKCDResultWithData>
- Defined in XKCDAPI.ts:49

getRandom

getRandom(options: { withData: true }): Promise<XKCDResultWithData>
Get a random comic.
Parameters
- options: { withData: true }
  Request options
Returns Promise<XKCDResultWithData>
- Defined in XKCDAPI.ts:68
getRandom(options?: RequestOptions): Promise<XKCDResultWithData>
Get a random comic.
Parameters
- Optionaloptions: RequestOptions
  Request options
Returns Promise<XKCDResultWithData>
- Defined in XKCDAPI.ts:69