Class WebhookClient

constructor

• new WebhookClient(client: TelegramClient): WebhookClient

  Creates an instance of WebhookClient.

  Parameters

  • client: TelegramClient

    The Telegram client instance.

  Returns WebhookClient

Readonlyclient

isClosed

offset

webhookFilter

webhookServer

close

• close(): Promise<boolean>

  Closes the webhook server.

  Returns Promise<boolean>

  The closed state of the webhook client.

createWebhookCallback

• createWebhookCallback(
      requestCallback?: RequestListener,
      options?: { path?: string; secretToken?: string },
  ): Promise<
      | RequestListener
      | (
          (
              request: IncomingMessage & { body?: Update },
              response: ServerResponse,
          ) => void
      ),
  >

  Creates a callback function for handling webhook requests.

  Parameters

  • OptionalrequestCallback: RequestListener

    The callback function to handle requests.

  • Optionaloptions: { path?: string; secretToken?: string }

    The options for creating the webhook callback.

  Returns Promise<
      | RequestListener
      | (
          (
              request: IncomingMessage & { body?: Update },
              response: ServerResponse,
          ) => void
      ),
  >

  The created callback function.

startWebhook

• startWebhook(
      path?: string,
      secretToken?: string,
      options?: {
          host?: string;
          port?: number;
          requestCallback?: RequestListener;
          tlsOptions?: TlsOptions;
      },
  ): Promise<void>

  Starts the webhook server to receive updates from Telegram.

  Parameters

  • Optionalpath: string

    The path for the webhook endpoint.

  • OptionalsecretToken: string

    The secret token for verifying webhook requests.

  • Optionaloptions: {
        host?: string;
        port?: number;
        requestCallback?: RequestListener;
        tlsOptions?: TlsOptions;
    }

    The options for the webhook server.

  Returns Promise<void>