ResourceMode 实例

ResourceMode 实例是一个用于配置模式新增和更新数据的实例,通过内置的zhname() , enbale() , actions() , remarks() 方法可以快速配置所需的数据,最终调用apply() 方法实现模式的新增以及更新,方法均支持链式调用

类型:ResourceMode

zhname()

配置模式中文名称

zhname: (name: string) => ResourceMode;
  • 参数

    • name:模式中文名称必传
  • 返回类型

    • ResourceMode 实例对象
  • 示例

const sources = mode.create("xxx");
sources.zhname("中文名称");

enable()

配置模式是否启用

enable: (isEnable: boolean) => ResourceMode;
  • 参数

    • isEnable:模式是否启用(true 为开启,false 为关闭)
  • 返回类型

    • ResourceMode 实例对象
  • 示例

const sources = mode.create("xxx");
sources.enable(true);

actions()

配置模式动作

actions: (commandsWithGroup: Array<{ group?: string | number; command: string }>) => ResourceMode;
  • 参数

    • commandsWithGroup:模式动作

      • command 为具体指令

      • group为分组,相同的指令会被归为一组,若无分组需求可不传

  • 返回类型

    • ResourceMode 实例对象
  • 示例

const sources = mode.create("xxx");
sources.actions([{ group: 0, command: "(./devices/Window).close()" }]);

remarks()

配置备注

remarks: (remark: string) => ResourceMode;
  • 参数

    • remark:备注
  • 返回类型

    • ResourceMode 实例对象
  • 示例

const sources = mode.create("xxx");
sources.remarks("这是备注");

apply()

提交修改

apply: () => Promise<any>;
  • 参数

  • 返回类型

    • Promise<any>
  • 示例

const sources = mode.create("xxx");
sources.apply();
上次更新:
贡献者: panlingjin, zhengqian, 潘灵金