@realsee/vr-signals API Documentation - v2.0.0
    Preparing search index...

    Class StandardActionManager<ActionMap>

    标准化的 Action 管理器 使用标准的 Promise 和 AbortController

    Type Parameters

    • ActionMap extends Record<string, (...args: any[]) => any>
    Index

    Constructors

    Accessors

    • get size(): number

      获取 Actions 数量

      Returns number

    Methods

    • 注册 Action

      Type Parameters

      • K extends string | number | symbol

      Parameters

      • name: K

        Action 名称

      • handler: ActionMap[K]

        Action 处理器

      Returns void

    • 批量注册 Actions

      Parameters

      Returns void

    • 移除 Action

      Type Parameters

      • K extends string | number | symbol

      Parameters

      • name: K

        Action 名称

      Returns boolean

      是否成功移除

    • 检查 Action 是否已注册

      Type Parameters

      • K extends string | number | symbol

      Parameters

      • name: K

        Action 名称

      Returns boolean

      是否已注册

    • 获取已注册的 Actions 列表

      Returns (keyof ActionMap)[]

      Actions 名称列表

    • 执行 Action(标准 Promise 接口)

      Type Parameters

      • K extends string | number | symbol

      Parameters

      • name: K

        Action 名称

      • data: Parameters<ActionMap[K]>[0]

        Action 参数

      • options: ActionExecuteOptions = {}

        执行选项

      Returns Promise<ReturnType<ActionMap[K]>>

      Promise 结果

    • 执行 Action 并支持取消(返回 Promise 和 AbortController)

      Type Parameters

      • K extends string | number | symbol

      Parameters

      • name: K

        Action 名称

      • data: Parameters<ActionMap[K]>[0]

        Action 参数

      • options: ActionExecuteOptions = {}

        执行选项

      Returns {
          promise: Promise<ReturnType<ActionMap[K]>>;
          abort: () => void;
          signal: AbortSignal;
      }

      执行结果和控制器

    • 清空所有 Actions

      Returns void