rx-scheduler v0.3.0
rx-scheduler
Reactive Extensions - an object that specifies an API for scheduling units of work
Platform | Build Status |
---|---|
Linux | |
Windows |
Install
NPM
npm i rx-scheduler
CDN
- jsDelivr
<script src="https://cdn.jsdelivr.net/npm/rx-cancellable/dist/index.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/rx-scheduler/dist/index.min.js"></script>
- unpkg
<script src="https://unpkg.com/rx-cancellable/dist/index.min.js"></script>
<script src="https://unpkg.com/rx-scheduler/dist/index.min.js"></script>
Usage
Loading the module
CommonJS
const Scheduler = require('rx-scheduler');
Loading the CommonJS module provides the Scheduler class.
Browser
Loading the JavaScript file for the rx-scheduler provides the Scheduler class
Example
import Scheduler from 'rx-scheduler';
Scheduler.immediate.delay(() => console.log('Hello World, Immediate 100'), 100);
Scheduler.timeout.delay(() => console.log('Hello World, Timeout 100'), 100);
Scheduler.async.delay(() => console.log('Hello World, Async 100'), 100);
Scheduler.tick.delay(() => console.log('Hello World, Tick 100'), 100);
Scheduler.current.delay(() => console.log('Hello World, Current 100'), 100);
Scheduler.immediate.schedule(() => console.log('Hello World, Immediate'));
Scheduler.timeout.schedule(() => console.log('Hello World, Timeout'));
Scheduler.async.schedule(() => console.log('Hello World, Async'));
Scheduler.tick.schedule(() => console.log('Hello World, Tick'));
Scheduler.current.schedule(() => console.log('Hello World, Current'));
Output:
Hello World, Current
Hello World, Tick
Hello World, Async
Hello World, Timeout
Hello World, Immediate
Hello World, Current 100
Hello World, Tick 100
Hello World, Async 100
Hello World, Timeout 100
Hello World, Immediate 100
Scheduler Types
There are 4 major scheduler types
Type | Description |
---|---|
Current | Schedules the task as the next task for the current thread. |
Immediate | Schedules the task immediately for the next frame, using setImmediate (NodeJS) or requestAnimationFrame (Browser). |
Async | Schedules the task in async fashion. |
Timeout | Schedules the task using setTimeout |
There are 1 NodeJS exclusive types | Type | Description | | --- | --- | | Tick | NodeJS only. Schedules the task immediately after the current thread. |
There are 2 Browser exclusive types | Type | Description | | --- | --- | | Worker | Browser only. Schedules the task on a worker thread. The worker thread does not execute the task, but rather, the event the worker emits notifies the schedule execution. | | Pool | Browser only. Schedules the task on an idle worker from the worker pool. Like the Worker, The worker thread does not execute the task, but rather, the event the worker emits notifies the schedule execution. The time of execution may vary due to varying execution times/responses from different worker threads. |
Each scheduler types has two methods: schedule
, which executes the schedule immediately on their own threads and delay
, which schedules the function with a timer on their own threads. Both methods return a Cancellable instance, that allows you to cancel the scheduled functions if necessary.
Creating your own Scheduler
You can create your own Scheduler that is recognizable by the implementations by extending Scheduler.interface
class MyScheduler extends Scheduler.interface {
schedule(fn) {
// scheduling logic
}
delay(fn, amount) {
// delayed scheduling logic
}
}
Documentation
You can read the documentation at the official doc site
Build
Clone the repo first, then run the following to install the dependencies
npm install
To build the coverages, run the test suite, the docs, and the distributable modules:
npm run build
Changelogs
- 0.3.0
- Introduces 2 new Browser-exclusive schedulers: Worker and Pool.
- 0.2.6
- Guaranteed cancel if the schedule handlers throw an error.
- 0.2.5
- Delayed schedules with 0 time will be executed immediately.
- 0.2.2
- Compliance with rx-cancellable@0.2.0
- 0.2.1
- scheduled functions now cancels the
Cancellable
instance when finished.
- scheduled functions now cancels the
- 0.2.0
- Replaced AbortController with Cancellable.
schedule
anddelay
now returns aCancellable
to cancel schedules.
- 0.1.0
- Release