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

bandcamp-fetch / FanAPI

Class: FanAPI

Hierarchy

• BaseAPIWithImageSupport

  ↳ FanAPI

  ↳↳ LimiterFanAPI

Table of contents

Constructors

• constructor

Accessors

• cache
• imageAPI

Methods

• fetch
• getCollection
• getFollowingArtistsAndLabels
• getFollowingGenres
• getInfo
• getWishlist

Constructors

constructor

• new FanAPI(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

---

getCollection

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

Parameters

Name	Type
params	FanAPIGetItemsParams

Returns

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

Defined in

lib/fan/FanAPI.ts:59

---

getFollowingArtistsAndLabels

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

Parameters

Name	Type
params	FanAPIGetItemsParams

Returns

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

Defined in

lib/fan/FanAPI.ts:79

---

getFollowingGenres

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

Parameters

Name	Type
params	FanAPIGetItemsParams

Returns

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

Defined in

lib/fan/FanAPI.ts:89

---

getInfo

▸ getInfo(params): Promise<Fan>

Parameters

Name	Type
params	FanAPIGetInfoParams

Returns

Promise<Fan>

Defined in

lib/fan/FanAPI.ts:41

---

getWishlist

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

Parameters

Name	Type
params	FanAPIGetItemsParams

Returns

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

Defined in

lib/fan/FanAPI.ts:69