Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

json-update

Package Overview
Dependencies
Maintainers
1
Versions
20
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

json-update

Allows for very simple JSON file updating in one line

  • 5.3.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

This is a simple way to update (or load) a JSON file. If the JSON file does not exist it will be created (along with a directory structure if those directories don't exist yet).

Uses underscore to extend existing JSON data with the object you specify, overriding anything with an existing property and adding properties if they are new.

NEW: You may change the extend behavior by calling config({deep:true}) before calling update. This will use deep-extend instead of underscore extend to merge the data when you call update.

New version supports promises (and async/await with babel).

npm install json-update

Updating a JSON file (and return the new object) (with promise):

json = require('json-update');

json.update('data.json',{test:10})
.then(function(dat) { 
  console.log(dat.test) 
});

With async/await (you must use babel with babel-polyfill etc. as with all use of async/await):

import {update, load} from 'json-update';

async function test() {
  await update('t.json', {x:2});
  let dat = await load('t.json');
  console.log(dat.x);
}

test().then(()=> {}).catch( e=> {console.error(e)}); 

With a callback:

json = require('json-update')

json.update('data.json', { test: 'value x' }, function(err, obj) {
  if (typeof err !== "undefined" && err !== null) {
    console.log("Error updating json: " + err.message);
  }
  console.log(obj);
});

Loading a JSON file (note that in the case of loading a valid JSON file must already exist):

json = require('json-update')

json.load('data.json', function(err, obj) {
  console.log("Loaded from json:");
  console.log(obj);
});

Keywords

FAQs

Package last updated on 26 Dec 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc