Skip to content

@vtj


@vtj / node / ensureFile

Function: ensureFile()

Call Signature

ensureFile(file): Promise<void>

Ensures that the file exists. If the file that is requested to be created is in directories that do not exist, these directories are created. If the file already exists, it is NOT MODIFIED.

Parameters

file

string

Returns

Promise<void>

Example

ts
import * as fs from 'fs-extra'

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

// With a callback:
fs.ensureFile(file, err => {
  console.log(err) // => null
  // file has now been created, including the directory it is to be placed in
})

// With Promises:
fs.ensureFile(file)
 .then(() => {
   console.log('success!')
 })
 .catch(err => {
   console.error(err)
 })

// With async/await:
async function asyncAwait () {
  try {
    await fs.ensureFile(file)
    console.log('success!')
  } catch (err) {
    console.error(err)
  }
}

asyncAwait()

Defined in

packages/node/src/fs.ts:6

Call Signature

ensureFile(file, callback): void

Ensures that the file exists. If the file that is requested to be created is in directories that do not exist, these directories are created. If the file already exists, it is NOT MODIFIED.

Parameters

file

string

callback

NoParamCallbackWithUndefined

Returns

void

Example

ts
import * as fs from 'fs-extra'

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

// With a callback:
fs.ensureFile(file, err => {
  console.log(err) // => null
  // file has now been created, including the directory it is to be placed in
})

// With Promises:
fs.ensureFile(file)
 .then(() => {
   console.log('success!')
 })
 .catch(err => {
   console.error(err)
 })

// With async/await:
async function asyncAwait () {
  try {
    await fs.ensureFile(file)
    console.log('success!')
  } catch (err) {
    console.error(err)
  }
}

asyncAwait()

Defined in

packages/node/src/fs.ts:6

Released under the MIT License.