HoshimiNodeOptions Interface

Signature

export interface HoshimiNodeOptions

No methods.

userAgent?: UserAgent;

The user agent for the requests.

`hoshimi/v${string} (${string})`

@type{UserAgent}

closeOnError?: boolean;

Whether to close (and reconnect) the socket on a WebSocket error. Overrides the manager-level default.

@defaulttrue

sessionOptions?: NodeSessionOptions;

The session options for the node.

@type{NodeSessionOptions | undefined}

moveOptions?: NodePlayerMoveOptions;

Whether to move the players to another node if the node gets disconnected.

@type{NodePlayerMoveOptions | undefined}

heartbeatOptions?: NodeHeartbeatOptions;

The heartbeat options for liveness detection.

@type{NodeHeartbeatOptions | undefined}