repeat

create repeating task chains

Contents

• Features
• Install
• Chain
• Contributing

Features

• [x] Chain any number of tasks and repeat them once or forever.
• [x] Optional synchronous and asynchronous API.

Install

From NPM:

> npm i repeat

Chain

Creating a new chain

The following chain will execute all tasks every second. A task is any callable function.

// ES6
import { Chain } from 'repeat'

// ES5
// let { Chain } = require('repeat')

let chain = new Chain()

chain
  .add(
    // task A
    () => console.log('how are you?'),
    // task B
    () => console.log('good')
    // you can add task C, D, E, F ...
  )
  .every(1000)

Examples

The following methods are available on the chain.

• add
• once
• every
• forever
• cancel

add

// add any number of tasks to the chain
chain.add(
  () => console.log('cat'),
  () => console.log('dog'),
  () => console.log('fish')
)

once

// execute the tasks once
chain.once()

every

// execute the tasks asynchronously every second
chain.every(1000)

forever

// execute the tasks as fast as possible
chain.forever()

cancel

// halt further execution of tasks
chain.cancel()

Contributing

Pull requests are encouraged. 😁