/fs.ts | ayonli_jsext@v0.9.72

A JavaScript extension package for building strong and modern applications.

Latest

archive array augment bundle bytes class cli collections dialog error esm examples external fastly filetype fs hash http json math module number object parallel path promise reader string uint8array workerd ws

index.ts (default module)

parallel

run

AbstractConstructor

AsyncFunction

AsyncFunctionConstructor

AsyncGeneratorFunction

tar

run

EOL

md5

avg

FunctionPropertyNames

sep

cwd

addUnhandledRejectionListener

env

AsyncFunctionConstructor

AsyncGeneratorFunction

import * as ayonliJsext from "https://deno.land/x/ayonli_jsext@v0.9.72/fs.ts";

Universal file system APIs for both server and browser applications.

This module is guaranteed to work in the following environments:

Node.js
Deno
Bun
Modern browsers
Cloudflare Workers (limited support and experimental)

We can also use the runtime function to check whether the runtime has file system support. When runtime().fsSupport is true, this module should work properly.

In most browsers, this module uses the Origin Private File System. In Chromium browsers, this module can also access the device's local file system via window.showOpenFilePicker() and window.showDirectoryPicker().

This module also provides limited support for Cloudflare Workers, however it requires setting the [site].bucket option in the wrangler.toml file. Only the reading functions are supported, such as readFile and readDir, these functions allow us reading static files in the workers, writing functions is not implemented at the moment. More details about serving static assets in Cloudflare Workers can be found here: Add static assets to an existing Workers project.

Errors:

When a file system operation fails, this module throws an Exception with one of the following names:

NotFoundError: The file or directory does not exist.
NotAllowedError: The operation is not allowed, such as being blocked by the permission system.
AlreadyExistsError: The file or directory already exists.
IsDirectoryError: The path is a directory, not a file.
NotDirectoryError: The path is a file, not a directory.
InvalidOperationError: The operation is not supported, such as trying to copy a directory without the recursive option.
BusyError: The file is busy, such as being locked by another program.
InterruptedError: The operation is interrupted by the underlying file system.
FileTooLargeError: The file is too large, or the file system doesn't have enough space to store the new content.
FilesystemLoopError: Too many symbolic links were encountered when resolving the filename.

Other errors may also be thrown by the runtime, such as TypeError.

Variables

v EOL	Platform-specific end-of-line marker. The value is `\r\n` in Windows server-side environments, and `\n` elsewhere.
v readFileAsStream deprecated

Functions

f chmod	Changes the permission of the specified file or directory.
f chown	Changes the owner and group of the specified file or directory.
f copy	Copies the file or directory (and its contents) from the old location to the new location.
f createReadableStream	Creates a readable stream for the target file.
f createWritableStream	Creates a writable stream for the target file.
f ensureDir	Ensures the directory exists, creating it (and any parent directory) if not.
f exists	Checks if the given path exists.
f getDirHandle	Obtains the directory handle of the given path.
f getFileHandle	Obtains the file handle of the given path.
f link	Creates a hard link (or symbolic link) from the source path to the destination path.
f mkdir	Creates a new directory with the given path.
f readDir	Reads the directory of the given path and iterates its entries.
f readFile	Reads the content of the given file in bytes.
f readFileAsFile	Reads the file as a `File` object.
f readFileAsText	Reads the content of the given file as text.
f readLink	Returns the destination path of a symbolic link.
f readTree	Recursively reads the contents of the directory and transform them into a tree structure.
f remove	Removes the file or directory of the given path from the file system.
f rename	Renames the file or directory from the old path to the new path.
f stat	Returns the information of the given file or directory.
f truncate	Truncates (or extends) the file to reach the specified `size`. If `size` is not specified then the entire file contents are truncated.
f utimes	Changes the access (`atime`) and modification (`mtime`) times of the file or directory. Given times are either in seconds (UNIX epoch time) or as `Date` objects.
f writeFile	Writes the given data to the file.
f writeLines	Writes multiple lines of content to the file.

Interfaces

I CopyOptions	Options for the copy function.
I DirEntry	Information about a directory entry.
I DirTree
I FileInfo	Information about a file or directory.
I FileSystemOptions	Common options for file system operations.
I GetDirOptions	Options for the getDirHandle function.
I GetFileOptions	Options for the getFileHandle function.
I LinkOptions	Options for the link function.
I MkdirOptions	Options for the mkdir function.
I ReadDirOptions	Options for the readDir function.
I ReadFileOptions	Options for file reading functions, such as readFile, readFileAsText and readFileAsFile.
I RemoveOptions	Options for the remove function.
I StatOptions	Options for the stat function.
I WriteFileOptions	Options for file writing functions, such as writeFile and writeLines.

Type Aliases

CommonOptions

deprecated