Skip to main content
Version: Next

mkdir

function mkdir(path, options?): Promise<void>;

Make a directory.

Parameters

ParameterTypeDescription

path

string

Directory path.

options?

MkdirOptions

(Optional) Options when create directory, by default is {recursive: false, mode: 0o777}, the mode option only works on Unix platform, and is ignored on Windows platform.

Returns

Promise<void>

It resolves to nothing.

Throws

Throws TypeError if any parameter is invalid. Or throws Error if failed to create hard mkdir from the file.

Example

try {
await Rsvim.fs.mkdir(".rsvim");
Rsvim.cmd.echo(`Created directory ".rsvim"`);
} catch (e) {
Rsvim.cmd.echo(`Failed to create directory ".rsvim": ${e}`);
}