edit-json-file

2019-03-15 admin

edit-json-file是什么

什么是edit-json-file,Edit a json file with ease.

edit-json-file使用教程帮助文档

edit-json-file

Support me on Patreon Buy me a book PayPal Ask me anything Version Downloads Get help on Codementor

Buy Me A Coffee

Edit a json file with ease.

<g-emoji class=“g-emoji” alias=“cloud” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/2601.png”>☁️</g-emoji> Installation

# Using npm
npm install --save edit-json-file

# Using yarn
yarn add edit-json-file

<g-emoji class=“g-emoji” alias=“clipboard” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f4cb.png”>📋</g-emoji> Example

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] } } }

<g-emoji class=“g-emoji” alias=“question” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/2753.png”>❓</g-emoji> Get Help

There are few ways to get help:

  1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.

  2. For bug reports and feature requests, open issues. <g-emoji class=“g-emoji” alias=“bug” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f41b.png”>🐛</g-emoji>

  3. For direct and quick help, you can use Codementor. <g-emoji class=“g-emoji” alias=“rocket” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f680.png”>🚀</g-emoji>

<g-emoji class=“g-emoji” alias=“memo” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f4dd.png”>📝</g-emoji> 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.
  • 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

  • String path:

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.

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

  • Object The data object.

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.

<g-emoji class=“g-emoji” alias=“yum” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f60b.png”>😋</g-emoji> How to contribute

Have an idea? Found a bug? See how to contribute.

<g-emoji class=“g-emoji” alias=“sparkling_heart” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f496.png”>💖</g-emoji> 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 <g-emoji class=“g-emoji” alias=“rocket” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f680.png”>🚀</g-emoji>

  • Buy me a book—I love books! I will remember you after years if you buy me one. <g-emoji class=“g-emoji” alias=“grin” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f601.png”>😁</g-emoji> <g-emoji class=“g-emoji” alias=“book” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f4d6.png”>📖</g-emoji>

  • PayPal—You can make one-time donations via PayPal. I’ll probably buy a coffee tea. <g-emoji class=“g-emoji” alias=“tea” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f375.png”>🍵</g-emoji>

  • Support me on Patreon—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! <g-emoji class=“g-emoji” alias=“heart” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/2764.png”>❤️</g-emoji>

<g-emoji class=“g-emoji” alias=“dizzy” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f4ab.png”>💫</g-emoji> Where is this library used?

If you are using this library in one of your projects, add it in this list. <g-emoji class=“g-emoji” alias=“sparkles” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/2728.png”>✨</g-emoji>

  • blip-lang (by Joshua Barnett)—A programming language
  • bloggify-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 - pirofagista@gmail.com)—Easy way to backup/restore multiple mongodb databases.
  • extracct (by awyerbx)—Node Module
  • fix-package-versions (by Jose Segura García)—This is the first approach to a fix package.json versions
  • gyaon-cli (by stkay)—
  • jollof-cli (by Iyobo Eki)—The Entry point to creating and working with Jollof Projects
  • jollofjs (by Iyobo Eki)—The Entry point to creating and working with Jollof Projects
  • live-stream-radio (by Aaron Turner)—24/7 live stream video radio station CLI / API
  • lyo (by Boris K)—Node.js to browser - The easy way
  • menreiki-init—用于创建menreiki项目骨架
  • menreiki2 (by 汗僧)—ssr with react
  • node-file-rev (by Lukas Oppermann)—Simple node cli tool to revision files and write them to a rev-manifest.json
  • pandocuments (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 another
  • project-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 Angular
  • webify-generator (by Santiago D´Antuoni)—A web application generator

<g-emoji class=“g-emoji” alias=“scroll” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f4dc.png”>📜</g-emoji> License

MIT © Ionică Bizău

本站文章除注明转载外,均为本站原创或编译。欢迎任何形式的转载,但请务必注明出处。

转载请注明:文章转载自 JavaScript中文网 [https://www.javascriptcn.com]

本文地址:https://www.javascriptcn.com/read-57725.html

文章标题:edit-json-file

回到顶部