Overview
Can be accessed using client.hypeTrain on an ApiClient instance.
Example
const api = new ApiClient({ authProvider });
const { data: events } = await api.hypeTrain.getHypeTrainEventsForBroadcaster('125328655');
Methods
getHypeTrainEventsForBroadcaster(broadcaster, pagination)
asyncGets the events of the current or latest Hype Train for the specified broadcaster.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| broadcaster | UserIdResolvable A user ID or a user or channel object. This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name. Aliased type: string | number | UserIdResolvableType | none | The broadcaster to fetch Hype Train events for. | |
| 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. |
getHypeTrainEventsForBroadcasterPaginated(broadcaster)
Creates a paginator for the events of the current or latest Hype Train for the specified broadcaster.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| broadcaster | UserIdResolvable A user ID or a user or channel object. This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name. Aliased type: string | number | UserIdResolvableType | none | The broadcaster to fetch Hype Train events for. |