ar

auto-reload

For node.js to reload the module automaticly.

Showing:

Popularity

Downloads/wk

115

GitHub Stars

20

Maintenance

Last Commit

1yr ago

Contributors

2

Package

Dependencies

0

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

node-reload

For node.js to reload the module ,which was to be load by require, automaticly.

Install

npm install auto-reload

Example

Reload Json

test/data/json.json

{
  "rand": 0,
  "list": [{
    "name": "Alan"
  }]
}

test/json.js

const fs = require('fs');
const reload = require('auto-reload');
const data = reload('./data/json'); // reload after file changed

// print data every sec
setInterval(() => {
  console.log(data.rand, data.list[0].name);
}, 1000);

// update data.json after startup
setTimeout(() => {
  const text = `{
  "rand": ${Math.random()},
  "list": [{
    "name": "Test"
  }]
}`;
  fs.writeFileSync(path.join(__dirname, './data/json.json'), text);
}, 0);

Result:

0 'Alan'
0 'Alan'
0 'Alan'
0 'Alan'
0.41179045320583496 'Test'

Reload Js file

Realod function haven't support

test/data/code.js

module.exports = {
  num: 0,
  str: 'string',
  obj: {
    name: 'Alan',
    age: 18
  },
  list: [1,3,5,7,9]
};

test/code.js

const reload = require('../');
const data = reload('./data/code');

// print data from module every sec
setInterval(function() {
  console.log(new Date, data);
}, 1000);

// If you update the `time` in test/data/code.js
// the output will change immediately

Aims

  • auto reload json file
  • auto reload js file
  • fix memory leak
  • provide more options (include logger etc.)
  • rewrite with promise (include improve exception catch)
  • add tests with ava

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100