write-json-file

WebJar for write-json-file

License	MIT
Categories	JSON Data
GroupId	org.webjars.npm
ArtifactId	write-json-file
Last Version	3.2.0
Release Date	Apr 5, 2021
Type	jar
Description	write-json-file WebJar for write-json-file
Project URL	https://www.webjars.org
Source Code Management	https://github.com/sindresorhus/write-json-file

Download write-json-file

Filename	Size
write-json-file-3.2.0.pom
write-json-file-3.2.0.jar	6 KB
write-json-file-3.2.0-sources.jar	22 bytes
write-json-file-3.2.0-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/write-json-file/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>write-json-file</artifactId>
    <version>3.2.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/write-json-file/
implementation 'org.webjars.npm:write-json-file:3.2.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/write-json-file/
implementation ("org.webjars.npm:write-json-file:3.2.0")

Apache Buildr

'org.webjars.npm:write-json-file:jar:3.2.0'

Apache Ivy

<dependency org="org.webjars.npm" name="write-json-file" rev="3.2.0">
  <artifact name="write-json-file" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='write-json-file', version='3.2.0')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "write-json-file" % "3.2.0"

Leiningen

[org.webjars.npm/write-json-file "3.2.0"]

Dependencies

compile (6)

Group / Artifact	Type	Version
org.webjars.npm : make-dir	jar	[2.1.0,3)
org.webjars.npm : sort-keys	jar	[2.0.0,3)
org.webjars.npm : pify	jar	[4.0.1,5)
org.webjars.npm : graceful-fs	jar	[4.1.15,5)
org.webjars.npm : write-file-atomic	jar	[2.4.2,3)
org.webjars.npm : detect-indent	jar	[5.0.0,6)

Project Modules

There are no modules declared in this project.

write-json-file

Stringify and write JSON to a file atomically

Creates directories for you as needed.

Install

$ npm install write-json-file

Usage

const writeJsonFile = require('write-json-file');

(async () => {
	await writeJsonFile('foo.json', {foo: true});
})();

API

writeJsonFile(filePath, data, options?)

Returns a Promise.

writeJsonFile.sync(filePath, data, options?)

options

Type: object

indent

Type: string | number
Default: '\t'

Indentation as a string or number of spaces.

Pass in undefined for no formatting.

detectIndent

Type: boolean
Default: false

Detect indentation automatically if the file exists.

sortKeys

Type: boolean | Function
Default: false

Sort the keys recursively.

Optionally pass in a compare function.

replacer

Type: Function

Passed into JSON.stringify.

mode

Type: number
Default: 0o666

Mode used when writing the file.

write-json-file for enterprise

Available as part of the Tidelift Subscription.

The maintainers of write-json-file and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.

Related

• load-json-file - Read and parse a JSON file
• make-dir - Make a directory and its parents if needed

Versions

Version
3.2.0 Apr 5, 2021