Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
self-reload-json
Advanced tools
Readme
Simple node.js module which will auto reload specified JSON file. The instance created with this module will act as the parsed JSON object itself once loaded, you can read and write JSON content directly with the instance, also it will update automatically when the source JSON file is changed. Optional there is a save function that allows you write the modified data back into the JSON file.
With NPM:
$ npm install self-reload-json
Then in script file:
var SelfReloadJSON = require('self-reload-json');
To load a JSON file:
var config = new SelfReloadJSON(___dirname + '/config.json');
Then all loaded JSON content will be the part of the instance, just change it freely, then you can use the save function to save the changes back to the JSON file.
The SelfReloadJSON
class itself inherits EventEmitter
.
new SelfReloadJSON(options | fileName)
Construct the instance of self reload JSON file.
'utf8'
.true
if you want to keep the removed properties in the instance. Default is false
.'native'
or 'polling'
, default is 'native'
, defines what method to determine the changes of JSON file. 'native'
mode will use system API to detect, and 'polling'
mode will poll the modefied time of the JSON file. In the most case 'native' is more efficient, but some of the operating system does not support this, in this case 'polling'
should be used as fallback.5000
milliseconds.null
.save
(see below). Default is null
.stop()
Stop watching the changes of the JSON file. You can use resume
to continue watching the changes.
resume()
Start to watch the changes of the JSON file. In default, this is automatically called after instance construction.
forceUpdate()
Force update the JSON file.
save(options)
Write the changes back to the JSON file.
JSON.stringify
. Default is null
.As this class is also inherits from EventHandler
class of Node.JS, it will expose 2 event types with event handler.
on('updated', function(json) { ... })
This event will be emitted after the JSON content refreshed. The json
parameter is the raw parsed JSON object (not the SelfReloadJSON instance itself).
on('error', function(err) { ... })
This event will be emitted while error occured when loading the updated JSON file. The err
parameter will be the error thrown by the updater.
If a property name conflicts with the function names described above, they will be ignored. To get those values you should use updated
event listener instead.
FAQs
Self reloading JSON handler
The npm package self-reload-json receives a total of 20 weekly downloads. As such, self-reload-json popularity was classified as not popular.
We found that self-reload-json demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.