Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
edit-json-file
Advanced tools
edit-json-file - npm Package Compare versions
Comparing version 1.3.2 to 1.4.0
@@ -13,3 +13,3 @@ { | ||
| "license": "MIT", | ||
| "version": "1.3.2", | ||
| "version": "1.4.0", | ||
| "main": "lib/index.js", | ||
@@ -16,0 +16,0 @@ "scripts": { |
101
README.md
@@ -0,49 +1,26 @@ | ||
| <!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. --> | ||
| # edit-json-file | ||
| Edit a json file with ease. | ||
| [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [](https://github.com/IonicaBizau/ama) [](https://www.npmjs.com/package/edit-json-file) [](https://www.npmjs.com/package/edit-json-file) | ||
| > Edit a json file with ease. | ||
| ## :cloud: Installation | ||
| ```sh | ||
| # Using npm | ||
| npm install --save edit-json-file | ||
| ## Installation | ||
| ```sh | ||
| $ npm i edit-json-file | ||
| # Using yarn | ||
| yarn add edit-json-file | ||
| ``` | ||
| ## :clipboard: Example | ||
| ## Example | ||
| ```js | ||
| "use strict"; | ||
| const editJsonFile = require("edit-json-file"); | ||
@@ -92,3 +69,2 @@ | ||
| // a: { new: { field: [Object] } } } | ||
| ``` | ||
@@ -100,12 +76,21 @@ | ||
| ## :question: Get Help | ||
| ## Documentation | ||
| There are few ways to get help: | ||
| 1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). 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. :bug: | ||
| 3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket: | ||
| ## :memo: Documentation | ||
| ### `JsonEditor(path, options)` | ||
| #### Params | ||
| - **String** `path`: The path to the JSON file. | ||
@@ -125,2 +110,3 @@ - **Object** `options`: An object containing the following fields: | ||
| #### Params | ||
| - **String** `path`: The object path. | ||
@@ -136,2 +122,3 @@ - **Anything** `value`: The value. | ||
| #### Params | ||
| - **String** `path`: | ||
@@ -146,2 +133,3 @@ | ||
| #### Params | ||
| - **String** `path`: The object path. | ||
@@ -156,2 +144,3 @@ | ||
| #### Params | ||
| - **Function** `cb`: An optional callback function which will turn the function into an asynchronous one. | ||
@@ -167,2 +156,3 @@ | ||
| #### Params | ||
| - **String** `The`: file content. | ||
@@ -178,2 +168,3 @@ - **Function** `cb`: An optional callback function which will turn the function into an asynchronous one. | ||
| #### Params | ||
| - **Function** `cb`: The callback function. | ||
@@ -185,2 +176,3 @@ | ||
| #### Params | ||
| - **Function** `cb`: An optional callback function which will turn the function into an asynchronous one. | ||
@@ -200,2 +192,3 @@ | ||
| #### Params | ||
| - **String** `path`: The path to the JSON file. | ||
@@ -209,16 +202,44 @@ - **Object** `options`: An object containing the following fields: | ||
| ## :yum: How to contribute | ||
| Have an idea? Found a bug? See [how to contribute][contributing]. | ||
| ## :sparkling_heart: Support my projects | ||
| ## How to contribute | ||
| Have an idea? Found a bug? See [how to contribute][contributing]. | ||
| 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: | ||
| ## License | ||
| See the [LICENSE][license] file. | ||
| - Starring and sharing the projects you like :rocket: | ||
| - [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book: | ||
| - [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea: | ||
| - [![Support me on Patreon][badge_patreon]][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` | ||
|  | ||
| [license]: /LICENSE | ||
| Thanks! :heart: | ||
| ## :scroll: License | ||
| [MIT][license] © [Ionică Bizău][website] | ||
| [badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg | ||
| [badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg | ||
| [badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg | ||
| [badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg | ||
| [patreon]: https://www.patreon.com/ionicabizau | ||
| [amazon]: http://amzn.eu/hRo9sIZ | ||
| [paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW | ||
| [license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(https%3A%2F%2Fionicabizau.net)&year=2015#license-mit | ||
| [website]: https://ionicabizau.net | ||
| [contributing]: /CONTRIBUTING.md | ||
| [docs]: /DOCUMENTATION.md |
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by22.76%
15409
- Number of lines in readme file
- increased by9.81%
235
No dependency changes