Abort

Command: abort

Description: Abort the pipeline immediately, discarding any partial results.

Notes

Aborts the pipeline. It sets the working text to undefined and exits immediately. It will still return the WorkingData object (with undefined text) so that history and logs can be examined, but the pipeline will not complete and none of the finalization activities will be executed.

If you want a more graceful end, using the end command.

Source Code

function abort(working, command, p) {
  working.abort = true;
  return working.text;
}
abort.title = "Abort";
abort.description =
  "Abort the pipeline immediately, discarding any partial results.";
abort.args = [];
abort.passthrough = true;

export default abort;