Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

long-long-job

pldin6013MIT1.0.4

Library for execution of long jobs with resume support.

readme

long-long-job

Build Status Coverage Status

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

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

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

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));