Class WebhookTransport

constructor

• new WebhookTransport(__namedParameters): WebhookTransport

• Parameters

  • __namedParameters: Omit<IUpdatesOptions, "upload">

  Returns WebhookTransport

started

webhookHandler

getKoaWebhookMiddleware

• getKoaWebhookMiddleware(): WebhookTransportKoaCallback

• Returns the middleware for the webhook under koa

  Returns WebhookTransportKoaCallback

getWebhookCallback

• getWebhookCallback(path?): WebhookTransportCallback

• Returns webhook callback like http[s] or express

  Parameters

  • Optional path: string

  Returns WebhookTransportCallback

start

• start(__namedParameters?): Promise<void>

• Starts the webhook server

  Parameters

  • __namedParameters: IWebhookTransportStartOptions = {}

  Returns Promise<void>

stop

• stop(): Promise<void>

• Stopping gets updates

  Returns Promise<void>

subscribe

• subscribe(handler): void

• Parameters

  • handler: ((update) => unknown)

    • • (update): unknown

      • Parameters

        • update: object

        Returns unknown

  Returns void