ImageAPI.md

bandcamp-fetch • Docs

---

bandcamp-fetch / ImageAPI

Class: ImageAPI

Extends

• BaseAPI

Extended by

• LimiterImageAPI

Constructors

new ImageAPI()

new ImageAPI(params): ImageAPI

Parameters

• params: BaseAPIParams

Returns

ImageAPI

Inherited from

BaseAPI.constructor

Defined in

lib/common/BaseAPI.ts:15

Accessors

cache

Get Signature

get protected cache(): Cache

Returns

Cache

Inherited from

BaseAPI.cache

Defined in

lib/common/BaseAPI.ts:27

Methods

fetch()

fetch(url, jsonResponse, method, payload)

protected fetch(url, jsonResponse, method, payload?): Promise<object>

Parameters

• url: string

• jsonResponse: false

• method: HEAD

• payload?: undefined

Returns

Promise<object>

ok

ok: boolean

status

status: number

Inherited from

BaseAPI.fetch

Defined in

lib/common/BaseAPI.ts:20

fetch(url, jsonResponse, method, payload)

protected fetch(url, jsonResponse, method?, payload?): Promise<any>

Parameters

• url: string

• jsonResponse: true

• method?: FetchMethod

• payload?: Record<string, any>

Returns

Promise<any>

Inherited from

BaseAPI.fetch

Defined in

lib/common/BaseAPI.ts:21

fetch(url, jsonResponse, method, payload)

protected fetch(url, jsonResponse?, method?, payload?): Promise<string>

Parameters

• url: string

• jsonResponse?: boolean

• method?: FetchMethod

• payload?: Record<string, any>

Returns

Promise<string>

Inherited from

BaseAPI.fetch

Defined in

lib/common/BaseAPI.ts:22

---

getFormat()

getFormat(target?, fallbackId?): Promise<null | ImageFormat>

Parameters

• target?: string | number | ImageFormat

• fallbackId?: number

Returns

Promise<null | ImageFormat>

Defined in

lib/image/ImageAPI.ts:27

---

getFormats()

getFormats(filter?): Promise<ImageFormat[]>

Parameters

• filter?: ImageFormatFilter

Returns

Promise<ImageFormat[]>

Defined in

lib/image/ImageAPI.ts:47