/fs/mod.ts | std@0.223.0

import * as mod from "https://deno.land/std@0.223.0/fs/mod.ts";

Helpers for working with the filesystem.

import { ensureFile, copy, ensureDir, move } from "https://deno.land/std@0.223.0/fs/mod.ts";

await ensureFile("example.txt");
await copy("example.txt", "example_copy.txt");
await ensureDir("subdir");
await move("example_copy.txt", "subdir/example_copy.txt");

Classes

c SubdirectoryMoveError	Error thrown in `move` or `moveSync` when the destination is a subdirectory of the source.
c WalkError	Error thrown in `walk` or `walkSync` during iteration.

Variables

v CRLF	End-of-line character for Windows platforms.
v EOL	End-of-line character evaluated for the current platform.
v LF	End-of-line character for POSIX platforms such as macOS and Linux.

Functions

f copy	Asynchronously copy a file or directory. The directory can have contents. Like `cp -r`.
f copySync	Synchronously copy a file or directory. The directory can have contents. Like `cp -r`.
f detect	Returns the detected EOL character(s) detected in the input string. If no EOL character is detected, `null` is returned.
f emptyDir	Asynchronously ensures that a directory is empty deletes the directory contents it is not empty. If the directory does not exist, it is created. The directory itself is not deleted.
f emptyDirSync	Synchronously ensures that a directory is empty deletes the directory contents it is not empty. If the directory does not exist, it is created. The directory itself is not deleted.
f ensureDir	Asynchronously ensures that the directory exists. If the directory structure does not exist, it is created. Like `mkdir -p`.
f ensureDirSync	Synchronously ensures that the directory exists. If the directory structure does not exist, it is created. Like `mkdir -p`.
f ensureFile	Asynchronously ensures that the file exists. If the file that is requested to be created is in directories that do not exist, these directories are created. If the file already exists, it is not modified.
f ensureFileSync	Synchronously ensures that the file exists. If the file that is requested to be created is in directories that do not exist, these directories are created. If the file already exists, it is not modified.
f ensureLink	Asynchronously ensures that the hard link exists. If the directory structure does not exist, it is created.
f ensureLinkSync	Synchronously ensures that the hard link exists. If the directory structure does not exist, it is created.
f ensureSymlink	Asynchronously ensures that the link exists, and points to a valid file. If the directory structure does not exist, it is created. If the link already exists, it is not modified but error is thrown if it is not point to the given target.
f ensureSymlinkSync	Synchronously ensures that the link exists, and points to a valid file. If the directory structure does not exist, it is created. If the link already exists, it is not modified but error is thrown if it is not point to the given target.
f exists	Asynchronously test whether or not the given path exists by checking with the file system.
f existsSync	Synchronously test whether or not the given path exists by checking with the file system.
f expandGlob	Returns an async iterator that yields each file path matching the given glob pattern. The file paths are relative to the provided `root` directory. If `root` is not provided, the current working directory is used. The `root` directory is not included in the yielded file paths.
f expandGlobSync	Returns an iterator that yields each file path matching the given glob pattern. The file paths are relative to the provided `root` directory. If `root` is not provided, the current working directory is used. The `root` directory is not included in the yielded file paths.
f format	Normalize the input string to the targeted EOL.
f move	Asynchronously moves a file or directory.
f moveSync	Synchronously moves a file or directory.
f walk	Recursively walks through a directory and yields information about each file and directory encountered.
f walkSync	Same as `walk` but uses synchronous ops

Interfaces

I CopyOptions	Options for `copy` and `copySync`.
I ExistsOptions	Options for `exists` and `existsSync.`
I ExpandGlobOptions	Options for `expandGlob` and `expandGlobSync`.
I GlobOptions	Options for `globToRegExp`.
I MoveOptions	Options for `move` and `moveSync`.
I WalkEntry	Walk entry for `walk`, `walkSync`, `expandGlob` and `expandGlobSync`.
I WalkOptions	Options for `walk` and `walkSync`.