Security News
The Push to Ban Ransom Payments Is Gaining Momentum
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
simple-json-db
Advanced tools
Readme
A simple, no-frills, JSON storage engine for Node.JS with full test coverage.
npm install --save simple-json-db
const JSONdb = require('simple-json-db');
const db = new JSONdb('/path/to/your/database.json');
The prototype of the constructor is new JSONdb(string, [object])
, and you can supply the optional options
object by giving it as second parameter:
const db = new JSONdb('/path/to/your/database.json', { ... });
See the Options section for more details.
Key | Value type | Description | Default value |
---|---|---|---|
asyncWrite | Boolean | Enables the storage to be asynchronously written to disk. | false (synchronous behaviour) |
syncOnWrite | Boolean | Makes the storage be written to disk after every modification. | true |
jsonSpaces | Number | The number of spaces used for indentation in the output JSON. | 4 |
db.set('key', 'value');
The key
parameter must be a string, value
can be whatever kind of object can be stored in JSON format. JSON.stringify()
is your friend!
db.get('key');
The key
parameter must be a string. If the key exhists its value is returned, if it doesn't the function returns undefined
.
db.has('key');
The key
parameter must be a string. If the key exhists true
is returned, if it doesn't the function returns false
.
db.delete('key');
The key
parameter must be a string. The function returns as per the delete operator if the key exhists, else it returns undefined
.
db.sync();
This function writes the JSON storage object to the file path specified as the parameter of the main constructor. Consult the Options section for usage details; on default options there is no need to manually invoke it.
db.JSON();
This will return a copy of the internal JSON storage object, for you to tinker with and loop over.
db.JSON({ data });
Giving a parameter to the JSON
function makes the object passed replace the internal one. Be careful, as there's no way to recover the old object if the changes have already been written to disk.
Run npm test
to start the combined Mocha & Chai testing suite.
FAQs
A simple, no-frills, JSON storage engine for Node.JS
We found that simple-json-db 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.
Security News
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
Application Security
New SEC disclosure rules aim to enforce timely cyber incident reporting, but fear of job loss and inadequate resources lead to significant underreporting.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).