@5minds/processcube_engine/dist/Contracts/InternalDataModels/IInterruptible.d.ts

The ProcessCube Engine. Stores and executes BPMNs.

import { Identity } from '@5minds/processcube_engine_sdk';
/**
 * The signature for the interruption callback function.
 * This callback can be used by the derived FlowNodeHandlers to perform cleanup
 * operations after being interrupted.
 */
export type OnInterruptionCallback = (currentToken: Record<string, any>) => void | Promise<void>;
/**
 * Contains function definitions for interrupting a FlowNodeHandler.
 */
export interface IInterruptible {
    /**
     * This will interrupt the execution of a FlowNodeHandler, causing it to cease all
     * function and exiting.
     * Activities can be interrupted by BoundaryEvents or TerminateEndEvents.
     *
     * @param token     The Flow Node Instance's current token.
     * @param terminate Optional: If set to true, the activity will terminate,
     *                  rather than finish regularily.
     */
    interrupt(token: Record<string, any>, terminate?: boolean, terminatedBy?: Identity): void | Promise<void>;
}