
Security News
Oracle Drags Its Feet in the JavaScript Trademark Dispute
Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.
write-json-file
Advanced tools
The write-json-file npm package allows you to write JSON data to a file in a simple and straightforward manner. It is useful for saving configuration files, data storage, and other scenarios where JSON data needs to be persisted to the filesystem.
Write JSON to a file
This feature allows you to write a JSON object to a specified file. The example demonstrates writing a simple JSON object to a file named 'foo.json'.
const writeJsonFile = require('write-json-file');
(async () => {
await writeJsonFile('foo.json', {foo: true});
})();
Write JSON to a file with options
This feature allows you to specify options such as indentation when writing JSON to a file. The example demonstrates writing a JSON object to a file with an indentation of 2 spaces.
const writeJsonFile = require('write-json-file');
(async () => {
await writeJsonFile('foo.json', {foo: true}, {indent: 2});
})();
Write JSON to a file with replacer function
This feature allows you to use a replacer function to modify the JSON data before writing it to a file. The example demonstrates writing a JSON object to a file while excluding the 'bar' property.
const writeJsonFile = require('write-json-file');
(async () => {
await writeJsonFile('foo.json', {foo: true, bar: false}, {replacer: (key, value) => key === 'bar' ? undefined : value});
})();
The jsonfile package provides similar functionality for reading and writing JSON files. It offers a simple API for both synchronous and asynchronous operations. Compared to write-json-file, jsonfile includes both read and write capabilities in a single package.
The fs-extra package extends the native Node.js fs module with additional methods, including methods for reading and writing JSON files. It provides a more comprehensive set of file system utilities compared to write-json-file, which focuses solely on writing JSON data.
The json-write package is another alternative for writing JSON data to files. It offers a straightforward API similar to write-json-file but with fewer configuration options. It is a simpler and more lightweight option for basic JSON writing tasks.
Stringify and write JSON to a file atomically
Creates directories for you as needed.
npm install write-json-file
import {writeJsonFile} from 'write-json-file';
await writeJsonFile('foo.json', {foo: true});
Returns a Promise
.
Type: object
Type: string | number | undefined
Default: '\t'
Indentation as a string or number of spaces.
Pass in undefined
for no formatting.
If you set both this and detectIndent
, this value will be used when the indentation cannot be detected.
Type: boolean
Default: false
Detect indentation automatically if the file exists.
Type: boolean | Function
Default: false
Sort the keys recursively.
Optionally pass in a compare
function.
Type: Function
Passed into JSON.stringify
.
Type: number
Default: 0o666
The mode used when writing the file.
FAQs
Stringify and write JSON to a file atomically
The npm package write-json-file receives a total of 0 weekly downloads. As such, write-json-file popularity was classified as not popular.
We found that write-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
Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.
Security News
The Linux Foundation is warning open source developers that compliance with global sanctions is mandatory, highlighting legal risks and restrictions on contributions.
Security News
Maven Central now validates Sigstore signatures, making it easier for developers to verify the provenance of Java packages.