Kick your JSON's ass, with json-statham's help.
JavaScript
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test
.eslintrc.json
.gitignore
.travis.yml
CHANGELOG.md
LICENSE
README.md
gulpfile.js
index.js
json-statham.d.ts
package.json
stathams.jpg
typings.json

README.md

json-statham

Build Status

Kick your JSON's ass, with json-statham's help. Extends Homefront.

Statham is awesome man

Makes working with javascript objects and json easy.

Installation

npm i --save json-statham

Tests

npm test

Usage

This module extends Homefront. It's essentially the same, except for some additional methods, and an extended constructor.

Using Statham

All arguments are optional.

let Statham = require('json-statham').Statham;
let statham = new Statham({data: 'here'}, Statham.MODE_NESTED, 'path/to/file');

Using .setFileLocation()

let Statham = require('json-statham').Statham;
let statham = new Statham();

statham.setFileLocation('./foo/ray-liotta.json'); // Used by .save()

Using .save()

let Statham = require('json-statham').Statham;
let statham = new Statham();

statham.save().then(() => {/* Really does return a promise, I promise. */});
statham.save('./json-flemyng.json');        // Specific file
statham.save(true);                         // Create path for file, too
statham.save('./matt-schulze.json', true);  // Both options

Using .fromFile(fileName[, ensureFileExists=false])

This method allows you to tell Statham to fetch the contents of a file itself. When ensure has been set to true, statham will create the provided file if it doesn't exist yet. This method returns a promise, and resolves with a statham instance (as described above).

let Statham = require('json-statham').Statham;

Statham.fromFile(__dirname + '/my-data.json').then(statham => {
  // Yeeeaaah, we have a statham instance now.
});