mkdirSync

function mkdirSync

Usage

import { mkdirSync } from "node:fs";


        mkdirSync(path: PathLike, options: MakeDirectoryOptions & { recursive: true;  }): string | undefined

Synchronously creates a directory. Returns undefined, or if recursive istrue, the first directory path created. This is the synchronous version of mkdir.


        mkdirSync(path: PathLike, options?: Mode | (MakeDirectoryOptions & { recursive?: false | undefined;  }) | null): void

Synchronous mkdir(2) - create a directory.


        mkdirSync(path: PathLike, options?: Mode | MakeDirectoryOptions | null): string | undefined

Synchronous mkdir(2) - create a directory.

Synchronously creates a directory. Returns undefined, or if recursive istrue, the first directory path created. This is the synchronous version of mkdir.

See the POSIX mkdir(2) documentation for more details.

Parameters

path: PathLike

options: MakeDirectoryOptions & { recursive: true;  }

Return Type

string | undefined

Synchronous mkdir(2) - create a directory.

Parameters

path: PathLike

A path to a file. If a URL is provided, it must use the file: protocol.

optional

options: Mode | (MakeDirectoryOptions & { recursive?: false | undefined;  }) | null

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.

Return Type

void

Synchronous mkdir(2) - create a directory.

Parameters

path: PathLike

A path to a file. If a URL is provided, it must use the file: protocol.

optional

options: Mode | MakeDirectoryOptions | null

Return Type

string | undefined