Class IndexedDbFsClient

Represents FsClient implementation which uses IndexedDB API under the hood for persistent storage. Meant to be used in a browser environment.

Limitations

Symlinks are not supported
No support for any statistics returned by stat or lstat methods
No support for empty directories creation, essentially it behaves very similar to Git which does not store empty directories

Hierarchy

IndexedDbFsClient

Implements

FsClient

Index

Constructors

constructor

Methods

exists lstat mkdir readFile readdir readlink rename rm stat symlink writeFile

Constructors

constructor

new IndexedDbFsClient(name: string): IndexedDbFsClient
Parameters
- name: string
Returns IndexedDbFsClient
- Defined in src/clients/fs/IndexedDbFsClient.ts:48

Methods

exists

exists(path: string): Promise<boolean>
Return true if a entry exists, false if it doesn't exist. Rethrows errors that aren't related to entry existance.
Parameters
- path: string
Returns Promise<boolean>
- Defined in src/clients/fs/IndexedDbFsClient.ts:248

lstat

lstat(path: string): Promise<StatsLike>
Returns information about the given file or directory.

Remarks
The method is similar to the stat method except it doesn't follow symlinks. When given a path that is a symlink it returns the stat of the symlink and not its target.

Throws
ENOENT
Parameters
- path: string
Returns Promise<StatsLike>
Implementation of FsClient.lstat
- Defined in src/clients/fs/IndexedDbFsClient.ts:177

mkdir

mkdir(path: string): Promise<void>
Asynchronously creates a directory.

Throws
ENOENT

Throws
EEXIST
Parameters
- path: string
Returns Promise<void>
Implementation of FsClient.mkdir
- Defined in src/clients/fs/IndexedDbFsClient.ts:124

readFile

readFile(path: string, options?: EncodingOptions): Promise<string | Uint8Array>
Asynchronously reads the entire contents of a file.

Returns
Resolves with the contents of the file as an Uint8Array or a string if the encoding is set to utf8.

Throws
ENOENT
Parameters
- path: string
- options: EncodingOptions = {}
Returns Promise<string | Uint8Array>
Implementation of FsClient.readFile
- Defined in src/clients/fs/IndexedDbFsClient.ts:50

readdir

readdir(path: string): Promise<string[]>
Reads the contents of a directory.

Throws
ENOENT

Throws
ENOTDIR
Parameters
- path: string
Returns Promise<string[]>
Implementation of FsClient.readdir
- Defined in src/clients/fs/IndexedDbFsClient.ts:81

readlink

readlink(path: string): Promise<string>
Symlinks are not supported in the current implementation.

Throws
Error: symlinks are not supported.
Parameters
- path: string
Returns Promise<string>
Implementation of FsClient.readlink
- Defined in src/clients/fs/IndexedDbFsClient.ts:232

rename

rename(oldPath: string, newPath: string): Promise<void>
Renames oldPath to newPath.

Throws
ENOENT
Parameters
- oldPath: string
- newPath: string
Returns Promise<void>
Implementation of FsClient.rename
- Defined in src/clients/fs/IndexedDbFsClient.ts:181

rm

rm(path: string, options?: RmOptions): Promise<void>
Removes files and directories.

Throws
ENOENT

Throws
ENOTEMPTY
Parameters
- path: string
- options: RmOptions = {}
Returns Promise<void>
Implementation of FsClient.rm
- Defined in src/clients/fs/IndexedDbFsClient.ts:126

stat

stat(path: string): Promise<StatsLike>
Returns information about the given file or directory.

Remarks
The method follows symlinks. When given a path that is a symlink, it returns the stat of the target of the symlink.

Throws
ENOENT
Parameters
- path: string
Returns Promise<StatsLike>
Implementation of FsClient.stat
- Defined in src/clients/fs/IndexedDbFsClient.ts:153

symlink

symlink(target: string, path: string): Promise<void>
Symlinks are not supported in the current implementation.

Throws
Error: symlinks are not supported.
Parameters
- target: string
- path: string
Returns Promise<void>
Implementation of FsClient.symlink
- Defined in src/clients/fs/IndexedDbFsClient.ts:240

writeFile

writeFile(path: string, data: string | Uint8Array, options?: EncodingOptions): Promise<void>
Asynchronously writes data to a file, replacing the file if it already exists.

Remarks
Data can be a string or an Uint8Array. The encoding option is ignored if data is an Uint8Array.

Throws
ENOENT
Parameters
- path: string
- data: string | Uint8Array
- Optional options: EncodingOptions
Returns Promise<void>
Implementation of FsClient.writeFile
- Defined in src/clients/fs/IndexedDbFsClient.ts:70

Class IndexedDbFsClient

Limitations

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

name: string

Returns IndexedDbFsClient

Methods

exists

Parameters

path: string

Returns Promise<boolean>

lstat

Remarks

Throws

Parameters

path: string

Returns Promise<StatsLike>

mkdir

Throws

Throws

Parameters

path: string

Returns Promise<void>

readFile

Returns

Throws

Parameters

path: string

options: EncodingOptions = {}

Returns Promise<string | Uint8Array>

readdir

Throws

Throws

Parameters

path: string

Returns Promise<string[]>

readlink

Throws

Parameters

path: string

Returns Promise<string>

rename

Throws

Parameters

oldPath: string

newPath: string

Returns Promise<void>

rm

Throws

Throws

Parameters

path: string

options: RmOptions = {}

Returns Promise<void>

stat

Remarks

Throws

Parameters

path: string

Returns Promise<StatsLike>

symlink

Throws

Parameters

target: string

path: string

Returns Promise<void>

writeFile

Remarks

Throws

Parameters

path: string

data: string | Uint8Array

Optional options: EncodingOptions

Returns Promise<void>

`Optional` options: EncodingOptions