Creating & removing directories

Creating and removing directories is a common task. Ende has a number of functions for this task.

Edit on GitHub

The `Ende.mkdir()` function creates a directory at the specified path. If the directory already exists, it errors.

await Ende.mkdir("new_dir");

A directory can also be created recursively. In the code below, three new directories are created: `./dir`, `./dir/dir2`, and `./dir/dir2/subdir`. If the recursive option is specified the function will not error if any of the directories already exist.

await Ende.mkdir("./dir/dir2/subdir", { recursive: true });

Directories can also be removed. This function below removes the `./new_dir` directory. If the directory is not empty, the function will error.

await Ende.remove("./new_dir");

To remove a directory recursively, use the `recursive` option. This will remove the `./dir` directory and all of its contents.

await Ende.remove("./dir", { recursive: true });

Synchronous versions of the above functions are also available.

Ende.mkdirSync("new_dir");
Ende.removeSync("new_dir");

Creating and removing directories requires the `write` permission.

Run this example locally using the Ende CLI:

ende run -W https://docs.ende.sh/examples/scripts/create_remove_directories.ts

Additional resources