KeyDataNode - Documentation

Constructor

new KeyDataNode(key, data)

Create a key-data node with key and given data.

Source:

Tree.js, line 127

Parameters:

Name	Type	Description
`key`	`string`
`data`	`*`

Members

children :object

Map of keys to children nodes.

Source:

Tree.js, line 136

Type:

object

data :*

Data property.

Source:

Tree.js, line 154

Type:

key :string

Node key.

Source:

Tree.js, line 148

Type:

string

size :number

Number of nodes.

Source:

Tree.js, line 161

Type:

number

Methods

append(node)

Append the given node to the end of the children list.

Source:

Tree.js, line 225

Parameters:

Name	Type	Description
`node`	`KeyDataNode`

appendDataByKeyPath(keys, data) → {KeyDataNode}

Append data by path being an array of keys.

Source:

Tree.js, line 192

Parameters:

Name	Type	Description
`keys`	`array.<string>`
`data`	`*`

Returns:

Type:: KeyDataNode

The newly created node containing the data.

findByKeyPath(keys)

Fina a node by path being an array of keys.

Source:

Tree.js, line 169

Parameters:

Name	Type	Description
`keys`	`array.<string>`

getKeyPath() → {array}

Get key path of current node (a key chain from root to itself).

Source:

Tree.js, line 254

Returns:

Type:: array

remove(node)

Remove the given node from the branch.

Source:

Tree.js, line 239

Parameters:

Name	Type	Description
`node`	`KeyDataNode`