Skip to content

@vtj


@vtj / node / outputJson

Function: outputJson()

Call Signature

outputJson(file, data, options?): Promise<void>

Almost the same as writeJson, except that if the directory does not exist, it's created.

Parameters

file

string

data

any

options?

JsonOutputOptions

Returns

Promise<void>

Example

ts
import * as fs from 'fs-extra'

const file = '/tmp/this/path/does/not/exist/file.json'

// With a callback:
fs.outputJson(file, {name: 'JP'}, err => {
  console.log(err) // => null

  fs.readJson(file, (err, data) => {
    if (err) return console.error(err)
    console.log(data.name) // => JP
  })
})

// With Promises:
fs.outputJson(file, {name: 'JP'})
  .then(() => fs.readJson(file))
  .then(data => {
    console.log(data.name) // => JP
  })
  .catch(err => {
    console.error(err)
  })

// With async/await:
async function asyncAwait () {
  try {
    await fs.outputJson(file, {name: 'JP'})

    const data = await fs.readJson(file)

    console.log(data.name) // => JP
  } catch (err) {
    console.error(err)
  }
}

asyncAwait()

Defined in

packages/node/src/fs.ts:13

Call Signature

outputJson(file, data, options, callback): void

Almost the same as writeJson, except that if the directory does not exist, it's created.

Parameters

file

string

data

any

options

JsonOutputOptions

callback

NoParamCallback

Returns

void

Example

ts
import * as fs from 'fs-extra'

const file = '/tmp/this/path/does/not/exist/file.json'

// With a callback:
fs.outputJson(file, {name: 'JP'}, err => {
  console.log(err) // => null

  fs.readJson(file, (err, data) => {
    if (err) return console.error(err)
    console.log(data.name) // => JP
  })
})

// With Promises:
fs.outputJson(file, {name: 'JP'})
  .then(() => fs.readJson(file))
  .then(data => {
    console.log(data.name) // => JP
  })
  .catch(err => {
    console.error(err)
  })

// With async/await:
async function asyncAwait () {
  try {
    await fs.outputJson(file, {name: 'JP'})

    const data = await fs.readJson(file)

    console.log(data.name) // => JP
  } catch (err) {
    console.error(err)
  }
}

asyncAwait()

Defined in

packages/node/src/fs.ts:13

Call Signature

outputJson(file, data, callback): void

Almost the same as writeJson, except that if the directory does not exist, it's created.

Parameters

file

string

data

any

callback

NoParamCallback

Returns

void

Example

ts
import * as fs from 'fs-extra'

const file = '/tmp/this/path/does/not/exist/file.json'

// With a callback:
fs.outputJson(file, {name: 'JP'}, err => {
  console.log(err) // => null

  fs.readJson(file, (err, data) => {
    if (err) return console.error(err)
    console.log(data.name) // => JP
  })
})

// With Promises:
fs.outputJson(file, {name: 'JP'})
  .then(() => fs.readJson(file))
  .then(data => {
    console.log(data.name) // => JP
  })
  .catch(err => {
    console.error(err)
  })

// With async/await:
async function asyncAwait () {
  try {
    await fs.outputJson(file, {name: 'JP'})

    const data = await fs.readJson(file)

    console.log(data.name) // => JP
  } catch (err) {
    console.error(err)
  }
}

asyncAwait()

Defined in

packages/node/src/fs.ts:13

Released under the MIT License.