Skip to content

ClientOptions

Package: @erinjs/core

Properties

NameTypeReadonlyOptionalDescription
cacheCacheSizeLimitsNoYesCache size limits (channels, guilds, users). When exceeded, oldest entries are evicted. Omit or 0 = unbounded.
intentsnumberNoYesGateway intents. Not yet supported by erin.js—value is always sent as 0. Set suppressIntentWarning to silence the warning.
presenceGatewayPresenceUpdateDataNoYesInitial presence (status, custom_status, etc.) sent on identify. Can also update via PresenceUpdate after connect.
restanyNoYes
suppressIntentWarningbooleanNoYesSuppress the warning when intents are set (erin.js does not support intents yet).
waitForGuildsbooleanNoYesWhen true, delay the Ready event until all guilds from READY (including unavailable) have been received via GUILD_CREATE. Default: false.
WebSocketnew (url: string) => { send(data: string | ArrayBufferLike): void; close(code?: number): void; readyState: number; addEventListener?(type: string, listener: (e: unknown) => void): void; on?(event: string, cb: (data?: unknown) => void): void; }NoYesOptional WebSocket constructor (e.g. require('ws') in Node for compatibility)

Released under the Apache-2.0 License.