Class: TsumiInstance

TsumiInstance(options) → {Object}

Represents a Tsumi instance.

Constructor

new TsumiInstance(options) → {Object}

Parameters:
Name Type Description
options Object
Properties
Name Type Description
botId string The bot ID
sendPayload function The function to send payloads
userAgent string The user agent to use
Source:
Returns:
- An event emitter for listening
Type
Object

Extends

  • EventEmitter

Members

Nodes :Object

The nodes that are connected
Type:
  • Object
Default Value:
  • {}
Source:

botId :String

This bot's ID
Type:
  • String
Source:

options :Object

This Instance's option
Type:
  • Object
Source:

userAgent :String

This Instance's user agent
Type:
  • String
Source:

Methods

(async) addNode(node) → {Object}

Add a node to the instance
Parameters:
Name Type Description
node Object The node to add
Source:
Returns:
- The node that was added
Type
Object

getIdealNode() → {Object}

Get the ideal node
Source:
Returns:
The ideal node
Type
Object

handleRaw(data)

Handling raw events for players
Parameters:
Name Type Description
data Object The data to handle
Source:

purge() → {Boolean}

Purge all nodes
Source:
Returns:
- True if successful
Type
Boolean