API for breaking stack queue execution

[cusspvz]

Currently stack-queue stack queue execution breaking is defined by breakOn method option, which defaults for breaking on String type values.

Would you like to see implemented any other kind of breaking methods or API?

ping @brunocasanova @ajbloureiro @gabrielpconceicao

@mickhansen it would be great if you give your opinion also, since it could be useful also for sequelize. ( related with sequelize/sequelize#2932 )

[cusspvz]

On sequelize/sequelize#1852, @mickhansen and me have discussed some approaches to short-circuit sequelize hooks, which are kindly the same i would propose on this issue, but as they don't seem reasonable for me i would like to present whats going into my mind:

API Proposal

// Pass a `control` method with methods on it

// `control` would have to be backwards compatible (for those who use `next`)
// should have the same behavior as `control.continue`
stack.queue(function ( next ) {
  next();
});

// continue to next stack queued method
// Same as old `next`
stack.queue(function ( control ) {
  control.continue();
});

// break queue without a reason
stack.queue(function ( control ) {
  control.break();
});

// break queue fulfilling without a result
stack.queue(function ( control ) {
  control.break.fulfilling();
});

// break queue rejecting without an error
stack.queue(function ( control ) {
  control.break.rejecting();
});

// break queue fulfilling with a result
stack.queue(function ( control ) {
  control.break.fulfilling([
    'some',
    'data'
  ]);
});

// break queue rejecting without an error
stack.queue(function ( control ) {
  control.break.rejecting( new Error( "breaking things, just for fun" ) );
});

[cusspvz]

Also, if control variable is defined within function, stack-queue should IGNORE entirely returned values (so it doesn't conflict with returning promises).

We can think about logging a deprecated message when something is returned from a method within stack which is using control variable.

For detecting control parameter i would suggest to use ƒ. ƒ.Function.getParamNames()