Skip to content

Latest commit

 

History

History
199 lines (100 loc) · 4.77 KB

AutocompleteAPI.md

File metadata and controls

199 lines (100 loc) · 4.77 KB

bandcamp-fetch • Docs

bandcamp-fetch / AutocompleteAPI

Class: AutocompleteAPI

Extends

Extended by

Constructors

new AutocompleteAPI()

new AutocompleteAPI(params): AutocompleteAPI

Parameters

• params: BaseAPIParams

Returns

AutocompleteAPI

Inherited from

BaseAPI.constructor

Defined in

lib/common/BaseAPI.ts:15

Accessors

cache

Get Signature

get protected cache(): Cache

Returns

Cache

Inherited from

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

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

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

BaseAPI.fetch

Defined in

lib/common/BaseAPI.ts:22

getSuggestions()

getSuggestions(params)

getSuggestions(params): Promise<AutocompleteLocation[]>

Parameters

• params: AutocompleteAPIGetSuggestionsParams & object

Returns

Promise<AutocompleteLocation[]>

Defined in

lib/autocomplete/AutocompleteAPI.ts:24

getSuggestions(params)

getSuggestions(params): Promise<AutoCompleteTag[]>

Parameters

• params: AutocompleteAPIGetSuggestionsParams & object

Returns

Promise<AutoCompleteTag[]>

Defined in

lib/autocomplete/AutocompleteAPI.ts:25

getSuggestions(params)

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

Parameters

• params: AutocompleteAPIGetSuggestionsParams

Returns

Promise<AutoCompleteTag[] | AutocompleteLocation[]>

Defined in

lib/autocomplete/AutocompleteAPI.ts:26