-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Increase coverage, change error text
- Loading branch information
Showing
4 changed files
with
211 additions
and
181 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,78 +1,78 @@ | ||
| # long-long-job | ||
|
|
||
| [](https://travis-ci.org/pldin601/long-long-job) | ||
| [](https://coveralls.io/github/pldin601/long-long-job?branch=master) | ||
|
|
||
| ```basic | ||
| 10 PRINT "HELLO" | ||
| 20 GOTO 10 | ||
| ``` | ||
|
|
||
| ## What? | ||
|
|
||
| This module ables you to create a chain of tasks (computations or actions) with ability to resume run state on restart. | ||
| Each task receives state of previous task (or initial state if it is first in chain) and must return action what to do next composed with new state. | ||
|
|
||
| ## Example | ||
|
|
||
| First of all we need to define where job's state will be stored during transitions. Then we must initialize module with it. | ||
| For example, we will store state in `Map` object. This is simplest storage method and it won't preserve state during restarts. | ||
|
|
||
| ### LongLongJob.js | ||
|
|
||
| ```javascript | ||
| const { longLongJob } = require('long-long-job'); | ||
|
|
||
| const mapBasedStorage = () => { | ||
| const stateStore = new Map(); | ||
| return { | ||
| async hasState(id) { | ||
| return stateStore.has(id); | ||
| }, | ||
| async setState(id, state) { | ||
| stateStore.set(id, state); | ||
| }, | ||
| async getState(id) { | ||
| return stateStore.get(id); | ||
| }, | ||
| async clean(id) { | ||
| stateStore.delete(id); | ||
| }, | ||
| }; | ||
| }; | ||
|
|
||
| module.exports = longLongJob(mapBasedStorage()); | ||
| ``` | ||
|
|
||
| ### incrementJob.js | ||
|
|
||
| ```javascript | ||
| const LongLongJob = require('./LongLongJob'); | ||
| const { repeat, next } = require('long-long-job'); | ||
|
|
||
| const incrementJob = new LongLongJob('increment-job', [ | ||
| async ({ value, threshold }) => { | ||
| incrementJob.emit('tick', value); | ||
| return value < threshold | ||
| ? repeat({ value: value + 1, threshold }) | ||
| : next({ value, threshold }); | ||
| }, | ||
| ]); | ||
|
|
||
| module.exports = incrementJob; | ||
| ``` | ||
|
|
||
| ### main.js | ||
|
|
||
| ```javascript | ||
| const incrementJob = require('./incrementJob'); | ||
|
|
||
| incrementJob.on('start', () => console.log('Job started')); | ||
| incrementJob.on('resume', () => console.log('Job resumed')); | ||
| incrementJob.on('tick', value => console.log('Current value is %d', value)); | ||
| incrementJob.on('done', () => console.log('Job finished')); | ||
|
|
||
| incrementJob | ||
| .start({ value: 0, threshold: 1000 }) | ||
| .then(({ value }) => console.log('Task is done with value %d', value)); | ||
| ``` | ||
| # long-long-job | ||
|
|
||
| [](https://travis-ci.org/pldin601/long-long-job) | ||
| [](https://coveralls.io/github/pldin601/long-long-job?branch=master) | ||
|
|
||
| ```basic | ||
| 10 PRINT "HELLO" | ||
| 20 GOTO 10 | ||
| ``` | ||
|
|
||
| ## What? | ||
|
|
||
| This module ables you to create a chain of tasks (computations or actions) with ability to resume run state on restart. | ||
| Each task receives state of previous task (or initial state if it is first in chain) and must return action what to do next composed with new state. | ||
|
|
||
| ## Example | ||
|
|
||
| First of all we need to define where job's state will be stored during transitions. Then we must initialize module with it. | ||
| For example, we will store state in `Map` object. This is simplest storage method and it won't preserve state during restarts. | ||
|
|
||
| ### LongLongJob.js | ||
|
|
||
| ```javascript | ||
| const { longLongJob } = require('long-long-job'); | ||
|
|
||
| const mapBasedStorage = () => { | ||
| const stateStore = new Map(); | ||
| return { | ||
| async hasState(id) { | ||
| return stateStore.has(id); | ||
| }, | ||
| async setState(id, state) { | ||
| stateStore.set(id, state); | ||
| }, | ||
| async getState(id) { | ||
| return stateStore.get(id); | ||
| }, | ||
| async clean(id) { | ||
| stateStore.delete(id); | ||
| }, | ||
| }; | ||
| }; | ||
|
|
||
| module.exports = longLongJob(mapBasedStorage()); | ||
| ``` | ||
|
|
||
| ### incrementJob.js | ||
|
|
||
| ```javascript | ||
| const LongLongJob = require('./LongLongJob'); | ||
| const { repeat, next } = require('long-long-job'); | ||
|
|
||
| const incrementJob = new LongLongJob('increment-job', [ | ||
| async ({ value, threshold }) => { | ||
| incrementJob.emit('tick', value); | ||
| return value < threshold | ||
| ? repeat({ value: value + 1, threshold }) | ||
| : next({ value, threshold }); | ||
| }, | ||
| ]); | ||
|
|
||
| module.exports = incrementJob; | ||
| ``` | ||
|
|
||
| ### main.js | ||
|
|
||
| ```javascript | ||
| const incrementJob = require('./incrementJob'); | ||
|
|
||
| incrementJob.on('start', () => console.log('Job started')); | ||
| incrementJob.on('resume', () => console.log('Job resumed')); | ||
| incrementJob.on('tick', value => console.log('Current value is %d', value)); | ||
| incrementJob.on('done', () => console.log('Job finished')); | ||
|
|
||
| incrementJob | ||
| .start({ value: 0, threshold: 1000 }) | ||
| .then(({ value }) => console.log('Task is done with value %d', value)); | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.