edit-json-file
Advanced tools
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("city\\.name", "anytown");
file.set("name.first", "Johnny");
file.set("name.last", "B.");
file.set("is_student", false);
//Create or append to an array
file.append("classes", "fysics");
//You can even append objects
file.append("classes", { class: "Computer Science", where: "KULeuven" });
// Output the content
console.log(file.get());
// { planet: 'Earth',
// city.name: 'anytown',
// name: { first: 'Johnny', last: 'B.' },
// is_student: false,
// classes: [
// 'fysics',
// {
// 'class': 'Computer Science',
// 'where': 'KULeuven'
// }
// ]
// }
//if you want to remove the last element from an array use pop
file.pop("classes")
// 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:
JsonEditor(path, options)path: The path to the JSON file.options: An object containing the following fields:stringify_width (Number): The JSON stringify indent width (default: 2).stringify_fn (Function): A function used by JSON.stringify.stringify_eol (Boolean): Wheter to add the new line at the end of the file or not (default: false)ignore_dots (Boolean): Wheter to use the path including dots or have an object structure (default: false)autosave (Boolean): Save the file when setting some data in it.JsonEditor instance.set(path, value)Set a value in a specific path.
path: The object path.value: The value.JsonEditor instance.get(path)Get a value in a specific path.
path:unset(path)Remove a path from a JSON object.
path: The object path.JsonEditor instance.append(path, value)Appends a value/object to a specific path. If the path is empty it wil create a list.
path: The object path.value: The value.JsonEditor instance.append(path)pop Pop an array from a specific path.
path: The object path.JsonEditor instance.read(cb)Read the JSON file.
cb: An optional callback function which will turn the function into an asynchronous one.read(The, cb)write Write the JSON file.
The: file content.cb: An optional callback function which will turn the function into an asynchronous one.JsonEditor instance.empty(cb)Empty the JSON file content.
cb: The callback function.save(cb)Save the file back to disk.
cb: An optional callback function which will turn the function into an asynchronous one.JsonEditor instance.toObject()editJsonFile(path, options)Edit a json file.
path: The path to the JSON file.options: An object containing the following fields: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 :rocket:
—I love books! I will remember you after years if you buy me one. :grin: :book:
—You can make one-time donations via PayPal. I'll probably buy a coffee tea. :tea:
—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! :heart:
If you are using this library in one of your projects, add it in this list. :sparkles:
@airbnb/nimbusjson-config-ts@formbird/core@dolittle/vanir-cli@williarts/williarts-commonsmenreiki2@wonderland/cli-plugin-new@wonderland/cli-plugin-serverlesssoft-add-dependenciesnext-nodecms@neutralinojs/neugyaon-cli@allmywallets/specificationeasybackuppandocumentsdeyarnmenreikiwebify-generatorlive-stream-radiosheetbase-cliuiseedsextracctblip-langreturrn@malmo/cli@xploration-tech/xtouchenv-to-now-json@fanxie/cli@superjs/require-autosisbacklyolazlodbjad-node-ts-kitzoral-generatorfix-package-versionsblazar-cliss-clean-slategit-normalizereact-native-dom-expofixed-minor-patch-package-jsonpipe-boynode-rg@hyron/clinoir-wp-cli@johnlindquist/next-lessonbt-translatedeployqbcreate-next-libraryreact-easy-boilerplatecmd-assistantpush-notifier@perlatsp/devild@kcom/package-toolsgrafpadkanuki-clibucket-cliaxereos-hopesadmooh-cli@aquestsrl/create-app-cliintelliterkarmacv-themesgitversion-tool@wonderland/new@openstfoundation/openst-platformcucu-generatortypescript-fastify-startertypescript-koa-startertypescript-react-startertypescript-react-native-starterproject-initializerpackage-to-localexpress-react-generator-typescriptreact-sgh-scaffoldingstripletiffe-clivcommit-cligenerator-brei-nextbhc-cliiffe-commit@empirica/meteor-deployexpress-generator-typescript-k8srobinhood-yolocreate-itk-appmalmonew-express-appmonstro@marvinkome/create-node-app@triptyk/nfw-clijollof-clijollofjsootb-express-app@postlight/node-typescript-starter-kit@anyopsos/climongoose-auto-api.clitail-react@wizwarrior/node.tstypescript-nest-starter@aburkov/scriptsd-bot-scriptguser@frdl/frdl@frdl/legacy-and-deprecations-fallbackforcemanager-clitypescript-vue-starterbloggify-toolsnode-file-revsimple-webpack-starterbo-api-startergrelease@rajzik/lumos@sevta/cliplop-pack-gatsby-starterbaelte-cliontrac@chakra-ui/codemoddef-struct@farazahmad759/dricup-crud-expressplop-pack-sanity-starter@acanto/october-scripts@acanto/workflowcreate-express-templatedricup@dricup/dricup-clidricup-climodern-project-generator@dolittle/webpack@jianghe/sand-clicli-json-edit@hayes0724/shopify-packer@teamhive/angular-npm-seed@elastosfoundation/trinity-cligenerator-brei-appmy-chakra-uicreate-express-typescript-application@mianfrigo/express-typescript-generator@s-ui/changelogdex-cli@ps-devs/shopify-webpack@j.u.p.iter/jupiter-scripts@acanto/laravel-scriptscreate-nuxt-typescript-componentkikdkapesemcom@tinyhttp/cli@bronzw/create-discord-js-bot@grogqli/servernipinittypescript-express-starter@something.technology/core@oriflame/lumosexpress-generator-typescript@dolittle/vanir-commonFAQs
Edit a json file with ease.
The npm package edit-json-file receives a total of 80,542 weekly downloads. As such, edit-json-file popularity was classified as popular.
We found that edit-json-file demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
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.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.