Event.nucleus - idexlabs/idex.nucleus.core GitHub Wiki

Classes

NucleusEvent

Members

name : String
message : Object
originUserID : String

Typedefs

NucleusEvent

NucleusEvent

Kind: global class

new NucleusEvent(eventName, eventMessage, [options])

Creates a Nucleus Event.

Throws:

  • Will throw an error if the event name is missing or an empty string.
Param Type
eventName String
eventMessage Object
[options] Object
[options.originEngineID] String
[options.originEngineName] String
[options.originProcessID] String

Example

const event = new NucleusEvent(eventName, eventMessage, options);

name : String

Kind: global variable

message : Object

Kind: global variable

originUserID : String

Kind: global variable

NucleusEvent

Kind: global typedef
Properties

Name Type
ID String
meta Object
meta.createdISOTime String
meta.originEngineID String
meta.originEngineName String
meta.originProcessID String
name String
message Object

new NucleusEvent(eventName, eventMessage, [options])

Creates a Nucleus Event.

Throws:

  • Will throw an error if the event name is missing or an empty string.
Param Type
eventName String
eventMessage Object
[options] Object
[options.originEngineID] String
[options.originEngineName] String
[options.originProcessID] String

Example

const event = new NucleusEvent(eventName, eventMessage, options);
⚠️ **GitHub.com Fallback** ⚠️