bandcamp-fetch/docs/api/classes/FanAPI.md
patrickkfkan be7010c217 v1.0.0
2023-06-10 22:52:27 +08:00

4.1 KiB

bandcamp-fetch / FanAPI

Class: FanAPI

Hierarchy

Table of contents

Constructors

Methods

Constructors

constructor

new FanAPI()

Methods

getCollection

Static 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:52


getFollowingArtistsAndLabels

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

Parameters

Name Type
params FanAPIGetItemsParams

Returns

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

Defined in

lib/fan/FanAPI.ts:72


getFollowingGenres

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

Parameters

Name Type
params FanAPIGetItemsParams

Returns

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

Defined in

lib/fan/FanAPI.ts:82


getInfo

Static getInfo(params): Promise<Fan>

Parameters

Name Type
params FanAPIGetInfoParams

Returns

Promise<Fan>

Defined in

lib/fan/FanAPI.ts:41


getWishlist

Static 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:62