@netwiv/api/plugins/fs

Export	Kind	Summary
BaseDirectory	Enum
copyFile	Function	Copies the contents and permissions of one file to another specified path, by default creating a new file if needed, else overwriting.
CopyFileOptions	Interface
create	Function	Creates a file if none exists or truncates an existing file and resolves to an instance of {@linkcode FileHandle}.
CreateOptions	Interface
DebouncedWatchOptions	Interface
DirEntry	Interface	A disk entry which is either a file, a directory or a symlink.
exists	Function	Check if a path exists.
ExistsOptions	Interface
FileHandle	Class	The Tauri abstraction for reading and writing files.
FileInfo	Interface	A FileInfo describes a file and is returned by stat, lstat or fstat.
lstat	Function	Resolves to a {@linkcode FileInfo} for the specified path.
mkdir	Function	Creates a new directory with the specified path.
MkdirOptions	Interface
open	Function	Open a file and resolve to an instance of {@linkcode FileHandle}.
OpenOptions	Interface
readDir	Function	Reads the directory given by path and returns an array of DirEntry.
ReadDirOptions	Interface
readFile	Function	Reads and resolves to the entire contents of a file as an array of bytes.
ReadFileOptions	Interface
readTextFile	Function	Reads and returns the entire contents of a file as a string using the specified encoding (default: UTF-8).
readTextFileLines	Function	Returns an async {@linkcode AsyncIterableIterator} over the lines of a file, decoded using the specified encoding (default: UTF-8).
remove	Function	Removes the named file or directory.
RemoveOptions	Interface
rename	Function	Renames (moves) oldpath to newpath.
RenameOptions	Interface
SeekMode	Enum
size	Function	Get the size of a file or directory.
stat	Function	Resolves to a {@linkcode FileInfo} for the specified path.
StatOptions	Interface
truncate	Function	Truncates or extends the specified file, to reach the specified len.
TruncateOptions	Interface
UnwatchFn	Type
watch	Function	Watch changes (after a delay) on files or directories.
WatchEvent	Interface
WatchEventKind	Type
WatchEventKindAccess	Type
WatchEventKindCreate	Type
WatchEventKindModify	Type
WatchEventKindRemove	Type
watchImmediate	Function	Watch changes on files or directories.
WatchOptions	Interface
writeFile	Function	Write data to the given path, by default creating a new file if needed, else overwriting.
WriteFileOptions	Interface
writeTextFile	Function	Writes UTF-8 string data to the given path, by default creating a new file if needed, else overwriting.