Edit a json file with ease.
# Using npm
npm install --save edit-json-file
# Using yarn
yarn add edit-json-file
const editJsonFile = require("edit-json-file");
// If the file doesn't exist, the content will be an empty object by default.
let file = editJsonFile(`${__dirname}/foo.json`);
// Set a couple of fields
file.set("planet", "Earth");
file.set("name.first", "Johnny");
file.set("name.last", "B.");
file.set("is_student", false);
// Output the content
console.log(file.get());
// { planet: 'Earth',
// name: { first: 'Johnny', last: 'B.' },
// is_student: false }
// Save the data to the disk
file.save();
// Reload it from the disk
file = editJsonFile(`${__dirname}/foo.json`, {
autosave: true
});
// Get one field
console.log(file.get("name.first"));
// => Johnny
// This will save it to disk
file.set("a.new.field.as.object", {
hello: "world"
});
// Output the whole thing
console.log(file.toObject());
// { planet: 'Earth',
// name: { first: 'Johnny', last: 'B.' },
// is_student: false,
// a: { new: { field: [Object] } } }
There are few ways to get help:
-
Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
-
For bug reports and feature requests, open issues. 🐛
-
For direct and quick help, you can use Codementor. 🚀
- String
path
: The path to the JSON file. - Object
options
: An object containing the following fields: stringify_width
(Number): The JSON stringify indent width (default:2
).stringify_fn
(Function): A function used byJSON.stringify
.autosave
(Boolean): Save the file when setting some data in it.
- JsonEditor The
JsonEditor
instance.
Set a value in a specific path.
- String
path
: The object path. - Anything
value
: The value.
- JsonEditor The
JsonEditor
instance.
Get a value in a specific path.
- String
path
:
- Value The object path value.
Remove a path from a JSON object.
- String
path
: The object path.
- JsonEditor The
JsonEditor
instance.
Read the JSON file.
- Function
cb
: An optional callback function which will turn the function into an asynchronous one.
- Object The object parsed as object or an empty object by default.
write Write the JSON file.
- String
The
: file content. - Function
cb
: An optional callback function which will turn the function into an asynchronous one.
- JsonEditor The
JsonEditor
instance.
Empty the JSON file content.
- Function
cb
: The callback function.
Save the file back to disk.
- Function
cb
: An optional callback function which will turn the function into an asynchronous one.
- JsonEditor The
JsonEditor
instance.
- Object The data object.
Edit a json file.
- String
path
: The path to the JSON file. - Object
options
: An object containing the following fields:
- JsonEditor The
JsonEditor
instance.
Have an idea? Found a bug? See how to contribute.
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
-
Starring and sharing the projects you like 🚀
-
—I love books! I will remember you after years if you buy me one. 😁 📖
-
—You can make one-time donations via PayPal. I'll probably buy a
coffeetea. 🍵 -
—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
-
Bitcoin—You can send me bitcoins at this address (or scanning the code below):
1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6
Thanks! ❤️
If you are using this library in one of your projects, add it in this list. ✨
blip-lang
(by Joshua Barnett)—A programming languagebloggify-tools
—Interactive command line tool to help you win at Bloggify.deyarn
(by Spencer Brown)—A command-line tool for converting projects that use Yarn to npm.easybackup
(by Bruno Morceli - [email protected])—Easy way to backup/restore multiple mongodb databases.extracct
(by awyerbx)—Node Modulefix-package-versions
(by Jose Segura García)—This is the first approach to a fix package.json versionsgyaon-cli
(by stkay)—jollof-cli
(by Iyobo Eki)—The Entry point to creating and working with Jollof Projectsjollofjs
(by Iyobo Eki)—The Entry point to creating and working with Jollof Projectslive-stream-radio
(by Aaron Turner)—24/7 live stream video radio station CLI / APIlyo
(by Boris K)—Node.js to browser - The easy waymenreiki-init
—用于创建menreiki项目骨架menreiki2
(by 汗僧)—ssr with reactnode-file-rev
(by Lukas Oppermann)—Simple node cli tool to revision files and write them to a rev-manifest.jsonpandocuments
(by Constantine Theocharis)—A pandoc helper to quickly initialize school papers (very opinionated)pipe-boy
(by Scott McKenzie)—Interactive CLI to pass output from one command as input to anotherproject-initializer
(by Linesh)—A command utility to different kinds of projects with different tech stacks.returrn
(by awyerbx)—Return everything you need.uiseeds
(by Victor Chavez)—uiseeds is an easy to use tool to create seed projects for Angularwebify-generator
(by Santiago D´Antuoni)—A web application generator