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

EventSubUserUpdateEvent

An EventSub event representing updating their account details.

Overview

Properties

Methods

getUsera

Properties

userDescription

Type: string

The user's profile description.

userDisplayName

Type: string

The display name of the user.

userEmail

Type: string | null

The user's email address.

This is null if you are not authorized to read the email address, i.e. you have never successfully requested the scope user:read:email from the user.

userId

Type: string

The ID of the user.

userName

Type: string

The name of the user.

Methods

getUser()

Retrieves more information about the user.

Return type: HelixUser