GatewayForwarderPlugin

The base class for all plugins

Extends

GatewayPlugin

Constructors

Constructor

new GatewayForwarderPlugin(options): GatewayForwarderPlugin

Parameters

Parameter	Type
`options`	`GatewayForwarderPluginOptions`

Returns

GatewayForwarderPlugin

Overrides

GatewayPlugin.constructor

Properties

Property	Modifier	Type	Default value	Description	Overrides	Inherited from
`client?`	`protected`	`Client`	`undefined`	-	-	`GatewayPlugin`.`client`
`config`	`protected`	`GatewayForwarderPluginOptions`	`undefined`	-	`GatewayPlugin`.`config`	-
`emitter`	`protected`	`EventEmitter`	`undefined`	-	-	`GatewayPlugin`.`emitter`
`gatewayInfo?`	`protected`	`APIGatewayBotInfo`	`undefined`	-	-	`GatewayPlugin`.`gatewayInfo`
`heartbeatInterval?`	`public`	`Timeout`	`undefined`	-	-	`GatewayPlugin`.`heartbeatInterval`
`id`	`readonly`	`"gateway-forwarder"`	`"gateway-forwarder"`	An ID that identifies the plugin uniquely between all other used plugins in the Client	`GatewayPlugin`.`id`	-
`lastHeartbeatAck`	`public`	`boolean`	`true`	-	-	`GatewayPlugin`.`lastHeartbeatAck`
`monitor`	`protected`	`ConnectionMonitor`	`undefined`	-	-	`GatewayPlugin`.`monitor`
`sequence`	`public`	`null` \| `number`	`null`	-	-	`GatewayPlugin`.`sequence`
`shardId?`	`public`	`number`	`undefined`	-	-	`GatewayPlugin`.`shardId`
`state`	`protected`	`GatewayState`	`undefined`	-	-	`GatewayPlugin`.`state`
`totalShards?`	`public`	`number`	`undefined`	-	-	`GatewayPlugin`.`totalShards`
`ws`	`protected`	`null` \| `WebSocket`	`null`	-	-	`GatewayPlugin`.`ws`

Methods

canResume()

protected canResume(): boolean

Returns

boolean

Inherited from

GatewayPlugin.canResume

connect()

connect(resume): void

Parameters

Parameter	Type	Default value
`resume`	`boolean`	`false`

Returns

void

Inherited from

GatewayPlugin.connect

createWebSocket()

protected createWebSocket(url): WebSocket

Parameters

Parameter	Type
`url`	`string`

Returns

WebSocket

Inherited from

GatewayPlugin.createWebSocket

disconnect()

disconnect(): void

Returns

void

Inherited from

GatewayPlugin.disconnect

handleClose()

protected handleClose(code): void

Parameters

Parameter	Type
`code`	`number`

Returns

void

Inherited from

GatewayPlugin.handleClose

handleReconnect()

protected handleReconnect(): void

Returns

void

Inherited from

GatewayPlugin.handleReconnect

handleReconnectionAttempt()

protected handleReconnectionAttempt(options): void

Parameters

Parameter	Type
`options`	{ `code`: `number`; `forceNoResume`: `boolean`; `isZombieConnection`: `boolean`; }
`options.code?`	`number`
`options.forceNoResume?`	`boolean`
`options.isZombieConnection?`	`boolean`