twitcheasy-twitch-bottwitch-authtwitch-auth-tmitwitch-chat-clienttwitch-eventsubtwitch-pubsub-clienttwitch-webhooks
Welcome

Basic usage

Getting startedListening to events

Special hosting

Serving through a reverse proxyTesting locally using ngrok

Classes

ConnectionAdapterDirectConnectionAdapterEnvPortAdapterEventSubChannelBanEventEventSubChannelCheerEventEventSubChannelFollowEventEventSubChannelHypeTrainBeginEventEventSubChannelHypeTrainEndEventEventSubChannelHypeTrainProgressEventEventSubChannelModeratorEventEventSubChannelPollBeginChoiceEventSubChannelPollBeginEventEventSubChannelPollChoiceEventSubChannelPollEndEventEventSubChannelPollProgressEventEventSubChannelPredictionBeginEventEventSubChannelPredictionBeginOutcomeEventSubChannelPredictionEndEventEventSubChannelPredictionLockEventEventSubChannelPredictionOutcomeEventSubChannelPredictionPredictorEventSubChannelPredictionProgressEventEventSubChannelRaidEventEventSubChannelRedemptionAddEventEventSubChannelRedemptionUpdateEventEventSubChannelRewardEventEventSubChannelSubscriptionEndEventEventSubChannelSubscriptionEventEventSubChannelSubscriptionGiftEventEventSubChannelSubscriptionMessageEventEventSubChannelUnbanEventEventSubChannelUpdateEventEventSubExtensionBitsTransactionCreateEventEventSubListenerEventSubMiddlewareEventSubStreamOfflineEventEventSubStreamOnlineEventEventSubSubscriptionEventSubUserAuthorizationRevokeEventEventSubUserUpdateEventMiddlewareAdapterReverseProxyAdapter

Interfaces

ConnectCompatibleAppDirectConnectionAdapterConfigEnvPortAdapterConfigEventSubConfigEventSubListenerCertificateConfigEventSubMiddlewareConfigMiddlewareAdapterConfigReverseProxyAdapterConfig

EventSubChannelSubscriptionMessageEvent

An EventSub event representing the public announcement of a channel subscription by the subscriber.

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.

cumulativeMonths

Type: number

The total number of months the user has been subscribed.

durationMonths

Type: number

The number of months the user has now subscribed.

messageText

Type: string

The text of the message.

streakMonths

Type: number | null

The number of months the user has been subscribed in a row, or null if they don't want to share it.

tier

Type:
EventSubChannelSubscriptionMessageEventTier

The tier of a subscription. 1000 means tier 1, and so on.

Aliased type: "1000" | "2000" | "3000"

The tier of the subscription, either 1000, 2000 or 3000.

userDisplayName

Type: string

The display name of the user whose subscription is being announced.

userId

Type: string

The ID of the user whose subscription is being announced.

userName

Type: string

The name of the user whose subscription is being announced.

Methods

getBroadcaster()

async

Retrieves more information about the broadcaster.

Return type: HelixUser

getUser()

async

Retrieves more information about the user whose subscription is being announced.

Return type: HelixUser