edit-json-file
Edit a json file with ease.
:cloud: Installation
npm install --save edit-json-file
yarn add edit-json-file
:clipboard: Example
const editJsonFile = require("edit-json-file");
let file = editJsonFile(`${__dirname}/foo.json`);
file.set("planet", "Earth");
file.set("city\\.name", "anytown");
file.set("name.first", "Johnny");
file.set("name.last", "B.");
file.set("is_student", false);
file.append("classes", "fysics");
file.append("classes", { class: "Computer Science", where: "KULeuven" });
console.log(file.get());
file.pop("classes")
file.save();
file = editJsonFile(`${__dirname}/foo.json`, {
autosave: true
});
console.log(file.get("name.first"));
file.set("a.new.field.as.object", {
hello: "world"
});
console.log(file.toObject());
:question: Get Help
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. :bug:
- For direct and quick help, you can use Codementor. :rocket:
:memo: Documentation
JsonEditor(path, options)
Params
- 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 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.
Return
- JsonEditor The
JsonEditor
instance.
set(path, value)
Set a value in a specific path.
Params
- String
path
: The object path. - Anything
value
: The value.
Return
- JsonEditor The
JsonEditor
instance.
get(path)
Get a value in a specific path.
Params
Return
- Value The object path value.
unset(path)
Remove a path from a JSON object.
Params
- String
path
: The object path.
Return
- JsonEditor The
JsonEditor
instance.
append(path, value)
Appends a value/object to a specific path.
If the path is empty it wil create a list.
Params
- String
path
: The object path. - Anything
value
: The value.
Return
- JsonEditor The
JsonEditor
instance.
pop(path)
Pop an array from a specific path.
Params
- String
path
: The object path.
Return
- JsonEditor The
JsonEditor
instance.
read(cb)
Read the JSON file.
Params
- Function
cb
: An optional callback function which will turn the function into an asynchronous one.
Return
- Object The object parsed as object or an empty object by default.
read(The, cb)
write
Write the JSON file.
Params
- String
The
: file content. - Function
cb
: An optional callback function which will turn the function into an asynchronous one.
Return
- JsonEditor The
JsonEditor
instance.
empty(cb)
Empty the JSON file content.
Params
- Function
cb
: The callback function.
save(cb)
Save the file back to disk.
Params
- Function
cb
: An optional callback function which will turn the function into an asynchronous one.
Return
- JsonEditor The
JsonEditor
instance.
toObject()
Return
editJsonFile(path, options)
Edit a json file.
Params
- String
path
: The path to the JSON file. - Object
options
: An object containing the following fields:
Return
- JsonEditor The
JsonEditor
instance.
:yum: How to contribute
Have an idea? Found a bug? See how to contribute.
:sparkling_heart: Support my projects
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:
:dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:
@acanto/laravel-scripts
@dolittle/vanir-features
@airbnb/nimbus
json-config-ts
@dolittle/vanir-cli
soft-add-dependencies
@williarts/williarts-commons
@wonderland/cli-plugin-serverless
@wonderland/cli-plugin-new
@formbird/core
@neutralinojs/neu
bo-admin-starter
admooh-cli
deploi
express-generator-typescript
live-stream-radio
sheetbase-cli
extracct
semcom
lyo
@empirica/meteor-deploy
noir-wp-cli
@johnlindquist/next-lesson
typescript-react-native-starter
create-itk-app
jollofjs
@frdl/legacy-and-deprecations-fallback
grelease
@sevta/cli
baelte-cli
plop-pack-sanity-starter
modern-project-generator
nipinit
pipe-boy
monstro
create-fw
vcommit-cli
bhc-cli
@bronzw/create-discord-js-bot
simple-rtg
fluxxo-generator
robinhood-yolo
create-next-library
bt-translate
bo-api-starter
fixed-minor-patch-package-json
zoral-generator
react-native-dom-expo
blazar-cli
@postlight/node-typescript-starter-kit
uiseeds
webify-generator
@mtmeyer/create-react-figma-plugin
@fanxie/cli
@malmo/cli
@xploration-tech/xtouch
kikd
@aquestsrl/create-app-cli
menreiki
@something.technology/core
nodman-cli
create-ts-jest
@openstfoundation/openst-platform
bucket-cli
@dricup/dricup-cli
gitversion-tool
@wonderland/new
intelliter
typescript-fastify-starter
express-react-generator-typescript
@teamhive/angular-npm-seed
@imklau/react-app
guser
ootb-express-app
@marvinkome/create-node-app
dricup-cli
d-bot-script
@farazahmad759/dricup-crud-express
ontrac
@acanto/october-scripts
my-chakra-ui
push-notifier
cmd-assistant
mf-webpack-plugin
env-to-now-json
@dolittle/vanir-common
git-normalize
typescript-express-starter
menreiki2
simple-etg
kape
bloggify-tools
@perlatsp/devild
@superjs/require-auto
typescript-vue-starter
karmacv-themes
package-to-local
@panfilo/express-template
@mianfrigo/express-typescript-generator
@j.u.p.iter/jupiter-scripts
check-dependency-version-consistency
@quantform/cli
malmo
typescript-nest-starter
simple-webpack-starter
iffe-cli
react-sgh-scaffolding
easybackup
@allmywallets/specification
@sapling/cli
dricup
generator-brei-next
@chakra-ui/codemod
def-struct
@s-ui/changelog
@rajzik/lumos
@dolittle/webpack
cli-json-edit
@grogqli/server
@jianghe/sand-cli
@elastosfoundation/trinity-cli
returrn
gyaon-cli
@kcom/package-tools
term-of-the-day
typescript-koa-starter
project-initializer
node-rg
ss-clean-slate
gev
jad-node-ts-kit
forcemanager-cli
use-express-template
ecochat-term
@mkvlrn/nodeinit
modern-node-starter
@triptyk/nfw-cli
@aburkov/scripts
plop-pack-gatsby-starter
@acanto/workflow
bo-api-starter-ts
deployqb
@ps-devs/shopify-webpack
blip-lang
create-nuxt-typescript-component
@tinyhttp/cli
next-nodecms
jollof-cli
@anyopsos/cli
mongoose-auto-api.cli
new-express-app
iffe-commit
striplet
express-generator-typescript-k8s
pkgmngrgui
dex-cli
typescript-react-starter
cucu-generator
generator-brei-app
react-easy-boilerplate
create-express-template
base-express-app-starter
@deboxsoft/plop-generator
@hyron/cli
deyarn
lazlodb
sisback
fix-package-versions
create-express-typescript-application
pandocuments
grafpad
axereos-hopes
kanuki-cli
:scroll: License
MIT © Ionică Bizău