Class Fetch

Various functions for fetching information from Derpibooru

export
class: Fetch

Hierarchy

Fetch

Index

Properties

Methods

Properties

Static Private jsonConvert

jsonConvert: JsonConvert = new JsonConvert()

Static Private userIDToURLMap

userIDToURLMap: Map<number, string> = new Map<number, string>()

Methods

Static fetchComments

fetchComments(imageID: number, page?: undefined | number): Promise<ImageComments>

- Defined in util/Fetch.ts:397
Fetches the comments on an image

static

memberof

Fetch

Parameters
- imageID: number
  
  The ID of the image to fetch comments from
- Optional page: undefined | number
Returns Promise<ImageComments>

Static fetchImage

fetchImage(id: string | number): Promise<Image>

- Defined in util/Fetch.ts:172
Fetches an image and its associated details

static

memberof

Fetch

Parameters
- id: string | number
  
  The ID of the image to fetch
Returns Promise<Image>

A Promise wrapping the fetched image

Static Private fetchJSON

fetchJSON(options: request.Options): Promise<any>

- Defined in util/Fetch.ts:424
Boilerplate to fetch JSON data from Derpibooru

static

memberof

Fetch

Parameters
- options: request.Options
  
  Options for the request
Returns Promise<any>

A Promise wrapping the returned data

Static fetchTag

fetchTag(name: string, page?: undefined | number, filterID?: DefaultFilters | number): Promise<Tag>

- Defined in util/Fetch.ts:256
Fetches a tag and its associated details by name

static

memberof

Fetch

Parameters
- name: string
- Optional page: undefined | number
- Optional filterID: DefaultFilters | number
Returns Promise<Tag>

A Promise wrapping the fetched tag

Static fetchTagByID

fetchTagByID(id: number, page?: undefined | number, filterID?: DefaultFilters | number): Promise<Tag>

- Defined in util/Fetch.ts:285
Fetches a tag and its associated details by ID

static

memberof

Fetch

Parameters
- id: number
  
  The ID of the tag to fetch
- Optional page: undefined | number
- Optional filterID: DefaultFilters | number
Returns Promise<Tag>

A Promise wrapping the fetched tag

Static fetchUser

fetchUser(username: string): Promise<User>

- Defined in util/Fetch.ts:192
Fetches a user and their associated details by name

static

memberof

Fetch

Parameters
- username: string
Returns Promise<User>

A Promise wrapping the fetched user

Static fetchUserByID

fetchUserByID(id: number): Promise<User>

- Defined in util/Fetch.ts:212
Fetches a user and its associated details by ID

THIS IS A VERY VERY VERY DIRTY HACK, BUT DERPIBOORU'S API DESIGN REQUIRES ITS EXISTENCE! I'M SORRY!

static

memberof

Fetch

Parameters
- id: number
  
  The ID of the user to fetch
Returns Promise<User>

A Promise wrapping the fetched user

Static reverseImageSearch

reverseImageSearch(reverseImageSearchOptions: ReverseImageSearchOptions): Promise<ReverseImageSearchResults>

- Defined in util/Fetch.ts:356
Searches for images that are visually similar to the image provided.

static

memberof

Fetch

Parameters
- reverseImageSearchOptions: ReverseImageSearchOptions
  
  The options to search with
Returns Promise<ReverseImageSearchResults>

A Promise wrapping the returned results

Static search

search(searchOptions: SearchOptions): Promise<SearchResults>

- Defined in util/Fetch.ts:317
Searches for a set of images matching the given query

static

see

SearchOptions

memberof

Fetch

Parameters
- searchOptions: SearchOptions
  
  The options to search with
Returns Promise<SearchResults>

A Promise wrapping the search results

Static setup

setup(): void

- Defined in util/Fetch.ts:160
Sets up some basic settings for the Fetch instance

YOU SHOULD NOT NEED TO CALL THIS YOURSELF. IT IS DONE AT MODULE INITIALIZATION TIME.

static

memberof

Fetch

Returns void

Generated using TypeDoc