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

ConnectionAdapterDirectConnectionAdapterEnvPortAdapterEventSubChannelBanEventEventSubChannelCheerEventEventSubChannelFollowEventEventSubChannelHypeTrainBeginEventEventSubChannelHypeTrainEndEventEventSubChannelHypeTrainProgressEventEventSubChannelRaidEventEventSubChannelRedemptionAddEventEventSubChannelRedemptionUpdateEventEventSubChannelRewardEventEventSubChannelSubscriptionEventEventSubChannelUnbanEventEventSubChannelUpdateEventEventSubListenerEventSubStreamOfflineEventEventSubStreamOnlineEventEventSubSubscriptionEventSubUserAuthorizationRevokeEventEventSubUserUpdateEventMiddlewareAdapterReverseProxyAdapter

Interfaces

ConnectCompatibleAppDirectConnectionAdapterConfigEnvPortAdapterConfigEventSubConfigEventSubListenerCertificateConfigMiddlewareAdapterConfigReverseProxyAdapterConfig

EventSubSubscription<T>

Overview

Properties

Methods

Properties

verified

Type: boolean

Whether the subscription has been verified by Twitch.

Methods

start(resumeFrom)

async

Activates the subscription.

Parameter Type Required Default Description
resumeFrom HelixEventSubSubscription none none
Return type: void

stop()

async

Deactivates the subscription and removes it from the listener.

Return type: void

suspend()

async

Suspends the subscription, not removing it from the listener.

Return type: void