@defiantcaptain/hydra-events
TypeScript icon, indicating that this package has built-in type declarations

0.4.2 • Public • Published

#hydra-events Not intended for general consumption, it won't make sense outside the context it was created.

##SporkSpawn implements ISporkMessage

Creates an event object around the event SporkProcessEvents::FORK_ME that contains the script information.

  • static $()(sciprt.js, args, instanceID, eventID) Creates an instance of this event that will invoke the defined script. The instanceID and eventID must be included.
  • get script() Returns the script of concern.
  • get event() => SporkProcessEvents::FORK_ME Returns the FORK_ME event.

##SporkSpawnDone implements ISporkMessage

Creates an event object around the event SporkProcessEvent::DONE that contains the result information.

  • static $()(resultJSON, instanceID, eventID) Creates an instance of this event that will contain the result data, the instance information, and the eventID.
  • get result() : any Returns the object that contains the result. The spawner must understand this.
  • get event() => SporkProcessEvents::DONE Returns the DONE event.

##ISporkMessage

Interface.

  • readonly event : string The event that this is responsible for.

##SporkProcessEVents

Namespace that contains event data.

  • SporkProcessEvents.FORK_ME
  • SporkProcessEvents.DONE

Readme

Keywords

none

Package Sidebar

Install

npm i @defiantcaptain/hydra-events

Weekly Downloads

2

Version

0.4.2

License

MIT

Last publish

Collaborators

  • defiantcaptain