Class FileSystem`Abstract`

Structure for a filesystem. All ZenFS backends must extend this.

This class includes default implementations for exists and existsSync

If you are extending this class, note that every path is an absolute path and all arguments are present.

Hierarchy (view full)

FileSystem
- UnmutexedOverlayFS
- StoreFS

Index

Constructors

Properties

Constructors

constructor

new FileSystem(...args): FileSystem
Parameters
- Rest ...args: any[]
Returns FileSystem
- Defined in src/filesystem.ts:98

Properties

`Optional` `Protected` `Internal` _disableSync

_disableSync?: boolean

Whether the sync cache should be disabled. Only affects async things.

Methods

`Abstract` createFile

createFile(path, flag, mode): Promise<File>
Create the file at path with the given mode. Then, open it with the given flag.
Parameters
- path: string
- flag: string
- mode: number
Returns Promise<File>
- Defined in src/filesystem.ts:139

`Abstract` createFileSync

createFileSync(path, flag, mode): File
Create the file at path with the given mode. Then, open it with the given flag.
Parameters
- path: string
- flag: string
- mode: number
Returns File
- Defined in src/filesystem.ts:144

exists

exists(path): Promise<boolean>
Test whether or not the given path exists.
Parameters
- path: string
Returns Promise<boolean>
- Defined in src/filesystem.ts:185

existsSync

existsSync(path): boolean
Test whether or not the given path exists.
Parameters
- path: string
Returns boolean
- Defined in src/filesystem.ts:197

`Abstract` link

link(target, link): Promise<void>
Asynchronous link.
Parameters
- target: string
- link: string
Returns Promise<void>
- Defined in src/filesystem.ts:209

`Abstract` linkSync

linkSync(target, link): void
Synchronous link.
Parameters
- target: string
- link: string
Returns void
- Defined in src/filesystem.ts:214

metadata

metadata(): FileSystemMetadata
Get metadata about the current file system

Returns FileSystemMetadata
- Defined in src/filesystem.ts:78

`Abstract` mkdir

mkdir(path, mode): Promise<void>
Asynchronous mkdir.
Parameters
- path: string
- mode: number
  Mode to make the directory using.
Returns Promise<void>
- Defined in src/filesystem.ts:167

`Abstract` mkdirSync

mkdirSync(path, mode): void
Synchronous mkdir.
Parameters
- path: string
- mode: number
  Mode to make the directory using.
Returns void
- Defined in src/filesystem.ts:172

`Abstract` openFile

openFile(path, flag): Promise<File>
Opens the file at path with the given flag. The file must exist.
Parameters
- path: string
  The path to open.
- flag: string
  The flag to use when opening the file.
Returns Promise<File>
- Defined in src/filesystem.ts:126

`Abstract` openFileSync

openFileSync(path, flag): File
Opens the file at path with the given flag. The file must exist.
Parameters
- path: string
  The path to open.
- flag: string
  The flag to use when opening the file.
Returns File
A File object corresponding to the opened file.
- Defined in src/filesystem.ts:134

`Abstract` readdir

readdir(path): Promise<string[]>
Asynchronous readdir. Reads the contents of a directory.
Parameters
- path: string
Returns Promise<string[]>
- Defined in src/filesystem.ts:176

`Abstract` readdirSync

readdirSync(path): string[]
Synchronous readdir. Reads the contents of a directory.
Parameters
- path: string
Returns string[]
- Defined in src/filesystem.ts:180

ready

ready(): Promise<void>
Returns Promise<void>
- Defined in src/filesystem.ts:100

`Abstract` rename

rename(oldPath, newPath): Promise<void>
Asynchronous rename.
Parameters
- oldPath: string
- newPath: string
Returns Promise<void>
- Defined in src/filesystem.ts:105

`Abstract` renameSync

renameSync(oldPath, newPath): void
Synchronous rename.
Parameters
- oldPath: string
- newPath: string
Returns void
- Defined in src/filesystem.ts:109

`Abstract` rmdir

rmdir(path): Promise<void>
Asynchronous rmdir.
Parameters
- path: string
Returns Promise<void>
- Defined in src/filesystem.ts:158

`Abstract` rmdirSync

rmdirSync(path): void
Synchronous rmdir.
Parameters
- path: string
Returns void
- Defined in src/filesystem.ts:162

`Abstract` stat

stat(path): Promise<Stats>
Asynchronous stat.
Parameters
- path: string
Returns Promise<Stats>
- Defined in src/filesystem.ts:114

`Abstract` statSync

statSync(path): Stats
Synchronous stat.
Parameters
- path: string
Returns Stats
- Defined in src/filesystem.ts:119

`Abstract` sync

sync(path, data, stats): Promise<void>
Synchronize the data and stats for path asynchronously
Parameters
- path: string
- data: Uint8Array
- stats: Readonly<Stats>
Returns Promise<void>
- Defined in src/filesystem.ts:219

`Abstract` syncSync

syncSync(path, data, stats): void
Synchronize the data and stats for path synchronously
Parameters
- path: string
- data: Uint8Array
- stats: Readonly<Stats>
Returns void
- Defined in src/filesystem.ts:224

`Abstract` unlink

unlink(path): Promise<void>
Asynchronous unlink.
Parameters
- path: string
Returns Promise<void>
- Defined in src/filesystem.ts:149

`Abstract` unlinkSync

unlinkSync(path): void
Synchronous unlink.
Parameters
- path: string
Returns void
- Defined in src/filesystem.ts:153