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

bandcamp-fetch / SearchAPI

Class: SearchAPI

Hierarchy

• SearchAPI

  ↳ LimiterSearchAPI

Table of contents

Constructors

• constructor

Methods

• albums
• all
• artistsAndLabels
• fans
• search
• tracks

Constructors

constructor

• new SearchAPI()

Methods

albums

▸ Static albums(params): Promise<SearchResults<SearchResultAlbum>>

Parameters

Name	Type
params	SearchAPISearchParams

Returns

Promise<SearchResults<SearchResultAlbum>>

Defined in

lib/search/SearchAPI.ts:35

---

all

▸ Static all(params): Promise<SearchResults<SearchResultAny>>

Parameters

Name	Type
params	SearchAPISearchParams

Returns

Promise<SearchResults<SearchResultAny>>

Defined in

lib/search/SearchAPI.ts:27

---

artistsAndLabels

▸ Static artistsAndLabels(params): Promise<SearchResults<SearchResultArtist | SearchResultLabel>>

Parameters

Name	Type
params	SearchAPISearchParams

Returns

Promise<SearchResults<SearchResultArtist | SearchResultLabel>>

Defined in

lib/search/SearchAPI.ts:31

---

fans

▸ Static fans(params): Promise<SearchResults<SearchResultFan>>

Parameters

Name	Type
params	SearchAPISearchParams

Returns

Promise<SearchResults<SearchResultFan>>

Defined in

lib/search/SearchAPI.ts:43

---

search

▸ Static Protected search(params): Promise<SearchResults<SearchResultAlbum>>

Parameters

Name	Type
params	SearchAPISearchParams & { itemType: Albums }

Returns

Promise<SearchResults<SearchResultAlbum>>

Defined in

lib/search/SearchAPI.ts:51

▸ Static Protected search(params): Promise<SearchResults<SearchResultTrack>>

Parameters

Name	Type
params	SearchAPISearchParams & { itemType: Tracks }

Returns

Promise<SearchResults<SearchResultTrack>>

Defined in

lib/search/SearchAPI.ts:52

▸ Static Protected search(params): Promise<SearchResults<SearchResultFan>>

Parameters

Name	Type
params	SearchAPISearchParams & { itemType: Fans }

Returns

Promise<SearchResults<SearchResultFan>>

Defined in

lib/search/SearchAPI.ts:53

▸ Static Protected search(params): Promise<SearchResults<SearchResultAny>>

Parameters

Name	Type
params	SearchAPISearchParams & { itemType: All }

Returns

Promise<SearchResults<SearchResultAny>>

Defined in

lib/search/SearchAPI.ts:54

---

tracks

▸ Static tracks(params): Promise<SearchResults<SearchResultTrack>>

Parameters

Name	Type
params	SearchAPISearchParams

Returns

Promise<SearchResults<SearchResultTrack>>

Defined in

lib/search/SearchAPI.ts:39