Class ICanHazDadJokeAPI

Index

Constructors

constructor

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

Properties

`Protected` `Readonly`apiClient

apiClient: APIClient

`Protected` `Readonly`options

options: ClientOptions

Methods

getById

getById(id: string, options: { withImage: true }): Promise<JokeResultWithImage>
Fetch a dad joke by ID.
Parameters
- id: string
- options: { withImage: true }
Returns Promise<JokeResultWithImage>
See
https://icanhazdadjoke.com/api#fetch-a-dad-joke
- Defined in ICanHazDadJokeAPI.ts:25
getById(id: string, options?: RequestOptions): Promise<JokeResult>
Fetch a dad joke by ID.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<JokeResult>
See
https://icanhazdadjoke.com/api#fetch-a-dad-joke
- Defined in ICanHazDadJokeAPI.ts:26

getByID

getByID(id: string, options: { withImage: true }): Promise<JokeResultWithImage>
Fetch a dad joke by ID.
Parameters
- id: string
- options: { withImage: true }
Returns Promise<JokeResultWithImage>
See
https://icanhazdadjoke.com/api#fetch-a-dad-joke
- Defined in ICanHazDadJokeAPI.ts:35
getByID(id: string, options?: RequestOptions): Promise<JokeResult>
Fetch a dad joke by ID.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<JokeResult>
See
https://icanhazdadjoke.com/api#fetch-a-dad-joke
- Defined in ICanHazDadJokeAPI.ts:36

getRandom

getRandom(options: { withImage: true }): Promise<JokeResultWithImage>
Fetch a random dad joke.
Parameters
- options: { withImage: true }
Returns Promise<JokeResultWithImage>
See
https://icanhazdadjoke.com/api#fetch-a-random-dad-joke
- Defined in ICanHazDadJokeAPI.ts:55
getRandom(options?: RequestOptions): Promise<JokeResult>
Fetch a random dad joke.
Parameters
- Optionaloptions: RequestOptions
Returns Promise<JokeResult>
See
https://icanhazdadjoke.com/api#fetch-a-random-dad-joke
- Defined in ICanHazDadJokeAPI.ts:56

search

search(options: SearchOptions): Promise<JokeSearchResult>
Search for dad jokes.
Parameters
- options: SearchOptions
  Search options (default: list all jokes)
Returns Promise<JokeSearchResult>
See
https://icanhazdadjoke.com/api#search-for-dad-jokes
- Defined in ICanHazDadJokeAPI.ts:76
search(
query: string,
options?: Omit<SearchOptions, "term">,
): Promise<JokeSearchResult>
Search for dad jokes.
Parameters
- query: string
- Optionaloptions: Omit<SearchOptions, "term">
  Search options (default: list all jokes)
Returns Promise<JokeSearchResult>
See
https://icanhazdadjoke.com/api#search-for-dad-jokes
- Defined in ICanHazDadJokeAPI.ts:77

Class ICanHazDadJokeAPI

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ICanHazDadJokeAPI

Properties

Protected ReadonlyapiClient

Protected Readonlyoptions

Methods

getById

Parameters

Returns Promise<JokeResultWithImage>

See

Parameters

Returns Promise<JokeResult>

See

getByID

Parameters

Returns Promise<JokeResultWithImage>

See

Parameters

Returns Promise<JokeResult>

See

getRandom

Parameters

Returns Promise<JokeResultWithImage>

See

Parameters

Returns Promise<JokeResult>

See

search

Parameters

Returns Promise<JokeSearchResult>

See

Parameters

Returns Promise<JokeSearchResult>

See

Settings

On This Page

`Protected` `Readonly`apiClient

`Protected` `Readonly`options