Node Spec examples / Modules / node

Module: node

Table of contents

Enumerations

• NodeStatus
• NodeStoppedBy

Type Aliases

• MetricData
• MetricMap
• NodeConfig
• NodeId
• NodePackage
• NodePackageMap
• NodeRuntime
• NodeService
• UserNodePackages
• UserNodes
• default

Functions

• createNode
• createNodePackage
• getContainerName
• isBinaryNode
• isDockerNode

Type Aliases

MetricData

Ƭ MetricData: Object

Type declaration

Name	Type
x	number
y	number

Defined in

node.ts:44

---

MetricMap

Ƭ MetricMap: Record<string, MetricData>

Defined in

node.ts:48

---

NodeConfig

Ƭ NodeConfig: Object

Type declaration

Name	Type
configValuesMap	ConfigValuesMap
executionType?	ExecutionTypes

Defined in

node.ts:39

---

NodeId

Ƭ NodeId: string

Defined in

node.ts:10

---

NodePackage

Ƭ NodePackage: Object

Type declaration

Name	Type	Description
config	NodeConfig	-
createdTimestampMs	number	Timestamp the node was first created, UTC milliseconds
id	NodeId	-
lastStarted?	string	-
lastStopped?	string	-
nodes	default[]	-
runtime	NodeRuntime	-
services	NodeService[]	-
spec	NodePackageSpecification	-
status	NodeStatus	-
stoppedBy?	NodeStoppedBy	-

Defined in

node.ts:90

---

NodePackageMap

Ƭ NodePackageMap: Record<string, NodePackage>

Defined in

node.ts:106

---

NodeRuntime

Ƭ NodeRuntime: Object

Type declaration

Name	Type
build?	string
dataDir	string
initialized?	boolean
processIds?	string[]
usage	{ cpuPercent: MetricData[] | [] ; diskGBs: MetricData[] | [] ; memoryBytes: MetricData[] | [] ; syncedBlock: number }
usage.cpuPercent	MetricData[] | []
usage.diskGBs	MetricData[] | []
usage.memoryBytes	MetricData[] | []
usage.syncedBlock	number

Defined in

node.ts:52

---

NodeService

Ƭ NodeService: Object

Type declaration

Name	Type
node	default
serviceId	string
serviceName	string

Defined in

node.ts:85

---

UserNodePackages

Ƭ UserNodePackages: Object

Type declaration

Name	Type
nodeIds	string[]
nodes	NodePackageMap

Defined in

node.ts:108

---

UserNodes

Ƭ UserNodes: Object

Type declaration

Name	Type
nodeIds	string[]
nodes	NodeMap

Defined in

node.ts:81

---

default

Ƭ default: Object

Type declaration

Name	Type	Description
config	NodeConfig	-
createdTimestampMs	number	Timestamp the node was first created, UTC milliseconds
id	NodeId	-
lastStarted?	string	-
lastStopped?	string	-
runtime	NodeRuntime	-
spec	NodeSpecification	-
status	NodeStatus	-
stoppedBy?	NodeStoppedBy	-

Defined in

node.ts:66

Functions

createNode

▸ createNode(input): default

Parameters

Name	Type
input	Object
input.initialConfigFromUser?	ConfigValuesMap
input.runtime	NodeRuntime
input.spec	NodeSpecification

Returns

default

Defined in

node.ts:133

---

createNodePackage

▸ createNodePackage(input): NodePackage

Parameters

Name	Type
input	Object
input.initialConfigFromUser?	ConfigValuesMap
input.runtime	NodeRuntime
input.spec	NodePackageSpecification

Returns

NodePackage

Defined in

node.ts:167

---

getContainerName

▸ getContainerName(node): string

This naming convention supports a user running two of the same nodes, while still being human-readable. Returns just the specId for backwards compatibility.

Parameters

Name	Type
node	default

Returns

string

"node.spec.specId-node.createdTimestampMs"

Defined in

node.ts:211

---

isBinaryNode

▸ isBinaryNode(node): boolean

Parameters

Name	Type
node	default

Returns

boolean

Defined in

node.ts:123

---

isDockerNode

▸ isDockerNode(node): boolean

Parameters

Name	Type
node	default

Returns

boolean

Defined in

node.ts:113