Git Product home page Git Product logo

jdrop's Introduction

jdrop

Seems like everyone who's written a Node app has also written a JSON file storage module. I guess I'm no exception. Here's my rationale for publishing jdrop:

  • It supports updating only a portion of a JSON file without overwriting changes a concurrent user may have made in another portion of the file.
  • Escapes HTML
  • Uses promises instead of callbacks
  • You can choose an error handling option:
    • Catch a rejected promise
    • Let jdrop autocatch errors
    • Provide your own autocatch handler

Usage

const jdrop = require('jdrop')({
		path: 'data',
		autocatch: true
	});

let data = {
	post: {
		body: 'hello'
	}
};

// save data
jdrop.put('posts', data).then(posts => {
	// stuff here runs after data is saved
});

// update part of a file
jdrop.put('posts', 'HI!', 'post.body').then(posts => {
	// stuff here runs after data is saved
});

// get data
jdrop.get('items').then(items => {
	// do stuff with items...
});

// delete part of a file
jdrop.del('items', 'key.example[3].item').then(items => {
	// stuff here runs after the file is altered
});

// delete a file
jdrop.del('items').then(() => {
	// stuff here runs after the file is deleted
});

Settings

When you initialize jdrop, you can pass a config object with two optional settings.

path is the directory in which to store JSON files. The keys you use to access files are paths relative to this directory. The default path is data.

autocatch controlls error handling behavior. The default behavior uses a promise rejection, which you can handle thusly:

jdrop.get('items').then(items => {
	// do stuff...
}).catch(err => {
	console.error(err);
});

If you set autocatch to true, jdrop will no longer reject promises. Instead, it will log the error and end the process with exit code 1.

Alternatively, you can supply a function to the autocatch setting. This function will be passed any error objects that arise. You can use this to send an error to the client without crashing.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.