Skip to main content

function mkdirSync

Overload 1

#mkdirSync(
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 #

#path: PathLike
#options: MakeDirectoryOptions & { recursive: true; }

Return Type #

string | undefined

Overload 2

#mkdirSync(
path: PathLike,
options?:
Mode
| (MakeDirectoryOptions & { recursive?: false | undefined; })
| null
,
): 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.

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

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

Overload 3

#mkdirSync(
path: PathLike,
options?:
Mode
| MakeDirectoryOptions
| null
,
): 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.

#options:
Mode
| MakeDirectoryOptions
| null
optional

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 #

string | undefined

Did you find what you needed?

Privacy policy