twitch easy-twitch-bot twitch-auth twitch-auth-tmi twitch-chat-client twitch-eventsub twitch-pubsub-client twitch-webhooks

Basic usage

Getting started Listening to events

Special hosting

Serving through a reverse proxy Testing locally using ngrok

Classes

ConnectionAdapter DirectConnectionAdapter EnvPortAdapter EventSubChannelBanEvent EventSubChannelCheerEvent EventSubChannelFollowEvent EventSubChannelHypeTrainBeginEvent EventSubChannelHypeTrainEndEvent EventSubChannelHypeTrainProgressEvent EventSubChannelModeratorEvent EventSubChannelPollBeginChoice EventSubChannelPollBeginEvent EventSubChannelPollChoice EventSubChannelPollEndEvent EventSubChannelPollProgressEvent EventSubChannelPredictionBeginEvent EventSubChannelPredictionBeginOutcome EventSubChannelPredictionEndEvent EventSubChannelPredictionLockEvent EventSubChannelPredictionOutcome EventSubChannelPredictionPredictor EventSubChannelPredictionProgressEvent EventSubChannelRaidEvent EventSubChannelRedemptionAddEvent EventSubChannelRedemptionUpdateEvent EventSubChannelRewardEvent EventSubChannelSubscriptionEndEvent EventSubChannelSubscriptionEvent EventSubChannelSubscriptionGiftEvent EventSubChannelSubscriptionMessageEvent EventSubChannelUnbanEvent EventSubChannelUpdateEvent EventSubExtensionBitsTransactionCreateEvent EventSubListener EventSubMiddleware EventSubStreamOfflineEvent EventSubStreamOnlineEvent EventSubSubscription EventSubUserAuthorizationRevokeEvent EventSubUserUpdateEvent MiddlewareAdapter ReverseProxyAdapter

Interfaces

ConnectCompatibleApp DirectConnectionAdapterConfig EnvPortAdapterConfig EventSubConfig EventSubListenerCertificateConfig EventSubMiddlewareConfig MiddlewareAdapterConfig ReverseProxyAdapterConfig

EventSubStreamOnlineEvent

An EventSub event representing a stream going live.

Overview

Properties

Methods

Properties

broadcasterDisplayName

Type: string

The display name of the broadcaster.

broadcasterId

Type: string

The ID of the broadcaster.

broadcasterName

Type: string

The name of the broadcaster.

startDate

Type: Date

The date and time when the stream was started.

streamType

Type:
EventSubStreamOnlineEventStreamType
Aliased type: "live" | "playlist" | "watch_party" | "premiere" | "rerun"

The type of the stream going live.

Methods

getBroadcaster()

Retrieves more information about the broadcaster.

Return type: HelixUser

getStream()

Retrieves more information about the stream.

Return type: HelixStream