NodeOptions
The node options.
Signature
export interface NodeOptionsProperties
11Methods
0No methods.
Properties
host: string;The node host.
@type{string}
port: number;The node port.
@type{number}
password: string;The node password.
@type{string}
id?: string;The node id.
@type{string}
secure?: boolean;Enable if the node is secure.
@type{boolean}@defaultfalse
restTimeout?: number;The timeout for the REST in milliseconds. Overrides the manager-level `restOptions.restTimeout` for this node; when omitted, that manager default is used (falling back to `10000`).
@type{number}@defaultrestOptions.restTimeout
retryAmount?: number;The amount of retries to reconnect.
@type{number}@default5
retryDelay?: number;The delay between retries in milliseconds.
@type{number}@default20000
sessionId?: string;The session id of the node.
@type{string}
heartbeat?: NodeHeartbeatOptions;Heartbeat options for this node. Overrides the manager-level defaults.
@type{NodeHeartbeatOptions | undefined}
closeOnError?: boolean;Whether to close (and reconnect) the socket on a WebSocket error. Overrides the manager-level default.
@defaulttrue