TypeScript有限状态机项目教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00048/article/details/139642414

TypeScript有限状态机项目教程

typescript-fsm TS-FSM is a strongly typed finite state machine for TypeScript that is using async operations. Library uses generics to take the user states and events. Zero dependencies! 项目地址: https://gitcode.com/gh_mirrors/ty/typescript-fsm

1. 项目介绍

TypeScript有限状态机（TS-FSM）是一个为TypeScript设计的强类型有限状态机库。它使用异步操作，并通过泛型来处理用户状态和事件。该库具有以下特点：

强类型支持：使用TypeScript的强类型特性，确保状态和事件的类型安全。
异步操作：支持异步状态转换，使用Promise来处理异步操作。
零依赖：库本身不依赖任何外部库，保持轻量级。
简单易用：通过简单的表格定义状态机，易于理解和使用。

2. 项目快速启动

2.1 安装

首先，克隆项目到本地并安装依赖：

git clone https://github.com/eram/typescript-fsm.git
cd typescript-fsm
npm install

2.2 基本使用

以下是一个简单的“门”状态机的示例。门可以打开、关闭或损坏。每个操作都是异步的：

import { StateMachine } from "typescript-fsm";

// 定义状态和事件
enum States {
  closing = 0,
  closed,
  opening,
  opened,
  broken
}

enum Events {
  open = 100,
  openComplete,
  close,
  closeComplete,
  break
}

// 定义状态转换
const transitions = [
  /* fromState event toState callback */
  t(States.closed, Events.open, States.opening, onOpen),
  t(States.opening, Events.openComplete, States.opened, justLog),
  t(States.opened, Events.close, States.closing, onClose),
  t(States.closing, Events.closeComplete, States.closed, justLog),
  t(States.closed, Events.break, States.broken, justLog),
  t(States.opened, Events.break, States.broken, justLog),
  t(States.opening, Events.break, States.broken, justLog),
  t(States.closing, Events.break, States.broken, justLog)
];

// 初始化状态机
const door = new StateMachine<States, Events>(States.closed, transitions);

// 异步回调函数
async function onOpen() {
  console.log("onOpen");
  return door.dispatch(Events.openComplete);
}

async function onClose() {
  console.log("onClose");
  return door.dispatch(Events.closeComplete);
}

// 同步回调函数
function justLog() {
  console.log(`${States[door.getState()]}`);
}

// 运行状态机
new Promise(async (resolve) => {
  // 打开门并等待其打开
  await door.dispatch(Events.open);
  door.getState(); // => States.opened

  // 检查门是否可以关闭
  door.can(Events.close); // => true

  // 损坏门
  door.dispatch(Events.break).then(() => {
    // 是否达到最终状态
    door.isFinal(); // => true
  });

  // 门已损坏，无法关闭
  try {
    await door.dispatch(Events.close);
    assert("should not get here");
  } catch (e) {
    // 正常
  }

  // 等待异步操作完成
  setTimeout(resolve, 10);
});