default

Streaming file-system utilities for the anabranch ecosystem.

c
AlreadyExists

File already exists when it should not.

I
DirEntry

An entry in a directory listing.

T
DirError

Errors that can occur when reading directories.

c
FSError

Structured error types for file-system operations.

I
FsEvent

A file-system change event, as yielded by watch.

f
glob

Finds all entries under root whose relative path matches the glob pattern.

I
GlobOptions

Options for glob. Same as WalkOptions without match.

c
InvalidData

File content is invalid (e.g., malformed JSON).

c
IsDirectory

Path is a directory when a file was expected.

c
NotDirectory

Path is not a directory when a directory was expected.

c
NotFound
No documentation available
c
PermissionDenied

Permission denied accessing the file system.

f
readDir

Lists the immediate children of a directory.

c
ReadError

Error reading from the file system.

f
readFile

Reads an entire file as a Uint8Array.

T
ReadFileError

Errors that can occur when reading files.

f
readJson

Reads a JSON file and parses it, returning the value typed as T.

T
ReadJsonError

Errors that can occur when reading JSON files.

f
readLines

Streams lines from a text file one at a time using node:readline.

f
readTextFile

Reads an entire file as a UTF-8 string.

c
Unknown

Unknown file system error.

f
walk

Recursively walks a directory tree, yielding each entry.

I
WalkEntry

A directory entry with its full path, as yielded by walk and glob.

f
watch

Watches path for file-system changes, yielding a FsEvent for each.

T
WatchError

Errors that can occur when watching the file system.

I
c
WriteError

Error writing to the file system.

f
writeFile

Writes a Uint8Array to a file, creating or overwriting it.

T
WriteFileError

Errors that can occur when writing files.

f
writeJson

Serialises value as JSON and writes it to a file, creating or overwriting it.

f
writeTextFile

Writes a UTF-8 string to a file, creating or overwriting it.