@vtj

---

@vtj / node / mkdirp

Function: mkdirp()

Call Signature

mkdirp(path, options?): Promise<void>

Ensures that the directory exists. If the directory structure does not exist, it is created.

Parameters

path

string

options?

number | EnsureDirOptions

Returns

Promise<void>

Example

import * as fs from 'fs-extra'

const dir = '/tmp/this/path/does/not/exist'
const desiredMode = 0o2775
const options = {
  mode: 0o2775
}

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

// With a callback and a mode integer
fs.ensureDir(dir, desiredMode, err => {
  console.log(err) // => null
  // dir has now been created with mode 0o2775, including the directory it is to be placed in
})

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

// With Promises and a mode integer:
fs.ensureDir(dir, desiredMode)
  .then(() => {
    console.log('success!')
  })
  .catch(err => {
    console.error(err)
  })

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

// With async/await and an options object, containing mode:
async function asyncAwaitMode () {
  try {
    await fs.ensureDir(dir, options)
    console.log('success!')
  } catch (err) {
    console.error(err)
  }
}
asyncAwaitMode()

Defined in

packages/node/src/fs.ts:9

Call Signature

mkdirp(path, callback): void

Ensures that the directory exists. If the directory structure does not exist, it is created.

Parameters

path

string

callback

NoParamCallback

Returns

void

Example

import * as fs from 'fs-extra'

const dir = '/tmp/this/path/does/not/exist'
const desiredMode = 0o2775
const options = {
  mode: 0o2775
}

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

// With a callback and a mode integer
fs.ensureDir(dir, desiredMode, err => {
  console.log(err) // => null
  // dir has now been created with mode 0o2775, including the directory it is to be placed in
})

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

// With Promises and a mode integer:
fs.ensureDir(dir, desiredMode)
  .then(() => {
    console.log('success!')
  })
  .catch(err => {
    console.error(err)
  })

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

// With async/await and an options object, containing mode:
async function asyncAwaitMode () {
  try {
    await fs.ensureDir(dir, options)
    console.log('success!')
  } catch (err) {
    console.error(err)
  }
}
asyncAwaitMode()

Defined in

packages/node/src/fs.ts:9

Call Signature

mkdirp(path, options, callback): void

Ensures that the directory exists. If the directory structure does not exist, it is created.

Parameters

path

string

options

number | EnsureDirOptions

callback

NoParamCallback

Returns

void

Example

import * as fs from 'fs-extra'

const dir = '/tmp/this/path/does/not/exist'
const desiredMode = 0o2775
const options = {
  mode: 0o2775
}

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

// With a callback and a mode integer
fs.ensureDir(dir, desiredMode, err => {
  console.log(err) // => null
  // dir has now been created with mode 0o2775, including the directory it is to be placed in
})

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

// With Promises and a mode integer:
fs.ensureDir(dir, desiredMode)
  .then(() => {
    console.log('success!')
  })
  .catch(err => {
    console.error(err)
  })

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

// With async/await and an options object, containing mode:
async function asyncAwaitMode () {
  try {
    await fs.ensureDir(dir, options)
    console.log('success!')
  } catch (err) {
    console.error(err)
  }
}
asyncAwaitMode()

Defined in

packages/node/src/fs.ts:9