bandcamp-fetch/docs/api/classes/ImageAPI.md

bandcamp-fetch / ImageAPI

Class: ImageAPI

Hierarchy

• BaseAPI

  ↳ ImageAPI

  ↳↳ LimiterImageAPI

Table of contents

Constructors

• constructor

Accessors

• cache

Methods

• fetch
• getFormat
• getFormats

Constructors

constructor

• new ImageAPI(params)

Parameters

Name	Type
params	BaseAPIParams

Inherited from

BaseAPI.constructor

Defined in

lib/common/BaseAPI.ts:15

Accessors

cache

• Protected get cache(): Cache

Returns

Cache

Inherited from

BaseAPI.cache

Defined in

lib/common/BaseAPI.ts:27

Methods

fetch

▸ Protected fetch(url, jsonResponse, method, payload?): Promise<Response>

Parameters

Name	Type
url	string
jsonResponse	false
method	HEAD
payload?	undefined

Returns

Promise<Response>

Inherited from

BaseAPI.fetch

Defined in

lib/common/BaseAPI.ts:20

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

Parameters

Name	Type
url	string
jsonResponse	true
method?	FetchMethod
payload?	Record<string, any>

Returns

Promise<any>

Inherited from

BaseAPI.fetch

Defined in

lib/common/BaseAPI.ts:21

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

Parameters

Name	Type
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

Name	Type
target?	string | number | ImageFormat
fallbackId?	number

Returns

Promise<null | ImageFormat>

Defined in

lib/image/ImageAPI.ts:27

---

getFormats

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

Parameters

Name	Type
filter?	ImageFormatFilter

Returns

Promise<ImageFormat[]>

Defined in

lib/image/ImageAPI.ts:47