w-json

A small module to write JSON files.

If you want to read JSON files, check out r-json.

☁️ Installation

# Using npm
npm install --save w-json

# Using yarn
yarn add w-json

📋 Example

// Dependencies
var WriteJson = require("w-json");

// Write the same file synchronously
WriteJson(__dirname + "/test.json", { "hello": "mars" });

// 4 space indent and new line at the end
WriteJson(__dirname + "/test.json", { "hello": "mars" }, {
    new_line: true
  , space: 4
});

// Write test.json asynchronously
WriteJson(__dirname + "/test.json", { "hello": "world" }, function (err, data) {
    console.log(err || "written");
});

❓ 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. 🐛
3. For direct and quick help, you can use Codementor. 🚀

📝 Documentation

wJson(path, data, options, callback)

Writes a JSON file.

Params

• String path: The JSON file path.

• Object data: The JSON data to write in the provided file.

• Object|Number|Boolean options: An object containing the fields below. If boolean, it will be handled as new_line, if number it will be handled as space.

• space (Number): An optional space value for beautifying the json output (default: 2).

• new_line (Boolean): If true, a new line character will be added at the end of the stringified content.

• Function callback: An optional callback. If not passed, the function will run in sync mode.

😋 How to contribute

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

💖 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 🚀

• —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 coffee 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! ❤️

💫 Where is this library used?

If you are using this library in one of your projects, add it in this list. ✨

• @acegoal07/json-editor
• auto-geo-sunset
• babel-it
• bible
• birthday
• blah
• bloggify
• bloggify-cli
• cdnjs-importer
• cli-sunset
• edit-json-file
• engine-app
• engine-composition-crud
• engine-parser
• engine-tools
• git-stats
• idea
• machine-ip
• made-in-brazil
• made-in-india
• made-in-romania
• markdownalint-cli2
• packy
• r-json
• ship-release
• tithe
• tools_may_24
• w-package-json
• web-term

📜 License

MIT © Ionică Bizău