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

    Interface StandardActionAPI<ActionMap>

    标准化的 Action 执行接口

    interface StandardActionAPI<
        ActionMap extends Record<string, (...args: any[]) => any>,
    > {
        execute<K extends string | number | symbol>(
            action: K,
            data: Parameters<ActionMap[K]>[0],
            options?: ActionExecuteOptions,
        ): Promise<ReturnType<ActionMap[K]>>;
        executeWithAbort<K extends string | number | symbol>(
            action: K,
            data: Parameters<ActionMap[K]>[0],
            options?: ActionExecuteOptions,
        ): {
            promise: Promise<ReturnType<ActionMap[K]>>;
            abort: () => void;
            signal: AbortSignal;
        };
        registerAction<K extends string | number | symbol>(
            name: K,
            handler: ActionMap[K],
        ): void;
        unregisterAction<K extends string | number | symbol>(name: K): boolean;
        hasAction<K extends string | number | symbol>(name: K): boolean;
        getRegisteredActions(): (keyof ActionMap)[];
    }

    Type Parameters

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

    Methods

    • Type Parameters

      • K extends string | number | symbol

      Parameters

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

    • Type Parameters

      • K extends string | number | symbol

      Parameters

      Returns void

    • Type Parameters

      • K extends string | number | symbol

      Parameters

      • name: K

      Returns boolean

    • Type Parameters

      • K extends string | number | symbol

      Parameters

      • name: K

      Returns boolean

    • Returns (keyof ActionMap)[]