Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • LaunchOptions

Index

Properties

allowedUpdates?: UpdateType[]

List the types of updates you want your bot to receive

dropPendingUpdates?: boolean
webhook?: { cb?: RequestListener; domain?: string; hookPath?: string; host?: string; ipAddress?: string; maxConnections?: number; port?: number; tlsOptions?: TlsOptions }

Configuration options for when the bot is run via webhooks

Type declaration

  • Optional cb?: RequestListener
  • Optional domain?: string

    Public domain for webhook. If domain is not specified, hookPath should contain a domain name as well (not only path component).

  • Optional hookPath?: string

    Webhook url path; will be automatically generated if not specified

  • Optional host?: string
  • Optional ipAddress?: string

    The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS

  • Optional maxConnections?: number

    Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput.

  • Optional port?: number
  • Optional tlsOptions?: TlsOptions

    TLS server options. Omit to use http.

Generated using TypeDoc