Hyper Scheduler

Appearance

API 参考 ​

Hyper Scheduler 的完整 API 文档。

核心 API ​

Scheduler ​

核心调度器类，负责任务的注册、调度和生命周期管理。

主要方法：

  • createTask() - 注册新任务
  • start() / stop() - 启动/停止调度器
  • startTask() / stopTask() - 启动/停止指定任务
  • triggerTask() - 手动触发任务
  • getTask() / getAllTasks() - 查询任务
  • deleteTask() - 删除任务
  • on() - 订阅事件

查看完整文档 →

Task ​

任务配置和运行时状态。

核心接口：

  • TaskDefinition - 任务定义
  • TaskOptions - 任务选项
  • Task - 任务运行时对象

配置选项：

  • 调度规则（Cron / 时间间隔）
  • 重试策略
  • 时区设置
  • 错误处理

查看完整文档 →

DevTools ​

浏览器环境下的可视化调试工具。

功能特性：

  • 任务列表和状态监控
  • 时间线视图
  • 执行历史
  • 实时日志

配置选项：

  • 主题模式
  • 停靠位置
  • 界面语言
  • 悬浮按钮自定义

查看完整文档 →

类型定义 ​

完整的 TypeScript 类型定义。

核心类型：

  • SchedulerConfig
  • TaskDefinition
  • TaskOptions
  • Task
  • TaskStatus
  • ExecutionRecord

插件类型：

  • HyperSchedulerPlugin
  • DevToolsOptions

查看完整文档 →

快速查找 ​

按功能分类 ​

任务管理 ​

任务控制 ​

任务配置 ​

事件监听 ​

调试工具 ​

使用示例 ​

基础用法 ​

typescript
import { Scheduler } from 'hyper-scheduler';

const scheduler = new Scheduler({ debug: true });

scheduler.createTask({
  id: 'my-task',
  schedule: '*/5 * * * * *',
  handler: () => console.log('Task executed')
});

scheduler.start();

带重试和错误处理 ​

typescript
scheduler.createTask({
  id: 'api-sync',
  schedule: '5m',
  handler: async () => {
    await syncWithAPI();
  },
  options: {
    retry: {
      maxAttempts: 3,
      initialDelay: 1000,
      factor: 2
    },
    onError: (error, taskId) => {
      console.error(`Task ${taskId} failed:`, error);
    }
  }
});

使用 DevTools ​

typescript
import { Scheduler, DevTools } from 'hyper-scheduler';

const scheduler = new Scheduler({
  plugins: [
    new DevTools({
      theme: 'dark',
      language: 'zh'
    })
  ]
});

相关链接 ​