Forest 0.2.0 API documentation

Returns absolute path.

Returns the base name (final segment/file part) of a path.

If optional trim-ext is a string and the path ends with that string, it is trimmed.

If trim-ext is true, any extension is trimmed.

Deletes a file or an empty directory.

Deletes a diretory recursively.

Deletes a file.

The platform-specific path delimiter, ‘;’ on Windows or ‘:’ on *nix.

FIXME: write docs

Returns true if path exists.

Returns the extension part of a file.

FIXME: write docs

Returns current user’s home directory

Join all arguments together and normalize the resulting path.

Arguments must be strings.

Lists files and directories under path.

Lists all files and directories under path.

Creates a directory.

Makes directory tree.

Moves a file from source to dest.

Normalizes a string path, taking care of ‘..’ and ‘.’ parts.

When multiple slashes are found, they’re replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used.

Returns the parent path.

Gets all the parent directories of a path.

The platform-specific file separator, ‘' on Windows or ’/’ on *nix.

Returns size (in bytes) of file.

Opens a file and reads all its contents, returning a string.

Like slurp but returns contents as a base64-encoded string.

Opens a file, writes content, then closes it.

Creates a temporary file.

Generates a temporary file name. Does not create file.

The temporary file directory.

Extracts compressed files in a ZIP archive

Compresses files as a ZIP archive