Skip to content

Latest commit

 

History

History
207 lines (104 loc) · 5.25 KB

LimiterAutocompleteAPI.md

File metadata and controls

207 lines (104 loc) · 5.25 KB

bandcamp-fetch • Docs

bandcamp-fetch / LimiterAutocompleteAPI

Class: LimiterAutocompleteAPI

Extends

Constructors

new LimiterAutocompleteAPI()

new LimiterAutocompleteAPI(params): LimiterAutocompleteAPI

Parameters

• params: BaseAPIParams & object

Returns

LimiterAutocompleteAPI

Overrides

AutocompleteAPI.constructor

Defined in

lib/autocomplete/AutocompleteAPI.ts:66

Accessors

cache

Get Signature

get protected cache(): Cache

Returns

Cache

Inherited from

AutocompleteAPI.cache

Defined in

lib/common/BaseAPI.ts:27

Methods

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

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

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

AutocompleteAPI.fetch

Defined in

lib/common/BaseAPI.ts:22

getSuggestions()

getSuggestions(params)

getSuggestions(params): Promise<AutocompleteLocation[]>

Parameters

• params: AutocompleteAPIGetSuggestionsParams & object

Returns

Promise<AutocompleteLocation[]>

Overrides

AutocompleteAPI.getSuggestions

Defined in

lib/autocomplete/AutocompleteAPI.ts:71

getSuggestions(params)

getSuggestions(params): Promise<AutoCompleteTag[]>

Parameters

• params: AutocompleteAPIGetSuggestionsParams & object

Returns

Promise<AutoCompleteTag[]>

Overrides

AutocompleteAPI.getSuggestions

Defined in

lib/autocomplete/AutocompleteAPI.ts:72

getSuggestions(params)

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

Parameters

• params: AutocompleteAPIGetSuggestionsParams

Returns

Promise<AutoCompleteTag[] | AutocompleteLocation[]>

Overrides

AutocompleteAPI.getSuggestions

Defined in

lib/autocomplete/AutocompleteAPI.ts:73