Class FileSystem`Abstract` `Internal`

Provides a consistent and easy to use internal API. Default implementations for exists and existsSync are included. 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:97

Properties

`Protected` `Optional` `Internal`_disableSync

_disableSync?: boolean

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

Methods

`Abstract`createFile

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

`Abstract`createFileSync

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

exists

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

existsSync

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

`Abstract`link

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

`Abstract`linkSync

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

metadata

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

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

`Abstract`mkdir

mkdir(path, mode): Promise<void>
Parameters
- path: string
- mode: number
Returns Promise<void>
- Defined in src/filesystem.ts:139

`Abstract`mkdirSync

mkdirSync(path, mode): void
Parameters
- path: string
- mode: number
Returns void
- Defined in src/filesystem.ts:140

`Abstract`openFile

openFile(path, flag): Promise<File<FileSystem>>
Opens the file at path with 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<FileSystem>>
- Defined in src/filesystem.ts:112

`Abstract`openFileSync

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

`Abstract`readdir

readdir(path): Promise<string[]>
Parameters
- path: string
Returns Promise<string[]>
- Defined in src/filesystem.ts:142

`Abstract`readdirSync

readdirSync(path): string[]
Parameters
- path: string
Returns string[]
- Defined in src/filesystem.ts:143

ready

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

`Abstract`rename

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

`Abstract`renameSync

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

`Abstract`rmdir

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

`Abstract`rmdirSync

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

`Abstract`stat

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

`Abstract`statSync

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

`Abstract`sync

sync(path, data, stats): Promise<void>
Parameters
- path: string
- data: Uint8Array
- stats: Readonly<Stats>
Returns Promise<void>
- Defined in src/filesystem.ts:172

`Abstract`syncSync

syncSync(path, data, stats): void
Parameters
- path: string
- data: Uint8Array
- stats: Readonly<Stats>
Returns void
- Defined in src/filesystem.ts:173

`Abstract`unlink

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

`Abstract`unlinkSync

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