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

bandcamp-fetch / LimiterAlbumAPI

Class: LimiterAlbumAPI

Hierarchy

• AlbumAPI

  ↳ LimiterAlbumAPI

Table of contents

Constructors

• constructor

Accessors

• cache
• imageAPI

Methods

• fetch
• getInfo

Constructors

constructor

• new LimiterAlbumAPI(params)

Parameters

Name	Type
params	BaseAPIWithImageSupportParams & { limiter: Limiter }

Overrides

AlbumAPI.constructor

Defined in

lib/album/AlbumAPI.ts:33

Accessors

cache

• Protected get cache(): Cache

Returns

Cache

Inherited from

AlbumAPI.cache

Defined in

lib/common/BaseAPI.ts:27

---

imageAPI

• get imageAPI(): ImageAPI

Returns

ImageAPI

Inherited from

AlbumAPI.imageAPI

Defined in

lib/common/BaseAPIWithImageSupport.ts:17

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

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

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

AlbumAPI.fetch

Defined in

lib/common/BaseAPI.ts:22

---

getInfo

▸ getInfo(params): Promise<Album>

Parameters

Name	Type
params	AlbumAPIGetInfoParams

Returns

Promise<Album>

Overrides

AlbumAPI.getInfo

Defined in

lib/album/AlbumAPI.ts:38