import{H as e,Mt as t,dt as n,lt as r}from"./chunks/framework.BTDV-FQ9.js";var i=JSON.parse(`{"title":"FlowState","description":"","frontmatter":{},"headers":[],"relativePath":"runtime-api/core/flowState.md","filePath":"runtime-api/core/flowState.md"}`),a={name:`runtime-api/core/flowState.md`};function o(e,i,a,o,s,c){return t(),r(`div`,null,[...i[0]||=[n(`

FlowState

FlowState@tmagic/core 的流程状态类,用于控制事件动作流程的执行。

构造函数

typescript
new FlowState()

属性

属性类型说明
isAbortboolean当前流程是否已中止

实例方法

abort

typescript
import { FlowState } from '@tmagic/core';

const flowState = new FlowState();

// 在某个条件下中止流程
if (shouldStop) {
  flowState.abort();
}

// 检查是否已中止
if (flowState.isAbort) {
  console.log('流程已中止');
}

reset

typescript
flowState.reset();
console.log(flowState.isAbort); // false

使用场景

FlowState 常用于控制事件动作链的执行流程:

typescript
import App, { FlowState } from '@tmagic/core';

const app = new App({ /* options */ });

// 创建流程状态
const flowState = new FlowState();

// 执行代码块时传入流程状态
await app.runCode('validateCode', {}, [], flowState);

// 如果验证失败,代码块内部可以调用 flowState.abort()
// 后续的动作将不会执行
if (!flowState.isAbort) {
  await app.runCode('submitCode', {}, [], flowState);
}
`,16)]])}var s=e(a,[[`render`,o]]);export{i as __pageData,s as default};