Skip to content

Latest commit

 

History

History
325 lines (163 loc) · 9.03 KB

SearchAPI.md

File metadata and controls

325 lines (163 loc) · 9.03 KB

bandcamp-fetch • Docs

bandcamp-fetch / SearchAPI

Class: SearchAPI

Extends

Extended by

Constructors

new SearchAPI()

new SearchAPI(params): SearchAPI

Parameters

• params: BaseAPIWithImageSupportParams

Returns

SearchAPI

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

albums()

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

Parameters

• params: SearchAPISearchParams

Returns

Promise<SearchResults<SearchResultAlbum>>

Defined in

lib/search/SearchAPI.ts:34

all()

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

Parameters

• params: SearchAPISearchParams

Returns

Promise<SearchResults<SearchResultAny>>

Defined in

lib/search/SearchAPI.ts:26

artistsAndLabels()

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

Parameters

• params: SearchAPISearchParams

Returns

Promise<SearchResults<SearchResultArtist | SearchResultLabel>>

Defined in

lib/search/SearchAPI.ts:30

fans()

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

Parameters

• params: SearchAPISearchParams

Returns

Promise<SearchResults<SearchResultFan>>

Defined in

lib/search/SearchAPI.ts:42

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

search()

search(params)

protected search(params): Promise<SearchResults<SearchResultAlbum>>

Parameters

• params: SearchAPISearchParams & object

Returns

Promise<SearchResults<SearchResultAlbum>>

Defined in

lib/search/SearchAPI.ts:50

search(params)

protected search(params): Promise<SearchResults<SearchResultTrack>>

Parameters

• params: SearchAPISearchParams & object

Returns

Promise<SearchResults<SearchResultTrack>>

Defined in

lib/search/SearchAPI.ts:51

search(params)

protected search(params): Promise<SearchResults<SearchResultFan>>

Parameters

• params: SearchAPISearchParams & object

Returns

Promise<SearchResults<SearchResultFan>>

Defined in

lib/search/SearchAPI.ts:52

search(params)

protected search(params): Promise<SearchResults<SearchResultAny>>

Parameters

• params: SearchAPISearchParams & object

Returns

Promise<SearchResults<SearchResultAny>>

Defined in

lib/search/SearchAPI.ts:53

tracks()

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

Parameters

• params: SearchAPISearchParams

Returns

Promise<SearchResults<SearchResultTrack>>

Defined in

lib/search/SearchAPI.ts:38