Skip to content

@vtj


@vtj / node / emptyDir

Function: emptyDir()

Call Signature

emptyDir(path): Promise<void>

Defined in: packages/node/src/fs.ts:5

Ensures that a directory is empty. Deletes directory contents if the directory is not empty. If the directory does not exist, it is created. The directory itself is not deleted.

Parameters

path

string

Returns

Promise<void>

Example

ts
import * as fs from 'fs-extra'

// assume this directory has a lot of files and folders
// With a callback:
fs.emptyDir('/tmp/some/dir', err => {
  if (err) return console.error(err)
  console.log('success!')
})

// With Promises:
fs.emptyDir('/tmp/some/dir')
  .then(() => {
    console.log('success!')
  })
  .catch(err => {
    console.error(err)
  })

// With async/await:
async function asyncAwait () {
  try {
    await fs.emptyDir('/tmp/some/dir')
    console.log('success!')
  } catch (err) {
    console.error(err)
  }
}

asyncAwait()

Call Signature

emptyDir(path, callback): void

Defined in: packages/node/src/fs.ts:5

Ensures that a directory is empty. Deletes directory contents if the directory is not empty. If the directory does not exist, it is created. The directory itself is not deleted.

Parameters

path

string

callback

NoParamCallback

Returns

void

Example

ts
import * as fs from 'fs-extra'

// assume this directory has a lot of files and folders
// With a callback:
fs.emptyDir('/tmp/some/dir', err => {
  if (err) return console.error(err)
  console.log('success!')
})

// With Promises:
fs.emptyDir('/tmp/some/dir')
  .then(() => {
    console.log('success!')
  })
  .catch(err => {
    console.error(err)
  })

// With async/await:
async function asyncAwait () {
  try {
    await fs.emptyDir('/tmp/some/dir')
    console.log('success!')
  } catch (err) {
    console.error(err)
  }
}

asyncAwait()

Released under the MIT License.