Skip to main content

mkdirSync

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

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

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

Parameters Jump to heading

Jump to headingoptions: MakeDirectoryOptions & { recursive: true; }

Return Type Jump to heading

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

Synchronous mkdir(2) - create a directory.

Parameters Jump to heading

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

optional
Jump to headingoptions:
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 Jump to heading

void
Jump to headingmkdirSync(
path: PathLike,
options?:
Mode
| MakeDirectoryOptions
| null
,
): string | undefined

Synchronous mkdir(2) - create a directory.

Parameters Jump to heading

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

optional
Jump to headingoptions:
Mode
| MakeDirectoryOptions
| 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 Jump to heading

string | undefined
Back to top