@rongcloud/plugin-wechat-rtc/dist/core/command/BaseCommand.d.ts

@rongcloud/plugin-wechat-rtc

import { RCCommandKind } from '../enums/RCCommandKind';
import { BaseInvoker } from '../invoker';
import Store from '../store';
import { CommandExecuteContext } from './CommandExecuteContext';
export declare enum CommandPriority {
    LOW = 0,
    NORMAL = 1,
    HIGH = 2
}
export declare enum CommandCode {
    Destroy = 40400
}
export type ICommandResult<R = void> = {
    code: number;
    data?: R;
};
/**
 * 命令基类
 * @typeParams R - 返回值类型声明
 * @typeParams T - 命令执行上下文类型
 * @typeParams S - 内存数据缓存模块
 */
export declare abstract class BaseCommand<R = void, T = CommandExecuteContext, S = Store> {
    /**
     * 事务执行函数
     * @param context - 事务执行上下文
     * @param store - 内存读写模块
     * @param invoker - 任务队列
     */
    abstract execute(context: T, store: S, invoker: BaseInvoker<T, S>): Promise<ICommandResult<R>>;
    /**
     * 获取指令优先级，必要时可 override 此函数
     */
    get priority(): CommandPriority;
    /**
     * 它返回命令的种类。
     * @returns 命令的种类。
     */
    abstract get kind(): RCCommandKind;
}
//# sourceMappingURL=BaseCommand.d.ts.map