A slice of time in an application. Provides hooks to allow functions to be executed before, during and after, the defined slice.

var Phase = require('loopback-phase').Phase;
var myPhase = new Phase('my-phase');

Register a phase handler to be executed after the phase completes. See register() for an example.

Register a phase handler to be executed before the phase begins. See register() for an example.

Begin the execution of a phase and its handlers. Provide a context object to be passed as the first argument for each handler function.

Return the Phase as a string.

Register a phase handler. The handler will be executed once the phase is launched. Handlers will be executed in parralel and must callback once complete. If the handler calls back with an error, the phase will immediately hault execution and call the callback provided to phase.run(callback).

Example

phase.use(function(ctx, next) {
  // specify an error if one occurred...
  var err = null;
  console.log(ctx.message, 'world!'); // => hello world
  next(err);
});

phase.run({message: 'hello'}, function(err) {
  if(err) return console.error('phase has errored', err);
  console.log('phase has finished');
});

An ordered list of phases.

var PhaseList = require('loopback-phase').PhaseList;
var phases = new PhaseList();
phases.add('my-phase');

Add one or more phases to the list.

Find a Phase from the list.

Find or add a Phase from/into the list.

Get the first Phase in the list.

Get an array of phase identifiers.

Get the last Phase in the list.

Remove a Phase from the list.

Launch the phases contained in the list. If there are no phases in the list process.nextTick is called with the provided callback.

Get the list of phases as an array of Phase objects.