ClientOptions

API reference for ClientOptions in @erlcjs/core.

Configuration options for the ERLCApi Client.

Signature:

interface ClientOptions

#Properties

Property

Modifiers

Type

Description

globalAppId?

string | number

(Optional) Optional global app ID for your application.

globalKey?

string

(Optional) Optional global key for your application.

maxCacheSize?

{ killLog?: number; commandLog?: number; joinLog?: number; modCalls?: number; }

(Optional)

polling?

{ enabled: boolean; pollingRateMs?: number; autoStartPolling?: boolean; } | true

(Optional) Configuration to poll the ER:LC API endpoints periodically.

servers

string[]

The ER:LC Server API keys the client should manage. The server ID of each server is parsed from its key.

webhook?

{ enabled: boolean; port: number; path?: string; timestampTolerance?: number; }

(Optional) Webhook configuration details.