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

ConnectionAdapterEnvPortAdapterLegacyAdapterReverseProxyAdapterSimpleAdapterSubscriptionWebHookListener

Interfaces

ConnectCompatibleAppConnectionAdapterOverrideOptionsEnvPortAdapterConfigReverseProxyAdapterConfigSimpleAdapterConfigWebHookConfigWebHookListenerCertificateConfigWebHookListenerConfigWebHookListenerReverseProxyConfig

SimpleAdapterConfig

The configuration of the simple connection adapter.

{
The host name the server is available under.
hostName: string
The port the server should listen to.
listenerPort: number
The SSL keychain that should be used to make the server available using a secure connection.
}

Properties

hostName

Type: string

The host name the server is available under.

listenerPort

Type: number

The port the server should listen to.

sslCert

Type: ?WebHookListenerCertificateConfig

The SSL keychain that should be used to make the server available using a secure connection.

If this is not given and there is no reverse proxy that handles incoming SSL connections, the server will only be available via HTTP. This means it can only listen to unauthenticated topics (stream changes and follows).