bandcamp-fetch/docs/api/classes/AutocompleteAPI.md
2023-06-14 04:09:54 +08:00

78 lines
2.2 KiB
Markdown

[bandcamp-fetch](../README.md) / AutocompleteAPI
# Class: AutocompleteAPI
## Hierarchy
- **`AutocompleteAPI`**
↳ [`LimiterAutocompleteAPI`](LimiterAutocompleteAPI.md)
## Table of contents
### Constructors
- [constructor](AutocompleteAPI.md#constructor)
### Methods
- [getSuggestions](AutocompleteAPI.md#getsuggestions)
## Constructors
### constructor
**new AutocompleteAPI**()
## Methods
### getSuggestions
`Static` **getSuggestions**(`params`): `Promise`<[`AutocompleteLocation`](../interfaces/AutocompleteLocation.md)[]\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `params` | [`AutocompleteAPIGetSuggestionsParams`](../interfaces/AutocompleteAPIGetSuggestionsParams.md) & { `itemType`: [`Location`](../enums/AutocompleteItemType.md#location) } |
#### Returns
`Promise`<[`AutocompleteLocation`](../interfaces/AutocompleteLocation.md)[]\>
#### Defined in
[lib/autocomplete/AutocompleteAPI.ts:20](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/autocomplete/AutocompleteAPI.ts#L20)
`Static` **getSuggestions**(`params`): `Promise`<[`AutoCompleteTag`](../interfaces/AutoCompleteTag.md)[]\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `params` | [`AutocompleteAPIGetSuggestionsParams`](../interfaces/AutocompleteAPIGetSuggestionsParams.md) & { `itemType`: [`Tag`](../enums/AutocompleteItemType.md#tag) } |
#### Returns
`Promise`<[`AutoCompleteTag`](../interfaces/AutoCompleteTag.md)[]\>
#### Defined in
[lib/autocomplete/AutocompleteAPI.ts:21](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/autocomplete/AutocompleteAPI.ts#L21)
`Static` **getSuggestions**(`params`): `Promise`<[`AutoCompleteTag`](../interfaces/AutoCompleteTag.md)[] \| [`AutocompleteLocation`](../interfaces/AutocompleteLocation.md)[]\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `params` | [`AutocompleteAPIGetSuggestionsParams`](../interfaces/AutocompleteAPIGetSuggestionsParams.md) |
#### Returns
`Promise`<[`AutoCompleteTag`](../interfaces/AutoCompleteTag.md)[] \| [`AutocompleteLocation`](../interfaces/AutocompleteLocation.md)[]\>
#### Defined in
[lib/autocomplete/AutocompleteAPI.ts:22](https://github.com/patrickkfkan/bandcamp-fetch/blob/eace49c/src/lib/autocomplete/AutocompleteAPI.ts#L22)