https://github.com/derhuerst/abstract-scheduler

An interface and test suite to implement various scheduling algorithms.
https://github.com/derhuerst/abstract-scheduler

interface scheduler scheduling spec

Last synced: 6 days ago
JSON representation

An interface and test suite to implement various scheduling algorithms.

• Host: GitHub
• URL: https://github.com/derhuerst/abstract-scheduler
• Owner: derhuerst
• License: isc
• Created: 2018-07-14T13:55:30.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-01-06T16:47:19.000Z (almost 5 years ago)
• Last Synced: 2024-10-03T06:28:22.326Z (about 1 month ago)
• Topics: interface, scheduler, scheduling, spec
• Language: JavaScript
• Homepage: https://github.com/derhuerst/abstract-scheduler#abstract-scheduler
• Size: 12.7 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license.md

Awesome Lists containing this project

README

        
# abstract-scheduler

**An interface and test suite to implement various [scheduling algorithms](https://en.wikipedia.org/wiki/Scheduling_(computing)#Scheduling_disciplines).** The goal is to define a simple and flexible standard for libraries that implement scheduling algorithms, so that you can replace them easily.

```js

const createScheduler = require('any-abstract-scheduler-compatible')

const servers = createScheduler(['1.example.com', '2.example.com'])

servers.get() // '1.example.com'

servers.get() // '2.example.com'

servers.get() // '1.example.com'

```

[![npm version](https://img.shields.io/npm/v/abstract-scheduler.svg)](https://www.npmjs.com/package/abstract-scheduler)

[![build status](https://api.travis-ci.org/derhuerst/abstract-scheduler.svg?branch=master)](https://travis-ci.org/derhuerst/abstract-scheduler)

![minimum Node.js version](https://img.shields.io/node/v/abstract-scheduler.svg)

![ISC-licensed](https://img.shields.io/github/license/derhuerst/abstract-scheduler.svg)

## `abstract-scheduler`-compatible modules

Send a PR by adding yours!

- [`@derhuerst/round-robin-scheduler`](https://github.com/derhuerst/round-robin-scheduler) – A [round-robin](https://en.wikipedia.org/wiki/Round-robin_scheduling) scheduler.

## Badge

Include this badge if you make a library compatible with `abstract-scheduler`.

[![compatible with abstract-scheduler](https://unpkg.com/abstract-scheduler@4/badge.svg)](readme.md)

```md

[![compatible with abstract-scheduler](https://unpkg.com/abstract-scheduler@4/badge.svg)](https://github.com/derhuerst/abstract-scheduler)

```

## How to test for `abstract-scheduler` compatibility

```shell

npm i abstract-scheduler --save-dev

```

Include this in your test file:

```js

const runAbstractSchedulerTests = require('abstract-scheduler')

const createMyScheduler = require('.')

runAbstractSchedulerTests(createMyScheduler)

```

[`tape`](https://npmjs.com/package/tape) will be used to test, writing [TAP](https://testanything.org) to `stdout`.

## The `abstract-scheduler` API

### `createScheduler(values = [])`

Create an empty scheduler or provide some initial values.

### `scheduler.add(value)`

Add a value to the scheduler. Returns the (`0`-based) index of the stored value.

### `scheduler.remove(i)`

Remove a value by (`0`-based) index. Returns `true` if the scheduler contained value, `false` otherwise.

### `scheduler.has(value)`

Checks whether the given value is already in the scheduler. Returns either `true` or `false`.

### `scheduler.get()`

Get the next value according to the scheduling algorithm.

## Related

`abstract-scheduler` is inspired by [`abstract-chunk-store`](https://github.com/mafintosh/abstract-chunk-store), [`abstract-blob-store`](https://github.com/maxogden/abstract-blob-store) and [`abstract-point-store`](https://github.com/noffle/abstract-point-store).

## Contributing

If you have a question or need support using `abstract-scheduler`, refer to [the issues page](https://github.com/derhuerst/abstract-scheduler/issues).