public-interval

public-interval.js

Intro

Create a public interval handler for a group of processors.

Install

$ npm install public-interval

Usage

import PublicInterval from 'public-interval'
let pi = new PublicInterval()
pi.setProcessor('my-processor', function () {
    console.log('My processor is running.')
})
pi.go()

Option

• timer {number} Interval time of this handler.
• processor {object} Initial processors of this handler.
• autorun {boolean} Whether run this handler when initialized.

API

pi.go

• description
  • Start this interval handler.

pi.stop

• description
  • Stop this interval handler.

pi.setProcessor

• description
  • Set a new processor in this interval handler.
• param
  • name(optional) {string} The name of this processor. It's a unique value.
  • fn {function} The processor.

pi.removeProcessor

• description
  • Remove a processor in this interval by name.
• param
  • name {string} The name of a processor which works in this interval handler.

pi.setTimer

• description
  • Set interval time for this interval handler.
• param
  • time {number} The interval time of this interval handler.