README.md

Reloader

Purpose

Minimalist, efficient and performance focused module to run a function at a specific interval.

Compatibility

/!\ This module use async/await syntax, this is why you must have node 7.6+.

Supported and tested : >= 14

Version	Supported	Tested
18.x	yes	yes
16.x	yes	yes
14.x	yes	yes
12.x	no	yes
10.x	no	yes
9.x	no	yes
8.x	no	yes
>= 7.6	no	yes

Installation

$ npm install @voodoo.io/reloader --save

Usage

Instantiation & init

const ConfigManager = require('@voodoo.io/reloader')
const configManager = new ConfigManager()

// create a config function that should be run every 2 seconds
configManager.addFunction("config", async () => {
  // my stuff to reload here ....
}, 2000)

await configManager.init()

Basic usage

If your function returns a result it's accessible through "get" method.

configManager.get('config')
// or
configManager.getAll()

Constructor params

Params	description	Default value
delay	Interval in ms between two check, only	60000 (1min)
	one timer is used to check each function

Test

$ npm test

Coverage report can be found in coverage/.