jsonfile

WebJar for jsonfile

License	MIT
Categories	JSON Data
GroupId	org.webjars.npm
ArtifactId	jsonfile
Last Version	6.1.0
Release Date	Nov 29, 2020
Type	jar
Description	jsonfile WebJar for jsonfile
Project URL	https://www.webjars.org
Source Code Management	https://github.com/jprichardson/node-jsonfile

Download jsonfile

Filename	Size
jsonfile-6.1.0.pom
jsonfile-6.1.0.jar	8 KB
jsonfile-6.1.0-sources.jar	22 bytes
jsonfile-6.1.0-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/jsonfile/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>jsonfile</artifactId>
    <version>6.1.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/jsonfile/
implementation 'org.webjars.npm:jsonfile:6.1.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/jsonfile/
implementation ("org.webjars.npm:jsonfile:6.1.0")

Apache Buildr

'org.webjars.npm:jsonfile:jar:6.1.0'

Apache Ivy

<dependency org="org.webjars.npm" name="jsonfile" rev="6.1.0">
  <artifact name="jsonfile" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='jsonfile', version='6.1.0')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "jsonfile" % "6.1.0"

Leiningen

[org.webjars.npm/jsonfile "6.1.0"]

Dependencies

compile (2)

Group / Artifact	Type	Version
org.webjars.npm : universalify	jar	[2.0.0,3)
org.webjars.npm : graceful-fs Optional	jar	[4.1.6,5)

Project Modules

There are no modules declared in this project.

Node.js - jsonfile

Easily read/write JSON files in Node.js. Note: this module cannot be used in the browser.

Why?

Writing JSON.stringify() and then fs.writeFile() and JSON.parse() with fs.readFile() enclosed in try/catch blocks became annoying.

Installation

npm install --save jsonfile

API

• readFile(filename, [options], callback)
• readFileSync(filename, [options])
• writeFile(filename, obj, [options], callback)
• writeFileSync(filename, obj, [options])

---

readFile(filename, [options], callback)

options (object, default undefined): Pass in any fs.readFile options or set reviver for a JSON reviver.

• throws (boolean, default: true). If JSON.parse throws an error, pass this error to the callback. If false, returns null for the object.

const jsonfile = require('jsonfile')
const file = '/tmp/data.json'
jsonfile.readFile(file, function (err, obj) {
  if (err) console.error(err)
  console.dir(obj)
})

You can also use this method with promises. The readFile method will return a promise if you do not pass a callback function.

const jsonfile = require('jsonfile')
const file = '/tmp/data.json'
jsonfile.readFile(file)
  .then(obj => console.dir(obj))
  .catch(error => console.error(error))

---

readFileSync(filename, [options])

options (object, default undefined): Pass in any fs.readFileSync options or set reviver for a JSON reviver.

• throws (boolean, default: true). If an error is encountered reading or parsing the file, throw the error. If false, returns null for the object.

const jsonfile = require('jsonfile')
const file = '/tmp/data.json'

console.dir(jsonfile.readFileSync(file))

---

writeFile(filename, obj, [options], callback)

options: Pass in any fs.writeFile options or set replacer for a JSON replacer. Can also pass in spaces, or override EOL string or set finalEOL flag as false to not save the file with EOL at the end.

const jsonfile = require('jsonfile')

const file = '/tmp/data.json'
const obj = { name: 'JP' }

jsonfile.writeFile(file, obj, function (err) {
  if (err) console.error(err)
})

Or use with promises as follows:

const jsonfile = require('jsonfile')

const file = '/tmp/data.json'
const obj = { name: 'JP' }

jsonfile.writeFile(file, obj)
  .then(res => {
    console.log('Write complete')
  })
  .catch(error => console.error(error))

formatting with spaces:

const jsonfile = require('jsonfile')

const file = '/tmp/data.json'
const obj = { name: 'JP' }

jsonfile.writeFile(file, obj, { spaces: 2 }, function (err) {
  if (err) console.error(err)
})

overriding EOL:

const jsonfile = require('jsonfile')

const file = '/tmp/data.json'
const obj = { name: 'JP' }

jsonfile.writeFile(file, obj, { spaces: 2, EOL: '\r\n' }, function (err) {
  if (err) console.error(err)
})

disabling the EOL at the end of file:

const jsonfile = require('jsonfile')

const file = '/tmp/data.json'
const obj = { name: 'JP' }

jsonfile.writeFile(file, obj, { spaces: 2, finalEOL: false }, function (err) {
  if (err) console.log(err)
})

appending to an existing JSON file:

You can use fs.writeFile option { flag: 'a' } to achieve this.

const jsonfile = require('jsonfile')

const file = '/tmp/mayAlreadyExistedData.json'
const obj = { name: 'JP' }

jsonfile.writeFile(file, obj, { flag: 'a' }, function (err) {
  if (err) console.error(err)
})

---

writeFileSync(filename, obj, [options])

options: Pass in any fs.writeFileSync options or set replacer for a JSON replacer. Can also pass in spaces, or override EOL string or set finalEOL flag as false to not save the file with EOL at the end.

const jsonfile = require('jsonfile')

const file = '/tmp/data.json'
const obj = { name: 'JP' }

jsonfile.writeFileSync(file, obj)

formatting with spaces:

const jsonfile = require('jsonfile')

const file = '/tmp/data.json'
const obj = { name: 'JP' }

jsonfile.writeFileSync(file, obj, { spaces: 2 })

overriding EOL:

const jsonfile = require('jsonfile')

const file = '/tmp/data.json'
const obj = { name: 'JP' }

jsonfile.writeFileSync(file, obj, { spaces: 2, EOL: '\r\n' })

disabling the EOL at the end of file:

const jsonfile = require('jsonfile')

const file = '/tmp/data.json'
const obj = { name: 'JP' }

jsonfile.writeFileSync(file, obj, { spaces: 2, finalEOL: false })

appending to an existing JSON file:

You can use fs.writeFileSync option { flag: 'a' } to achieve this.

const jsonfile = require('jsonfile')

const file = '/tmp/mayAlreadyExistedData.json'
const obj = { name: 'JP' }

jsonfile.writeFileSync(file, obj, { flag: 'a' })

License

(MIT License)

Copyright 2012-2016, JP Richardson [email protected]

Versions

Version
6.1.0 Nov 29, 2020
6.0.1 Jun 22, 2020
5.0.0 Oct 14, 2020
4.0.0 Oct 10, 2017
3.0.1 Aug 24, 2017
2.4.0 Feb 23, 2018
2.1.0 Oct 13, 2015