GatewayForwarderPluginOptions
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
eventFilter? | (event) => boolean | This is a custom function you can provide that will filter events. If this function is present, the plugin will only process events that return true. | GatewayPluginOptions.eventFilter |
intents | number | The intents to use for the client | GatewayPluginOptions.intents |
privateKey | string | The ed25519 private key in PEM format, used to sign forwarded events. This should include the BEGIN/END markers. When loading from an environment variable, the newlines can be escaped (\n). For instructions on generating keys and setting up the forwarder, see the documentation at: https://carbon.buape.com/plugins/gateway-forwarder | - |
reconnect? | object | The reconnect options | GatewayPluginOptions.reconnect |
reconnect.baseDelay? | number | The base delay between reconnect attempts | - |
reconnect.maxAttempts? | number | The maximum number of reconnect attempts | - |
reconnect.maxDelay? | number | The maximum delay between reconnect attempts after it scales exponentially | - |
shard? | [number, number] | The shard to connect to [shard_id, num_shards] | GatewayPluginOptions.shard |
url? | string | The URL of the gateway to connect to | GatewayPluginOptions.url |
webhookUrl | string | The URL to forward webhook events to. Typically this is your base URL in the client, and then /events | - |