Function mkdir

mkdir(
path: PathLike,
options: MakeDirectoryOptions & { recursive: true },
): Promise<string>
Asynchronously creates a directory.

The optional options argument can be an integer specifying mode (permission and sticky bits), or an object with a mode property and a recursive property indicating whether parent directories should be created. Calling fsPromises.mkdir() when path is a directory that exists results in a rejection only when recursive is false.
```
import { mkdir } from 'node:fs/promises';

try {
  const projectFolder = new URL('./test/project/', import.meta.url);
  const createDir = await mkdir(projectFolder, { recursive: true });

  console.log(`created ${createDir}`);
} catch (err) {
  console.error(err.message);
}
```
Parameters
- path: PathLike
- options: MakeDirectoryOptions & { recursive: true }
Returns Promise<string>
Upon success, fulfills with undefined if recursive is false, or the first directory path created if recursive is true.

Since
v10.0.0
- Defined in node_modules/@types/node/fs/promises.d.ts:617
mkdir(
path: PathLike,
options?: Mode | MakeDirectoryOptions & { recursive?: false },
): Promise<void>
Asynchronous mkdir(2) - create a directory.
Parameters
- path: PathLike
  A path to a file. If a URL is provided, it must use the file: protocol.
- Optionaloptions: Mode | MakeDirectoryOptions & { recursive?: false }
  Either the file mode, or an object optionally specifying the file mode and whether parent folders should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to 0o777.
Returns Promise<void>
- Defined in node_modules/@types/node/fs/promises.d.ts:629
mkdir(path: PathLike, options?: Mode | MakeDirectoryOptions): Promise<string>
Asynchronous mkdir(2) - create a directory.
Parameters
- path: PathLike
  A path to a file. If a URL is provided, it must use the file: protocol.
- Optionaloptions: Mode | MakeDirectoryOptions
  Either the file mode, or an object optionally specifying the file mode and whether parent folders should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to 0o777.
Returns Promise<string>
- Defined in node_modules/@types/node/fs/promises.d.ts:644

Function mkdir

Parameters

Returns Promise<string>

Since

Parameters

Returns Promise<void>

Parameters

Returns Promise<string>

Settings