EngineModule

Hierarchy

• EventEmitter

  ↳ EngineModule

Table of contents

Constructors

• constructor

Properties

• nodeUID
• opts
• uid

Methods

• close
• input
• off
• on

Constructors

constructor

new EngineModule(nodeUID, opts, uid)

Allows access to a module node. Call using the engine.registerModule('[uid]') function

Parameters

Name	Type
nodeUID	string
opts	EngineModuleOpts
uid	string

Inherited from

EventEmitter.constructor

Properties

nodeUID

Readonly nodeUID: string

---

opts

Readonly opts: KeyValue

---

uid

Readonly uid: string

Methods

close

close(): void

Close the input and event handler

Returns

void

---

input

input(data, opts?): void

Trigger action for module

Parameters

Name	Type
data	any
opts?	EngineModuleOpts

Returns

void

---

off

off(event, handler): any

Parameters

Name	Type
event	string
handler	any

Returns

any

Inherited from

EventEmitter.off

---

on

on(event, listener): EngineModule

Data received for event

Parameters

Name	Type
event	"triggered"
listener	(data: KeyValue) => void

Returns

EngineModule

Inherited from

EventEmitter.on

on(event, listener): EngineModule

Error returned

Parameters

Name	Type
event	"error"
listener	(data: KeyValue) => void

Returns

EngineModule