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

bandcamp-fetch / BandAPI

Class: BandAPI

Hierarchy

• BaseAPIWithImageSupport

  ↳ BandAPI

  ↳↳ LimiterBandAPI

Table of contents

Constructors

• constructor

Accessors

• cache
• imageAPI

Methods

• fetch
• getDiscography
• getInfo
• getLabelArtists

Constructors

constructor

• new BandAPI(params)

Parameters

Name	Type
params	BaseAPIWithImageSupportParams

Inherited from

BaseAPIWithImageSupport.constructor

Defined in

lib/common/BaseAPIWithImageSupport.ts:12

Accessors

cache

• Protected get cache(): Cache

Returns

Cache

Inherited from

BaseAPIWithImageSupport.cache

Defined in

lib/common/BaseAPI.ts:27

---

imageAPI

• get imageAPI(): ImageAPI

Returns

ImageAPI

Inherited from

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

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

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

BaseAPIWithImageSupport.fetch

Defined in

lib/common/BaseAPI.ts:22

---

getDiscography

▸ getDiscography(params): Promise<(Track | Album)[]>

Parameters

Name	Type
params	BandAPIGetDiscographyParams

Returns

Promise<(Track | Album)[]>

Defined in

lib/band/BandAPI.ts:31

---

getInfo

▸ getInfo(params): Promise<Label | Artist>

Parameters

Name	Type
params	BandAPIGetInfoParams

Returns

Promise<Label | Artist>

Defined in

lib/band/BandAPI.ts:42

---

getLabelArtists

▸ getLabelArtists(params): Promise<LabelArtist[]>

Parameters

Name	Type
params	BandAPIGetLabelArtistsParams

Returns

Promise<LabelArtist[]>

Defined in

lib/band/BandAPI.ts:85