NPM
GuideAPI

NodeSessionOptions

The node session options.

hoshimisrc/types/Node.d.ts

Signature

export interface NodeSessionOptions

Properties

resumable
resumable?: boolean;

Make the node resumable.

@type{boolean}@defaultfalse
timeout
timeout?: number;

The timeout for resuming the session in seconds.

@type{number}@default60
byLibrary
byLibrary?: boolean;

Hoshimi will try to resume the players in the node if it's possible.

@type{boolean}@defaultfalse

Methods

resumeFn
resumeFn?(node: NodeStructure, players: PlayerStructure[]): Awaitable<void>;

Custom handler for `byLibrary` resume. When set, it runs instead of the built-in one; when omitted, the built-in `resumeByLibrary` is used. Only consulted while `byLibrary` is enabled.

Parameters

node
The node whose players are being resumed.
players
The players the library holds for that node.

Returns