脚本API

强烈推荐使用Typescript开发脚本，以获取完整的IDE提示

脚本文件是一个ESModule，并export一个函数作为默认export

最小化实例：

import { JobStatus, Routine } from "../types";

export default function (): Routine {
  return {
    displayName: "A New Routine",
    version: "0.1.0",
    id: "io.github.puppilot-org.puppilot-routines.<your-name>.<your-routine-id>",

    async start() {
      return {
        status: JobStatus.Dismissed,
        message: "Not implemented yet",
      };
    },
  };
}

属性

属性必要类型描述示例
id是string脚本的ID，遵守Java包命名规范io.github.user.routine-name
com.your-own-domain.project-name.routine-name
displayName是string脚本名，与name没有区别
version是string |
number |
Array[string | number]		脚本的版本号，用于控制自动更新1
"1.0.0"
[1, 0, 0]
"1.0.0-beta.1"
[1, 0, 0, "beta", 1]
author否string脚本作者
reportEmail否string作者的电子邮箱或者其他报告问题的邮箱
reportUrl否string作者的主页或者其他联系方式
descriptionnostring脚本说明，没有长度限制
altNamesnoArray[string]别名，用于搜索
timeLimitnonumber脚本时间限制（毫秒），默认为2分钟

方法

start

async start({ getPage, getStore }, { puppeteer }) => Promise<JobResult>

参数

getPage() 创建一个新的浏览器标签页，返回一个puppeteer Page对象。
getStore() 返回一个内部Store对象。
puppeteer puppeteer包(常用的包会作为参数传进，以减小脚本文件的体积)

对象

Store

Stores用于持久储存用户数据，数据保存在用户的puppilot-data文件夹下

方法

Store.set(key:string, value: any) 保存一个数据，value必须是可以被JSON序列化的对象
Store.get(key: string) 获取一个数据，结果为和保存的数据对象

Last Updated: