Task scheduler for managing and executing tasks with pipeline support.

Install

- npm

``bash
npm install --save @guanghechen/scheduler
`

- yarn

`bash
yarn add @guanghechen/scheduler
`

Usage

| Name | Description |
| :-------------: | :-------------------------------------------------------: |
| Scheduler | Task scheduler with pipeline and strategy support |
| Pipeline | Processing pipeline for transforming data |

Example

- Basic scheduler:

`typescript
import { Scheduler, Pipeline } from '@guanghechen/scheduler'
import { TaskStrategyEnum } from '@guanghechen/task'

// Create a pipeline for processing items
const pipeline = new Pipeline('my-pipeline')

// Add material cookers to the pipeline
pipeline.use({
name: 'uppercase-cooker',
cook: async (data, embryo, api, next) => {
const processed = data.toUpperCase()
return next(processed)
}
})

// Create scheduler
const scheduler = new Scheduler({
name: 'my-scheduler',
pipeline,
strategy: TaskStrategyEnum.ABORT_ON_ERROR
})

// Schedule items for processing
await scheduler.schedule('hello')
await scheduler.schedule('world')

// Start processing
await scheduler.start()
`

- Custom pipeline with multiple stages:

`typescript
import { Pipeline } from '@guanghechen/scheduler'

interface DataItem {
id: number
content: string
}

const pipeline = new Pipeline('processing-pipeline')

pipeline.use({
name: 'validator',
cook: async (data, embryo, api, next) => {
// Stage 1: Validate
if (!data.content) {
throw new Error('Content is required')
}
return next(data)
}
})

pipeline.use({
name: 'transformer',
cook: async (data, embryo, api, next) => {
// Stage 2: Transform
const transformed = [${data.id}] ${data.content.trim()}
return next(transformed)
}
})

pipeline.use({
name: 'logger',
cook: async (data, embryo, api, next) => {
// Stage 3: Output
console.log('Processed:', data)
return data
}
})
``

Reference

- [homepage][homepage]

[homepage]:
https://github.com/guanghechen/sora/tree/@guanghechen/scheduler@7.0.0/packages/scheduler#readme