Overview
Can be accessed using client.search on an ApiClient instance.
Example
const api = new ApiClient({ authProvider }); const channels = await api.search.searchChannels('pear');
Methods
searchCategories(query, pagination)
asyncSearch categories/games for an exact or partial match.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| query | string | none | The search term. | |
| pagination | HelixForwardPagination | none | see below | |
| pagination.after | string | none | A cursor to get the following page of. | |
| pagination.limit | number | none | The number of results per page. |
Return type: HelixPaginatedResult<HelixGame>
searchCategoriesPaginated(query)
Creates a paginator for a category/game search.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| query | string | none | The search term. |
Return type: HelixPaginatedRequest<HelixGameData, HelixGame>
searchChannels(query, filter)
asyncSearch channels for an exact or partial match.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| query | string | none | The search term. | |
| filter | HelixPaginatedChannelSearchFilter | <complex> | see below | |
| filter.after | string | none | A cursor to get the following page of. | |
| filter.limit | number | none | The number of results per page. | |
| filter.liveOnly | boolean | none | Include only channels that are currently live. |
Return type: HelixPaginatedResult<HelixChannelSearchResult>
searchChannelsPaginated(query, filter)
Creates a paginator for a channel search.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| query | string | none | The search term. | |
| filter | HelixChannelSearchFilter | <complex> | see below | |
| filter.liveOnly | boolean | none | Include only channels that are currently live. |
Return type: HelixPaginatedRequest<HelixChannelSearchResultData, HelixChannelSearchResult>