Skip to content

Latest commit

 

History

History
221 lines (111 loc) · 5.14 KB

BandAPI.md

File metadata and controls

221 lines (111 loc) · 5.14 KB

bandcamp-fetch • Docs

bandcamp-fetch / BandAPI

Class: BandAPI

Extends

Extended by

Constructors

new BandAPI()

new BandAPI(params): BandAPI

Parameters

• params: BaseAPIWithImageSupportParams

Returns

BandAPI

Inherited from

BaseAPIWithImageSupport.constructor

Defined in

lib/common/BaseAPIWithImageSupport.ts:12

Accessors

cache

Get Signature

get protected cache(): Cache

Returns

Cache

Inherited from

BaseAPIWithImageSupport.cache

Defined in

lib/common/BaseAPI.ts:27

imageAPI

Get Signature

get imageAPI(): ImageAPI

Returns

ImageAPI

Inherited from

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

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

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

BaseAPIWithImageSupport.fetch

Defined in

lib/common/BaseAPI.ts:22

getDiscography()

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

Parameters

• params: BandAPIGetDiscographyParams

Returns

Promise<(Track | Album)[]>

Defined in

lib/band/BandAPI.ts:32

getInfo()

getInfo(params): Promise<Label | Artist>

Parameters

• params: BandAPIGetInfoParams

Returns

Promise<Label | Artist>

Defined in

lib/band/BandAPI.ts:43

getLabelArtists()

getLabelArtists(params): Promise<LabelArtist[]>

Parameters

• params: BandAPIGetLabelArtistsParams

Returns

Promise<LabelArtist[]>

Defined in

lib/band/BandAPI.ts:86