Interface ScreepsClientConfig

Specifies a default shard name to use when one is not provided as an argument to a ScreepsHttpClient endpoint function.

Wait for a short period of time before automatically retriing requests that fail due to the global 120 requests/minute rate limit.

Delay (in milliseconds) before the first retry attempt. Only applies to retries for endpoint-specific rate limits.

Maximum delay (in milliseconds) between retry attempts. Only applies to retries for endpoint-specific rate limits.

Maximum number of retry attempts. Exponential backoff is used to increase the delay between subsequent retry attempts. Only applies to retries for endpoint-specific rate limits.

If enabled, ping the server every wsKeepAliveInterval to prevent the connection from being closed.

Time (in milliseconds) between wsKeepAlive pings

If enabled, ScreepsSocketClient will call reconnect automatically when disconnected.

The delay (in milliseconds) before the first retry attempt in ScreepsSocketClient.reconnect.

The maximum delay (in milliseconds) before a retry attempt in ScreepsSocketClient.reconnect.

The maximum number of times ScreepsSocketClient.connect will be called from ScreepsSocketClient.reconnect before giving up and throwing an error.

If enabled, all previous subscriptions will be recreated after successfully connecting (automatically or manually).