@defiantcaptain/hydra-events

Events that are used with Hydra. Separated out to provide a nice abstraction.

Stats

StarsIssuesVersionUpdatedCreatedSize
@defiantcaptain/hydra-events
0.4.24 years ago4 years agoMinified + gzip package size for @defiantcaptain/hydra-events in KB

Readme

#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

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.