https://github.com/flosse/json-file-store
A simple JSON store for Node.js
https://github.com/flosse/json-file-store
filestore javascript json nodejs unmaintained
Last synced: 19 days ago
JSON representation
A simple JSON store for Node.js
- Host: GitHub
- URL: https://github.com/flosse/json-file-store
- Owner: flosse
- License: mit
- Archived: true
- Created: 2012-12-19T20:15:56.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2021-10-08T09:36:03.000Z (over 4 years ago)
- Last Synced: 2025-10-12T13:17:04.610Z (8 months ago)
- Topics: filestore, javascript, json, nodejs, unmaintained
- Language: JavaScript
- Homepage:
- Size: 86.9 KB
- Stars: 192
- Watchers: 7
- Forks: 18
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-github-projects - json-file-store - A simple JSON store for Node.js ⭐192 `JavaScript` (📦 Legacy & Inactive Projects)
README
# JSON file store
A simple JSON file store for node.js.
[](http://travis-ci.org/flosse/json-file-store)
[](https://gemnasium.com/flosse/json-file-store)
[](http://badge.fury.io/js/jfs)
[](https://github.com/flosse/json-file-store/blob/master/LICENCE.txt)
WARNING:
Don't use it if you want to persist a large amount of objects.
Use a real DB instead.
## Install
npm install jfs --save
## Usage
```javascript
var Store = require("jfs");
var db = new Store("data");
var d = {
foo: "bar"
};
// save with custom ID
db.save("anId", d, function(err){
// now the data is stored in the file data/anId.json
});
// save with generated ID
db.save(d, function(err, id){
// id is a unique ID
});
// save synchronously
var id = db.saveSync("anId", d);
db.get("anId", function(err, obj){
// obj = { foo: "bar" }
})
// pretty print file content
var prettyDB = new Store("data",{pretty:true});
var id = prettyDB.saveSync({foo:{bar:"baz"}});
// now the file content is formated in this way:
{
"foo": {
"bar": "baz"
}
}
// instead of this:
{"foo":{"bar":"baz"}}
// get synchronously
var obj = db.getSync("anId");
// get all available objects
db.all(function(err, objs){
// objs is a map: ID => OBJECT
});
// get all synchronously
var objs = db.allSync()
// delete by ID
db.delete("myId", function(err){
// the file data/myId.json was removed
});
// delete synchronously
db.delete("myId");
```
### Single file DB
If you want to store all objects in a single file,
set the `type` option to `single`:
```javascript
var db = new Store("data",{type:'single'});
```
or point to a JSON file:
```javascript
var db = new Store("./path/to/data.json");
```
### In memory DB
If you don't want to persist your data, you can set `type` to `memory`:
```javascript
var db = new Store("data",{type:'memory'});
```
### ID storage
By default the ID is not stored within your object.
If you like, you can change that behavior by setting `saveId` to `true`
or a custom ID
```javascript
var db = new Store("data",{saveId:'myKey'});
```
### custom ID generator
We use uuid v4 for ID generation if you don't pass an id when save a data. If you want, you can pass custom generator.
```javascript
var i = 0;
var db = new Store("data",{
idGenerator: function() {
i = i + 1;
return i;
}
});
```
## Tests
npm test
## License
This project is licensed under the MIT License.