Skip to content

Latest commit

 

History

History
257 lines (129 loc) · 7.66 KB

FanAPI.md

File metadata and controls

257 lines (129 loc) · 7.66 KB

bandcamp-fetch • Docs

bandcamp-fetch / FanAPI

Class: FanAPI

Extends

Extended by

Constructors

new FanAPI()

new FanAPI(params): FanAPI

Parameters

• params: BaseAPIWithImageSupportParams

Returns

FanAPI

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

getCollection()

getCollection(params): Promise<FanPageItemsResult<NonNullable<null | Track | Album>> | FanContinuationItemsResult<NonNullable<null | Track | Album>>>

Parameters

• params: FanAPIGetItemsParams

Returns

Promise<FanPageItemsResult<NonNullable<null | Track | Album>> | FanContinuationItemsResult<NonNullable<null | Track | Album>>>

Defined in

lib/fan/FanAPI.ts:60

getFollowingArtistsAndLabels()

getFollowingArtistsAndLabels(params): Promise<FanPageItemsResult<UserKind> | FanContinuationItemsResult<UserKind>>

Parameters

• params: FanAPIGetItemsParams

Returns

Promise<FanPageItemsResult<UserKind> | FanContinuationItemsResult<UserKind>>

Defined in

lib/fan/FanAPI.ts:80

getFollowingGenres()

getFollowingGenres(params): Promise<FanPageItemsResult<Tag> | FanContinuationItemsResult<Tag>>

Parameters

• params: FanAPIGetItemsParams

Returns

Promise<FanPageItemsResult<Tag> | FanContinuationItemsResult<Tag>>

Defined in

lib/fan/FanAPI.ts:90

getInfo()

getInfo(params): Promise<Fan>

Parameters

• params: FanAPIGetInfoParams

Returns

Promise<Fan>

Defined in

lib/fan/FanAPI.ts:42

getWishlist()

getWishlist(params): Promise<FanPageItemsResult<NonNullable<null | Track | Album>> | FanContinuationItemsResult<NonNullable<null | Track | Album>>>

Parameters

• params: FanAPIGetItemsParams

Returns

Promise<FanPageItemsResult<NonNullable<null | Track | Album>> | FanContinuationItemsResult<NonNullable<null | Track | Album>>>

Defined in

lib/fan/FanAPI.ts:70