Skip to content

drmalus/node-json-file

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

node-json-file

Simple and easy Json file read/write package (utf8 compatible)

INSTALL

npm i @drmalus/json-file

IMPORT

const JsonFile = require('@drmalus/json-file');

API

  • [write(file, data)]
  • [update(file, key, value)]
  • [pushTo(file, data)]
  • [readFrom(file, defaultValue = [])]

write(file, data)

const cars = ['audi', 'bmw', 'citroen'];
JsonFile.write('cars.json', cars);

update(file, key, value)

// item.json -> {name: 'item', sku: 'oldsku'}
JsonFile.update('item.json', 'sku', 'newsku'); 
// item.json -> {name: 'item', sku: 'newsku'}

pushTo(file, data)

// products.json -> [{name: 'Phone', price: 1000}];
const newItem = [{name: 'Shoe', price: 200}];
JsonFile.pushTo('products.json', newItem);

// OR YOU CAN PUSH MULTIPLE ITEMS:

// products.json -> [{name: 'Phone', price: 1000}, {name: 'Shoe', price: 200}];
const twoMoreShoes = [{name: 'Shoe2', price: 200},{name: 'Shoe3', price: 200}];
JsonFile.pushTo('products.json', twoMoreShoes);
/* 
products.json -> [
    {name: 'Phone', price: 1000},
    {name: 'Shoe', price: 200},
    {name: 'Shoe2', price: 200},
    {name: 'Shoe3', price: 200}
];
 */

readFrom(file, defaultValue = [])

JsonFile.readFrom('contacts.json', []); 
// if contacts file missing or empty it returns []

JsonFile.readFrom('contacts.json', [{name: 'Default John', age: 33}]); 
// if contacts file missing or empty it returns [{name: 'Default John', age: 33}]

About

Simple and easy json file handler

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published