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

bandcamp-fetch / AutocompleteAPI

Class: AutocompleteAPI

Hierarchy

• BaseAPI

  ↳ AutocompleteAPI

  ↳↳ LimiterAutocompleteAPI

Table of contents

Constructors

• constructor

Accessors

• cache

Methods

• fetch
• getSuggestions

Constructors

constructor

• new AutocompleteAPI(params)

Parameters

Name	Type
params	BaseAPIParams

Inherited from

BaseAPI.constructor

Defined in

lib/common/BaseAPI.ts:15

Accessors

cache

• Protected get cache(): Cache

Returns

Cache

Inherited from

BaseAPI.cache

Defined in

lib/common/BaseAPI.ts:27

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

BaseAPI.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

BaseAPI.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

BaseAPI.fetch

Defined in

lib/common/BaseAPI.ts:22

---

getSuggestions

▸ getSuggestions(params): Promise<AutocompleteLocation[]>

Parameters

Name	Type
params	AutocompleteAPIGetSuggestionsParams & { itemType: Location }

Returns

Promise<AutocompleteLocation[]>

Defined in

lib/autocomplete/AutocompleteAPI.ts:21

▸ getSuggestions(params): Promise<AutoCompleteTag[]>

Parameters

Name	Type
params	AutocompleteAPIGetSuggestionsParams & { itemType: Tag }

Returns

Promise<AutoCompleteTag[]>

Defined in

lib/autocomplete/AutocompleteAPI.ts:22

▸ getSuggestions(params): Promise<AutoCompleteTag[] | AutocompleteLocation[]>

Parameters

Name	Type
params	AutocompleteAPIGetSuggestionsParams

Returns

Promise<AutoCompleteTag[] | AutocompleteLocation[]>

Defined in

lib/autocomplete/AutocompleteAPI.ts:23