Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ClientOptions

Options for Clients. For default values see DefaultClientOptions

Hierarchy

  • ClientOptions

Index

Properties

apiVersion?: number

The API version to use across the REST and WebSocket servers.

default

9

compress?: boolean

Whether to compress gateway packets. Requires zlib-sync.

default

false

etf?: boolean | Erlpack

Whether to use erlpack while processing gateway packets. Requires the NPM package.

default

false

httpBaseUrl?: string

Base URL for connecting to the Discord REST API. DO NOT SPECIFY THE API VERSION IN THIS

default

"https://discord.com/api"

httpTimings?: boolean

Whether to time requests and print them to the debug output.

default

false

httpUserAgent?: string

User agent for the Discord REST API.

default

"Discordbot (https://github.com/fuwadiscord/fuwa, v{{package_version}})"

The Gateway Intents to use for this client.

default

DefaultClientOptions.intents

logger?: boolean | ILogger | LoggerOptions

Logger to use for this client. If a boolean, initiates with DefaultLoggerOptions.

You can also supply your own logger, see ILogger for more information.

default

DefaultClientOptions.logger

wsBrowser?: string
wsDevice?: string
wsOS?: string

Generated using TypeDoc