Skip to content

@vtj


@vtj / node / remove

Function: remove()

Call Signature

remove(dir): Promise<void>

Removes a file or directory. The directory can have contents. If the path does not exist, silently does nothing.

Parameters

dir

string

Returns

Promise<void>

Example

ts
import * as fs from 'fs-extra'

// remove file
// With a callback:
fs.remove('/tmp/myfile', err => {
  if (err) return console.error(err)
  console.log('success!')
})

fs.remove('/home/jprichardson', err => {
  if (err) return console.error(err)
  console.log('success!') // I just deleted my entire HOME directory.
})

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

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

asyncAwait()

Defined in

packages/node/src/fs.ts:16

Call Signature

remove(dir, callback): void

Removes a file or directory. The directory can have contents. If the path does not exist, silently does nothing.

Parameters

dir

string

callback

NoParamCallback

Returns

void

Example

ts
import * as fs from 'fs-extra'

// remove file
// With a callback:
fs.remove('/tmp/myfile', err => {
  if (err) return console.error(err)
  console.log('success!')
})

fs.remove('/home/jprichardson', err => {
  if (err) return console.error(err)
  console.log('success!') // I just deleted my entire HOME directory.
})

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

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

asyncAwait()

Defined in

packages/node/src/fs.ts:16

Released under the MIT License.