UNPKG

@twurple/eventsub-ngrok

Version:

Test your EventSub listener locally using ngrok.

37 lines 1.01 kB
import { type Config as NgrokConfig } from '@ngrok/ngrok'; import { ConnectionAdapter } from '@twurple/eventsub-http'; /** * The configuration of the ngrok adapter. */ export interface NgrokAdapterConfig { /** * The port to listen on. Defaults to 8000. */ port?: number; /** * Configuration options to pass to the ngrok client constructor. * * Note that the `addr` option is not supported. */ ngrokConfig?: Omit<NgrokConfig, 'addr'>; } /** * A connection adapter that uses ngrok to make local testing easy. */ export declare class NgrokAdapter extends ConnectionAdapter { /** * Creates a new instance of the `NgrokAdapter`. * * @expandParams * * @param config */ constructor(config?: NgrokAdapterConfig); /** @protected */ get connectUsingSsl(): boolean; /** @protected */ get listenerPort(): number; /** @protected */ getHostName(): Promise<string>; } //# sourceMappingURL=NgrokAdapter.d.ts.map