@nocobase/plugin-workflow
Version:
A powerful BPM tool that provides foundational support for business automation, with the capability to extend unlimited triggers and nodes.
33 lines (32 loc) • 1.33 kB
TypeScript
/**
* This file is part of the NocoBase (R) project.
* Copyright (c) 2020-2024 NocoBase Co., Ltd.
* Authors: NocoBase Team.
*
* This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
* For more information, please refer to: https://www.nocobase.com/agreement.
*/
import { Transactionable } from '@nocobase/database';
import type Plugin from '../Plugin';
import type Processor from '../Processor';
import type { FlowNodeModel } from '../types';
export interface IJob {
status: number;
result?: unknown;
[key: string]: unknown;
}
export type InstructionResult = IJob | Promise<IJob> | Promise<void> | null | void;
export type Runner = (node: FlowNodeModel, input: any, processor: Processor) => InstructionResult;
export type InstructionInterface = {
run: Runner;
resume?: Runner;
getScope?: (node: FlowNodeModel, data: any, processor: Processor) => any;
duplicateConfig?: (node: FlowNodeModel, options: Transactionable) => object | Promise<object>;
test?: (config: Record<string, any>) => IJob | Promise<IJob>;
};
export declare abstract class Instruction implements InstructionInterface {
workflow: Plugin;
constructor(workflow: Plugin);
abstract run(node: FlowNodeModel, input: any, processor: Processor): InstructionResult;
}
export default Instruction;