Node fs.mkdirSync function | API Reference

Node fs.mkdirSync function | API Reference | BunBuild Docs Reference Guides Blog Discord/node:fs/mkdirSyncFmkdirSync

Search the reference...

Build Docs Reference Guides Blog Discord/node:fs/mkdirSyncFmkdirSync

function

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

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.

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

Synchronous mkdir(2) - create a directory.

@param path

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

@param options

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.

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

Synchronous mkdir(2) - create a directory.

@param path

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

@param options

Referenced typestype PathLike = string | Buffer | URL

Valid types for path values in "fs".

interface MakeDirectoryOptions mode?: Mode

A file mode. If a string is passed, it is parsed as an octal integer. If not specified

recursive?: boolean

Indicates whether parent folders should be created. If a folder was created, the path to the first created folder will be returned.

type Mode = number | string