Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brendanashworth/flatfile
basic JSON-style flatfile storage
https://github.com/brendanashworth/flatfile
Last synced: 9 days ago
JSON representation
basic JSON-style flatfile storage
- Host: GitHub
- URL: https://github.com/brendanashworth/flatfile
- Owner: brendanashworth
- License: mit
- Created: 2014-06-07T19:48:19.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-09-25T20:56:42.000Z (about 8 years ago)
- Last Synced: 2023-10-20T18:28:45.561Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 21.5 KB
- Stars: 6
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
flatfile [](https://travis-ci.org/brendanashworth/flatfile) [](https://codecov.io/gh/brendanashworth/flatfile)
=====
> flatfile is a very simple library for storing, retrieving, and setting JSON data in a flatfile. The library focuses on ease of use and simplicity. Getting up and running is extremely simple and does not require installing any database software.
## Install
```bash
$ npm i flatfile --save
```
The module supports node v0.10, v0.12, and all major releases afterwards.
## Usage
```javascript
const flatfile = require('flatfile');
// Load a flatfile database based on file: myfile.json
flatfile.db('data.json', function(err, data) {
if (err) throw err;
// Manipulate data like a JS Object
data.numbers.filter(function(x) {
return x % 3 == 1;
}).map(Math.pow).forEach(function(x) {
data.output[x] = (Math.sin(x) > 0.5);
});
// Save to the file.
data.save(function(err) {
if (err) throw err;
});
});
```
## Documentation
### Init database
```javascript
flatfile.db(filename, function(err, data))
```
This is a very simple, asynchronous function for initiating the database. After reading the file and parsing to an object, it will return the object via the callback data paramater. If the file does not exist, an empty object will be returned, allowing you to save it to a new file with `.save()`.
**Warning**: the `data` object that is passed from this function is not an exact copy from the file, but can be treated as such. The data object is given an extra value: `save`. `save` is a function that can be called when the database should be saved.
### Getting values
```javascript
data.myValue; // Returns the value of key myValue.
```
Getting a value from the `data` is exactly as you think it would be. Simply reference the value as a Javascript object would be referenced and the value will be there. At heart, the `data` object is truly the object representing the file, but it also contains the two special values for the library.
### Saving values
```javascript
data.myValue = 'newValue';
```
Saving a file to the database is inherently easy. Simply reference and set the value as you would with a standard Javascript object. However, do not forget to *save the changes*.
### Saving changes
```javascript
data.save(function(err));
```
Again, this is a very simple function for saving the changes to the database. You can repetitively call this function without having an issue. As a paramater, this function takes a callback function with an error paramater.
**Warning**: be aware that the data *will not automatically save*. It is necessary to call this function if you want to save the changes.
## License
[MIT](./LICENSE)