Skip to content
This repository has been archived by the owner on May 28, 2024. It is now read-only.
/ jitter-time.js Public archive

Generate time periods drifted around a given value.

License

Notifications You must be signed in to change notification settings

vend/jitter-time.js

Repository files navigation

Jitter Time!

npm js-standard-style

jitter time

Generates random time periods (in milliseconds) between a max and min around the given minutes value. For example this can be used to ensure 5 minute poll requests across multiple clients don't all happen at once.

Install

$ npm install --save jitter-time

Usage

var jitterTime = require('jitter-time')

var POLL_INTERVAL = jitterTime(5, 0.2)
//=> 290110 (Random number between 240000 and 360000)

setInterval(syncDataWithServer, POLL_INTERVAL)

API

jitterTime([minutes], [jitter])

minutes

  • Type: number
  • Default: 1

Number of minutes to jitter around.

jitter

  • Type: number
  • Default: 0.1

Percentage of jitter (for setting max and min). E.g. 1 = +/-100%, 0.1 = +/-10%, etc.

Contributing

Build

npm run build

Test

npm test

Watch

To watch for changes, build them and run the tests:

npm run watch

License

MIT © Vend Ltd.