Skip to content

Latest commit

 

History

History
185 lines (93 loc) · 3.85 KB

LimiterAlbumAPI.md

File metadata and controls

185 lines (93 loc) · 3.85 KB

bandcamp-fetch • Docs

bandcamp-fetch / LimiterAlbumAPI

Class: LimiterAlbumAPI

Extends

Constructors

new LimiterAlbumAPI()

new LimiterAlbumAPI(params): LimiterAlbumAPI

Parameters

• params: BaseAPIWithImageSupportParams & object

Returns

LimiterAlbumAPI

Overrides

AlbumAPI.constructor

Defined in

lib/album/AlbumAPI.ts:33

Accessors

cache

Get Signature

get protected cache(): Cache

Returns

Cache

Inherited from

AlbumAPI.cache

Defined in

lib/common/BaseAPI.ts:27

imageAPI

Get Signature

get imageAPI(): ImageAPI

Returns

ImageAPI

Inherited from

AlbumAPI.imageAPI

Defined in

lib/common/BaseAPIWithImageSupport.ts:17

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

AlbumAPI.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

AlbumAPI.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

AlbumAPI.fetch

Defined in

lib/common/BaseAPI.ts:22

getInfo()

getInfo(params): Promise<Album>

Parameters

• params: AlbumAPIGetInfoParams

Returns

Promise<Album>

Overrides

AlbumAPI.getInfo

Defined in

lib/album/AlbumAPI.ts:38