@twurple/eventsub-http
Version:
Listen to events on Twitch via their EventSub API using a HTTP/WebHook server.
52 lines • 1.56 kB
TypeScript
/// <reference types="node" />
import * as http from 'http';
/**
* An abstraction of a WebHook connection adapter.
*/
export declare abstract class ConnectionAdapter {
/**
* Creates the HTTP server to use for listening to events.
*
* @protected
*/
createHttpServer(): http.Server;
/**
* Whether the connection adapter listens using SSL.
*
* @protected
*/
get listenUsingSsl(): boolean;
/**
* The port the HTTP server should listen on.
*
* If not given, the listener will default to use port 443.
*
* @protected
*/
get listenerPort(): number | undefined;
/**
* Returns the host name that should be used by Twitch to connect to this server.
*
* @protected
*/
abstract getHostName(): Promise<string>;
/**
* The path prefix an external connection needs to reach this server.
*
* @protected
*/
get pathPrefix(): string | undefined;
/**
* Whether the path prefix is passed to the handler.
*
* Defaults to `false` which means that the layer redirecting to this server needs to strip the path prefix in order for it to work.
*
* For example, if the path prefix is set to /hooks, an external connection to /hooks/abc should pass /abc as the path to this server.
*
* Conversely, if this is set to `true`, the path should be passed as is (i.e. /hooks/abc).
*
* @protected
*/
get usePathPrefixInHandlers(): boolean;
}
//# sourceMappingURL=ConnectionAdapter.d.ts.map