Class SimpleNode

A node implementation offering basic features

Hierarchy

AbstractNode
- SimpleNode

Implements

Node

Index

Constructors

constructor

Properties

_log

Accessors

name

Methods

Constructors

constructor

new SimpleNode(name?: string, data?: object): SimpleNode

Inherited from AbstractNode.constructor
- Defined in lib/AbstractNode.ts:41
Parameters
- Optional name: string
- Optional data: object
  - [p: string]: any
Returns SimpleNode

Properties

Protected _log

_log: loglevel.Logger = null

Accessors

name

get name(): string
set name(value: string): void

Inherited from AbstractNode.name
- Defined in lib/AbstractNode.ts:35
Returns string
Inherited from AbstractNode.name
- Defined in lib/AbstractNode.ts:39
Parameters
- value: string
Returns void

Methods

addChild

addChild(child: Node, position?: number): Node

Implementation of Node.addChild

Inherited from AbstractNode.addChild
- Defined in lib/AbstractNode.ts:77
Parameters
- child: Node
- Optional position: number
Returns Node

findChild

findChild(child: Node): number

Implementation of Node.findChild

Inherited from AbstractNode.findChild
- Defined in lib/AbstractNode.ts:123
Parameters
- child: Node
Returns number

getChildByName

getChildByName(name: string): Node

Implementation of Node.getChildByName

Inherited from AbstractNode.getChildByName
- Defined in lib/AbstractNode.ts:67
Parameters
- name: string
Returns Node

getChildren

getChildren(): Node[]

Implementation of Node.getChildren

Inherited from AbstractNode.getChildren
- Defined in lib/AbstractNode.ts:54
Returns Node[]

getData

getData(key: string): any

Implementation of Node.getData

Inherited from AbstractNode.getData
- Defined in lib/AbstractNode.ts:217
Parameters
- key: string
Returns any

getLevel

getLevel(): number

Implementation of Node.getLevel

Inherited from AbstractNode.getLevel
- Defined in lib/AbstractNode.ts:295
Returns number

getNodeByPath

getNodeByPath(path: string, pathSeparator?: string): Bluebird<Node>

Implementation of Node.getNodeByPath

Inherited from AbstractNode.getNodeByPath
- Defined in lib/AbstractNode.ts:273
Parameters
- path: string
- Optional pathSeparator: string
Returns Bluebird<Node>

getNodeByPathArray

getNodeByPathArray(pathNodes: Array<string>, absolute: boolean): Bluebird<Node>

Implementation of Node.getNodeByPathArray

Inherited from AbstractNode.getNodeByPathArray
- Defined in lib/AbstractNode.ts:303
Parameters
- pathNodes: Array<string>
- absolute: boolean
Returns Bluebird<Node>

getParent

getParent(): Node

Implementation of Node.getParent

Inherited from AbstractNode.getParent
- Defined in lib/AbstractNode.ts:139
Returns Node

getPath

getPath(pathSeparator?: string): Bluebird<string>

Implementation of Node.getPath

Inherited from AbstractNode.getPath
- Defined in lib/AbstractNode.ts:254
Parameters
- Optional pathSeparator: string
Returns Bluebird<string>

getPathNodes

getPathNodes(): Bluebird<Array<Node>>

Implementation of Node.getPathNodes

Inherited from AbstractNode.getPathNodes
- Defined in lib/AbstractNode.ts:238
Returns Bluebird<Array<Node>>

getRoot

getRoot(): Node

Implementation of Node.getRoot

Inherited from AbstractNode.getRoot
- Defined in lib/AbstractNode.ts:287
Returns Node

isRoot

isRoot(): boolean

Implementation of Node.isRoot

Inherited from AbstractNode.isRoot
- Defined in lib/AbstractNode.ts:153
Returns boolean

removeChild

removeChild(child: Node | number): void

Implementation of Node.removeChild

Inherited from AbstractNode.removeChild
- Defined in lib/AbstractNode.ts:96
Parameters
- child: Node | number
Returns void

setData

setData(key: string, value: any): Node

Implementation of Node.setData

Inherited from AbstractNode.setData
- Defined in lib/AbstractNode.ts:211
Parameters
- key: string
- value: any
Returns Node

setParent

setParent(node: Node): void

Implementation of Node.setParent

Inherited from AbstractNode.setParent
- Defined in lib/AbstractNode.ts:146
Parameters
- node: Node
Returns void

toJSON

toJSON(): string

Implementation of Node.toJSON

Inherited from AbstractNode.toJSON
- Defined in lib/AbstractNode.ts:227
Returns string

walk

walk(direction: Direction.up | Direction.down | Direction.left | Direction.right | Direction.rootUp | (Direction.up | Direction.down | Direction.left | Direction.right | Direction.rootUp)[], action: ActionFunction): Bluebird<void>

Implementation of Node.walk

Inherited from AbstractNode.walk
- Defined in lib/AbstractNode.ts:162
Parameters
- direction: Direction.up | Direction.down | Direction.left | Direction.right | Direction.rootUp | (Direction.up | Direction.down | Direction.left | Direction.right | Direction.rootUp)[]
- action: ActionFunction
Returns Bluebird<void>

Generated using TypeDoc