ResourcePlan 实例

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

类型：ResourcePlan

zhname()

配置计划中文名称

zhname: (name: string) => ResourcePlan;

• 参数

  • name：计划中文名称必传

• 返回类型

  • ResourcePlan 实例对象

• 示例

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

time()

配置计划执行时间

time: (cron: string) => ResourcePlan;

• 参数

  • cron：计划执行时间(cron 表达式)

• 返回类型

  • ResourcePlan 实例对象

• 示例

const sources = plan.create("xxx");
sources.time("0 0 12 * * ?");

enable()

配置计划是否启用

enable: (isEnable: boolean) => ResourcePlan;

• 参数

  • bool：计划是否启用( true 为开启， false 为关闭)

• 返回类型

  • ResourcePlan 实例对象

• 示例

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

actions()

配置计划执行动作

actions: (commandsWithGroup: Array<{ group?: string | number; command: string }>) => ResourcePlan;

• 参数

  • commandsWithGroup：计划执行动作

    • command 为具体指令

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

• 返回类型

  • ResourcePlan 实例对象

• 示例

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

remarks()

配置备注

remarks: (remark: string) => ResourcePlan;

• 参数

  • remark：备注

• 返回类型

  • ResourcePlan 实例对象

• 示例

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

apply()

提交修改

apply: () => Promise<any>;

• 参数

  • 无

• 返回类型

  • Promise<any>

• 示例

const sources = plan.create("xxx");
sources.apply();