Class CartridgeNode

An implementation of CartridgeNodeInterface

Hierarchy

AbstractSockoNode
- CartridgeNode

Implements

Index

Constructors

constructor

Properties

_log
name

Accessors

type

Constructors

constructor

new CartridgeNode(): CartridgeNode

Overrides AbstractSockoNode.constructor
- Defined in lib/nodes/CartridgeNode.ts:8
Returns CartridgeNode

Properties

Protected _log

_log: loglevel.Logger

name

name: string

Accessors

type

get type(): SockoNodeType
set type(value: SockoNodeType): void

Inherited from AbstractSockoNode.type
- Defined in lib/nodes/AbstractSockoNode.ts:18
Returns SockoNodeType
Inherited from AbstractSockoNode.type
- Defined in lib/nodes/AbstractSockoNode.ts:22
Parameters
- value: SockoNodeType
Returns void

Methods

addChild

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

Implementation of CartridgeNodeInterface.addChild

Inherited from AbstractNode.addChild
- Defined in node_modules/js-hierarchy/lib/AbstractNode.d.ts:20
Parameters
- child: Node
- Optional position: number
Returns Node

findChild

findChild(child: Node): number

Implementation of CartridgeNodeInterface.findChild

Inherited from AbstractNode.findChild
- Defined in node_modules/js-hierarchy/lib/AbstractNode.d.ts:22
Parameters
- child: Node
Returns number

getChildByName

getChildByName(name: string): Node

Implementation of CartridgeNodeInterface.getChildByName

Inherited from AbstractNode.getChildByName
- Defined in node_modules/js-hierarchy/lib/AbstractNode.d.ts:19
Parameters
- name: string
Returns Node

getChildren

getChildren(): Node[]

Implementation of CartridgeNodeInterface.getChildren

Inherited from AbstractNode.getChildren
- Defined in node_modules/js-hierarchy/lib/AbstractNode.d.ts:18
Returns Node[]

getData

getData(key: string): any

Implementation of CartridgeNodeInterface.getData

Inherited from AbstractNode.getData
- Defined in node_modules/js-hierarchy/lib/AbstractNode.d.ts:28
Parameters
- key: string
Returns any

getLevel

getLevel(): number

Implementation of CartridgeNodeInterface.getLevel

Inherited from AbstractNode.getLevel
- Defined in node_modules/js-hierarchy/lib/AbstractNode.d.ts:34
Returns number

getNodeByPath

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

Implementation of CartridgeNodeInterface.getNodeByPath

Inherited from AbstractNode.getNodeByPath
- Defined in node_modules/js-hierarchy/lib/AbstractNode.d.ts:32
Parameters
- path: string
- Optional pathSeparator: string
Returns Bluebird<Node>

getNodeByPathArray

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

Implementation of CartridgeNodeInterface.getNodeByPathArray

Inherited from AbstractNode.getNodeByPathArray
- Defined in node_modules/js-hierarchy/lib/AbstractNode.d.ts:35
Parameters
- pathNodes: Array<string>
- absolute: boolean
Returns Bluebird<Node>

getParent

getParent(): Node

Implementation of CartridgeNodeInterface.getParent

Inherited from AbstractNode.getParent
- Defined in node_modules/js-hierarchy/lib/AbstractNode.d.ts:23
Returns Node

getPath

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

Implementation of CartridgeNodeInterface.getPath

Inherited from AbstractNode.getPath
- Defined in node_modules/js-hierarchy/lib/AbstractNode.d.ts:31
Parameters
- Optional pathSeparator: string
Returns Bluebird<string>

getPathNodes

getPathNodes(): Bluebird<Array<Node>>

Implementation of CartridgeNodeInterface.getPathNodes

Inherited from AbstractNode.getPathNodes
- Defined in node_modules/js-hierarchy/lib/AbstractNode.d.ts:30
Returns Bluebird<Array<Node>>

getRoot

getRoot(): Node

Implementation of CartridgeNodeInterface.getRoot

Inherited from AbstractNode.getRoot
- Defined in node_modules/js-hierarchy/lib/AbstractNode.d.ts:33
Returns Node

isRoot

isRoot(): boolean

Implementation of CartridgeNodeInterface.isRoot

Inherited from AbstractNode.isRoot
- Defined in node_modules/js-hierarchy/lib/AbstractNode.d.ts:25
Returns boolean

readContent

readContent(): Bluebird<any>

Implementation of CartridgeNodeInterface.readContent

Inherited from AbstractSockoNode.readContent
- Defined in lib/nodes/AbstractSockoNode.ts:26
Returns Bluebird<any>

removeChild

removeChild(child: Node | number): void

Implementation of CartridgeNodeInterface.removeChild

Inherited from AbstractNode.removeChild
- Defined in node_modules/js-hierarchy/lib/AbstractNode.d.ts:21
Parameters
- child: Node | number
Returns void

setData

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

Implementation of CartridgeNodeInterface.setData

Inherited from AbstractNode.setData
- Defined in node_modules/js-hierarchy/lib/AbstractNode.d.ts:27
Parameters
- key: string
- value: any
Returns Node

setParent

setParent(node: Node): void

Implementation of CartridgeNodeInterface.setParent

Inherited from AbstractNode.setParent
- Defined in node_modules/js-hierarchy/lib/AbstractNode.d.ts:24
Parameters
- node: Node
Returns void

toJSON

toJSON(): string

Implementation of CartridgeNodeInterface.toJSON

Inherited from AbstractNode.toJSON
- Defined in node_modules/js-hierarchy/lib/AbstractNode.d.ts:29
Returns string

walk

walk(direction: Direction | Direction[], action: ActionFunction): Bluebird<void>

Implementation of CartridgeNodeInterface.walk

Inherited from AbstractNode.walk
- Defined in node_modules/js-hierarchy/lib/AbstractNode.d.ts:26
Parameters
- direction: Direction | Direction[]
- action: ActionFunction
Returns Bluebird<void>

writeContent

writeContent(content: any): Bluebird<void>

Implementation of CartridgeNodeInterface.writeContent

Inherited from AbstractSockoNode.writeContent
- Defined in lib/nodes/AbstractSockoNode.ts:30
Parameters
- content: any
Returns Bluebird<void>

Generated using TypeDoc