Reference

Directory

Note: Directory functions are not implemented on the web platform.

From path

Input A string.
Output A directory pointing to the given path.

Signature

directory_fromPath(a: String): Directory

Example

directory_fromPath("/home/user") // returns a directory object

Create

Input A directory.
Output True if the directory was created, false otherwise.

Signature

directory_create(a: Directory): Boolean

Example

directory_create(directory_fromPath("/home/user/new")) // returns true if successful

Exists

Input A directory.
Output True if the directory exists, false otherwise.

Signature

directory_exists(a: Directory): Boolean

Example

directory_exists(directory_fromPath("/home/user")) // returns true if it exists

Delete

Input A directory.
Output True if the directory was deleted, false otherwise.

Signature

directory_delete(a: Directory): Boolean

Example

directory_delete(directory_fromPath("/home/user/old")) // returns true if successful

Copy

Input Two directories.
Output True if the directory was copied, false otherwise.

Signature

directory_copy(a: Directory, b: Directory): Boolean

Example

directory_copy(
    directory_fromPath("src"),
    directory_fromPath("backup")
) // returns true if successful

Move

Input Two directories.
Output True if the directory was moved, false otherwise.

Signature

directory_move(a: Directory, b: Directory): Boolean

Example

directory_move(
    directory_fromPath("old"),
    directory_fromPath("new")
) // returns true if successful

Rename

Input A directory and a string.
Output True if the directory was renamed, false otherwise.

Signature

directory_rename(a: Directory, b: String): Boolean

Example

directory_rename(directory_fromPath("old"), "new") // returns true if successful

List

Input A directory.
Output A list of directories and files in the directory.

Signature

directory_list(a: Directory): List

Example

directory_list(directory_fromPath("/home/user")) // returns [file1, file2, ...]

Path

Input A directory.
Output The path of the directory.

Signature

directory_path(a: Directory): String

Example

directory_path(directory_fromPath("/home/user")) // returns "/home/user"

Name

Input A directory.
Output The name of the directory.

Signature

directory_name(a: Directory): String

Example

directory_name(directory_fromPath("/home/user")) // returns "user"

Parent

Input A directory.
Output The parent directory.

Signature

directory_parent(a: Directory): Directory

Example

directory_parent(directory_fromPath("/home/user")) // returns "/home" directory