Skip to content

Mkdir

[<Interface>]
type Mkdir =
    abstract member Invoke (path: PathLike, callback: NoParamCallback) : unit
    abstract member Invoke (path: PathLike, options: U3<string,float,MakeDirectoryOptions> option, callback: Callback2) : unit
    abstract member Invoke (path: PathLike, options: U3<string,float,Options2> option, callback: NoParamCallback) : unit
    abstract member Invoke (path: PathLike, options: Options, callback: Callback) : unit
    abstract member __promisify__ (path: PathLike, ?options: U3<string,float,MakeDirectoryOptions>) : Promise<string option>
    abstract member __promisify__ (path: PathLike, ?options: U3<string,float,Options2>) : Promise<unit>
    abstract member __promisify__ (path: PathLike, options: Options) : Promise<string option>
AssemblyXantham.Fable.Node

Declared inside

Callback
Callback2
Options
Options2
Promisify

Methods

abstract member Invoke (path: PathLike, callback: NoParamCallback) : unit

Asynchronously creates a directory.

The callback is given a possible exception and, if recursive is true, the first directory path created, (err[, path]).path can still be undefined when recursive is true, if no directory was created (for instance, if it was previously created).

The optional options argument can be an integer specifying mode (permission and sticky bits), or an object with a mode property and a recursive property indicating whether parent directories should be created. Calling fs.mkdir() when path is a directory that exists results in an error only when recursive is false. If recursive is false and the directory exists, an EEXIST error occurs.

import { mkdir } from 'node:fs';

// Create ./tmp/a/apple, regardless of whether ./tmp and ./tmp/a exist.
mkdir('./tmp/a/apple', { recursive: true }, (err) => {
if (err) throw err;
});

On Windows, using fs.mkdir() on the root directory even with recursion will result in an error:

import { mkdir } from 'node:fs';

mkdir('/', { recursive: true }, (err) => {
// => [Error: EPERM: operation not permitted, mkdir 'C:\']
});

See the POSIX mkdir(2) documentation for more details. Asynchronous mkdir(2) - create a directory. Asynchronous mkdir(2) - create a directory with a mode of 0o777.

Parameter
pathA path to a file. If a URL is provided, it must use the file: protocol.
optionsEither 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.
pathA path to a file. If a URL is provided, it must use the file: protocol.
optionsEither 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.
pathA path to a file. If a URL is provided, it must use the file: protocol.
abstract member Invoke (path: PathLike, options: U3<string,float,MakeDirectoryOptions> option, callback: Callback2) : unit

Asynchronously creates a directory.

The callback is given a possible exception and, if recursive is true, the first directory path created, (err[, path]).path can still be undefined when recursive is true, if no directory was created (for instance, if it was previously created).

The optional options argument can be an integer specifying mode (permission and sticky bits), or an object with a mode property and a recursive property indicating whether parent directories should be created. Calling fs.mkdir() when path is a directory that exists results in an error only when recursive is false. If recursive is false and the directory exists, an EEXIST error occurs.

import { mkdir } from 'node:fs';

// Create ./tmp/a/apple, regardless of whether ./tmp and ./tmp/a exist.
mkdir('./tmp/a/apple', { recursive: true }, (err) => {
if (err) throw err;
});

On Windows, using fs.mkdir() on the root directory even with recursion will result in an error:

import { mkdir } from 'node:fs';

mkdir('/', { recursive: true }, (err) => {
// => [Error: EPERM: operation not permitted, mkdir 'C:\']
});

See the POSIX mkdir(2) documentation for more details. Asynchronous mkdir(2) - create a directory. Asynchronous mkdir(2) - create a directory with a mode of 0o777.

Parameter
pathA path to a file. If a URL is provided, it must use the file: protocol.
optionsEither 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.
pathA path to a file. If a URL is provided, it must use the file: protocol.
optionsEither 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.
pathA path to a file. If a URL is provided, it must use the file: protocol.
abstract member Invoke (path: PathLike, options: U3<string,float,Options2> option, callback: NoParamCallback) : unit

