Skip to main content
mkdirSync - node__fs.d.ts - Node documentation
function mkdirSync

Usage in Deno

```typescript import { mkdirSync } from "node:node__fs.d.ts"; ```
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](../.././node__fs.d.ts/~/mkdir). See the POSIX [`mkdir(2)`](http://man7.org/linux/man-pages/man2/mkdir.2.html) documentation for more details.

Parameters

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

Return Type

string | undefined
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.
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
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.
optional
options:
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

string | undefined