A JSON file reading and writing utility.
JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
test
.gitignore
.travis.yml
LICENSE
README.md
index.js
package.json

README.md

DirtyDB Build Status

A JSON file reading and writing utility.

To get started, create a new instance of DirtyDB.

const instance = new DirtyDB("path/to/db.json");

Let's say the JSON file looked something like this:

{
    "languages": [
        "CoffeeScript",
        "TypeScript",
        "JavaScript"
    ],
    "best": "JavaScript"
}

Reading from a database

Now, you can read from the JSON file.

let data = instance.read(); // the entirety of the JSON data will be returned.

Alternatively, you can read only a certain datum by passing its key as a parameter to the read function, like so:

let data = instance.read("languages"); // this will return an array containing ["CoffeeScript", "TypeScript", "JavaScript"]
let data = instance.read("best"); // this will return a string containing "JavaScript"

Writing to a database

You can write to a database with the write function.

let customData = instance.read();
customData.languages.push("Dart");
instance.write(customData); // the JSON file is modified to include "Dart" in the "languages" array.

Data manipulation

.forEach

The forEach method takes a function as a single parameter. That function is then called with the following arguments:

instance.forEach(function(value, key, db) {});