Asynchronously creates a directory.

The callback is given a possible exception and, if recursive is true, the first directory path created, (err[, path]).path can still be undefined when recursive is true, if no directory was created (for instance, if it was previously created).

The optional options argument can be an integer specifying mode (permission and sticky bits), or an object with a mode property and a recursive property indicating whether parent directories should be created. Calling fs.mkdir() when path is a directory that exists results in an error only when recursive is false. If recursive is false and the directory exists, an EEXIST error occurs.

import { mkdir } from 'node:fs';

// Create ./tmp/a/apple, regardless of whether ./tmp and ./tmp/a exist.
mkdir('./tmp/a/apple', { recursive: true }, (err) => {
if (err) throw err;
});

On Windows, using fs.mkdir() on the root directory even with recursion will result in an error:

import { mkdir } from 'node:fs';

mkdir('/', { recursive: true }, (err) => {
// => [Error: EPERM: operation not permitted, mkdir 'C:\']
});

See the POSIX mkdir(2) documentation for more details. Asynchronous mkdir(2) - create a directory. Asynchronous mkdir(2) - create a directory with a mode of 0o777.

Parameter
pathA path to a file. If a URL is provided, it must use the file: protocol.
optionsEither 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.
pathA path to a file. If a URL is provided, it must use the file: protocol.
optionsEither 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.
pathA path to a file. If a URL is provided, it must use the file: protocol.
abstract member Invoke (path: PathLike, options: Options, callback: Callback) : unit

Asynchronously creates a directory.

The callback is given a possible exception and, if recursive is true, the first directory path created, (err[, path]).path can still be undefined when recursive is true, if no directory was created (for instance, if it was previously created).

The optional options argument can be an integer specifying mode (permission and sticky bits), or an object with a mode property and a recursive property indicating whether parent directories should be created. Calling fs.mkdir() when path is a directory that exists results in an error only when recursive is false. If recursive is false and the directory exists, an EEXIST error occurs.

import { mkdir } from 'node:fs';

// Create ./tmp/a/apple, regardless of whether ./tmp and ./tmp/a exist.
mkdir('./tmp/a/apple', { recursive: true }, (err) => {
if (err) throw err;
});

On Windows, using fs.mkdir() on the root directory even with recursion will result in an error:

import { mkdir } from 'node:fs';

mkdir('/', { recursive: true }, (err) => {
// => [Error: EPERM: operation not permitted, mkdir 'C:\']
});

See the POSIX mkdir(2) documentation for more details. Asynchronous mkdir(2) - create a directory. Asynchronous mkdir(2) - create a directory with a mode of 0o777.

@since v0.1.8

abstract member __promisify__ (path: PathLike, ?options: U3<string,float,MakeDirectoryOptions>) : Promise<string option>

Asynchronous mkdir(2) - create a directory.

Parameter
pathA path to a file. If a URL is provided, it must use the file: protocol.
optionsEither 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.
pathA path to a file. If a URL is provided, it must use the file: protocol.
optionsEither 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.
pathA path to a file. If a URL is provided, it must use the file: protocol.
optionsEither 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.
abstract member __promisify__ (path: PathLike, ?options: U3<string,float,Options2>) : Promise<unit>

Asynchronous mkdir(2) - create a directory.

Parameter
pathA path to a file. If a URL is provided, it must use the file: protocol.
optionsEither 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.
pathA path to a file. If a URL is provided, it must use the file: protocol.
optionsEither 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.
pathA path to a file. If a URL is provided, it must use the file: protocol.
optionsEither 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.
abstract member __promisify__ (path: PathLike, options: Options) : Promise<string option>

Asynchronous mkdir(2) - create a directory.

Parameter
pathA path to a file. If a URL is provided, it must use the file: protocol.
optionsEither 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.
pathA path to a file. If a URL is provided, it must use the file: protocol.
optionsEither 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.
pathA path to a file. If a URL is provided, it must use the file: protocol.
optionsEither 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.