Class StoreFS<T>`Internal`

A file system which uses a Store

Todo

Check modes?

Type Parameters

T extends Store = Store

Hierarchy (View Summary)

FileSystem
- StoreFS
  - DeviceFS

Constructors

constructor

new StoreFS<T extends Store = Store>(store: T): StoreFS<T>
Type Parameters
- T extends Store = Store
Parameters
- store: T
Returns StoreFS<T>
Overrides FileSystem.constructor
- Defined in src/backends/store/fs.ts:99

Properties

`Protected`_initialized

_initialized: boolean = false

`Protected` `Optional` `Internal`_mountPoint

_mountPoint?: string

The last place this file system was mounted

`Protected` `Internal`_uuid

_uuid: `${string}-${string}-${string}-${string}-${string}` = ...

The UUID of the file system.

`Readonly`attributes

attributes: ConstMap<
    FileSystemAttributes,
    keyof FileSystemAttributes,
    undefined
    | void
    | CaseFold,
> & Map<string, any> = ...

See

FileSystemAttributes

`Optional`label

label?: string

`Readonly`name

name: string

The name for this file system. For example, tmpfs for an in memory one

`Protected` `Readonly`store

store: T

`Readonly`type

type: number

A unique ID for this kind of file system. Currently unused internally, but could be used for partition tables or something

Accessors

uuid

get uuid(): `${string}-${string}-${string}-${string}-${string}`
Returns `${string}-${string}-${string}-${string}-${string}`
Inherited from FileSystem.uuid
- Defined in src/internal/filesystem.ts:165

Methods

_add

_add(ino: number, path: string): void
Add a inode/path pair
Parameters
- ino: number
- path: string
Returns void
- Defined in src/backends/store/fs.ts:46

_move

_move(from: string, to: string): void
Move paths in the tables
Parameters
- from: string
- to: string
Returns void
- Defined in src/backends/store/fs.ts:65

_path

_path(id: number): undefined | string
Gets the first path associated with an inode
Parameters
- id: number
Returns undefined | string
- Defined in src/backends/store/fs.ts:38

_remove

_remove(ino: number): void
Remove a inode/path pair
Parameters
- ino: number
Returns void
- Defined in src/backends/store/fs.ts:55

`Protected`allocNew

allocNew(path: string): number
Allocates a new ID and adds the ID/path
Parameters
- path: string
Returns number
- Defined in src/backends/store/fs.ts:682

checkRoot

checkRoot(): Promise<void>
Checks if the root directory exists. Creates it if it doesn't.

Returns Promise<void>
- Defined in src/backends/store/fs.ts:510

checkRootSync

checkRootSync(): void
Checks if the root directory exists. Creates it if it doesn't.

Returns void
- Defined in src/backends/store/fs.ts:525

`Protected`commitNew

commitNew(
    path: string,
    options: CreationOptions,
    data: Uint8Array,
): Promise<Inode>
Commits a new file (well, a FILE or a DIRECTORY) to the file system with mode. Note: This will commit the transaction.
Parameters
- path: string
  The path to the new file.
- options: CreationOptions
  The options to create the new file with.
- data: Uint8Array
  The data to store at the file's data node.
Returns Promise<Inode>
- Defined in src/backends/store/fs.ts:698

`Protected`commitNewSync

commitNewSync(path: string, options: CreationOptions, data: Uint8Array): Inode
Commits a new file (well, a FILE or a DIRECTORY) to the file system with mode. Note: This will commit the transaction.
Parameters
- path: string
  The path to the new file.
- options: CreationOptions
  The options to create the new file with.
- data: Uint8Array
  The data to store at the file's data node.
Returns Inode
The Inode for the new file.
- Defined in src/backends/store/fs.ts:744

createFile

createFile(path: string, options: CreationOptions): Promise<InodeLike>
Create the file at path with the given options.
Parameters
- path: string
- options: CreationOptions
Returns Promise<InodeLike>
Overrides FileSystem.createFile
- Defined in src/backends/store/fs.ts:341

createFileSync

createFileSync(path: string, options: CreationOptions): InodeLike
Create the file at path with the given options.
Parameters
- path: string
- options: CreationOptions
Returns InodeLike
Overrides FileSystem.createFileSync
- Defined in src/backends/store/fs.ts:346

createIndex

createIndex(): Promise<Index>
Returns Promise<Index>
- Defined in src/backends/store/fs.ts:155

createIndexSync

createIndexSync(): Index
Returns Index
- Defined in src/backends/store/fs.ts:183

exists

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

existsSync

existsSync(path: string): boolean
Test whether or not path exists.
Parameters
- path: string
Returns boolean
Inherited from FileSystem.existsSync
- Defined in src/internal/filesystem.ts:260

`Protected`findInode

findInode(tx: WrappedTransaction, path: string): Promise<Inode>
Finds the Inode of path.
Parameters
- tx: WrappedTransaction
- path: string
  The path to look up.
Returns Promise<Inode>
Todo
memoize/cache
- Defined in src/backends/store/fs.ts:659

`Protected`findInodeSync

findInodeSync(tx: WrappedTransaction, path: string): Inode
Finds the Inode of path.
Parameters
- tx: WrappedTransaction
- path: string
  The path to look up.
Returns Inode
The Inode of the path p.

Todo
memoize/cache
- Defined in src/backends/store/fs.ts:672

link

link(target: string, link: string): Promise<void>
Parameters
- target: string
- link: string
Returns Promise<void>
Overrides FileSystem.link
- Defined in src/backends/store/fs.ts:401

linkSync

linkSync(target: string, link: string): void
Parameters
- target: string
- link: string
Returns void
Overrides FileSystem.linkSync
- Defined in src/backends/store/fs.ts:419

loadIndex

loadIndex(index: Index): Promise<void>
Load an index into the StoreFS. You must manually add non-directory files
Parameters
- index: Index
Returns Promise<void>
- Defined in src/backends/store/fs.ts:123

loadIndexSync

loadIndexSync(index: Index): void
Load an index into the StoreFS. You must manually add non-directory files
Parameters
- index: Index
Returns void
- Defined in src/backends/store/fs.ts:141

mkdir

mkdir(path: string, options: CreationOptions): Promise<InodeLike>
Parameters
- path: string
- options: CreationOptions
Returns Promise<InodeLike>
Overrides FileSystem.mkdir
- Defined in src/backends/store/fs.ts:369

mkdirSync

mkdirSync(path: string, options: CreationOptions): InodeLike
Parameters
- path: string
- options: CreationOptions
Returns InodeLike
Overrides FileSystem.mkdirSync
- Defined in src/backends/store/fs.ts:374

read

read(
    path: string,
    buffer: Uint8Array,
    offset: number,
    end: number,
): Promise<void>
Reads into a buffer
Parameters
- path: string
- buffer: Uint8Array
  The buffer to read into. You must set the byteOffset and byteLength appropriately!
- offset: number
- end: number
  The position in the file to stop reading
Returns Promise<void>
Overrides FileSystem.read
- Defined in src/backends/store/fs.ts:437

readdir

readdir(path: string): Promise<string[]>
Parameters
- path: string
Returns Promise<string[]>
Overrides FileSystem.readdir
- Defined in src/backends/store/fs.ts:379

readdirSync

readdirSync(path: string): string[]
Parameters
- path: string
Returns string[]
Overrides FileSystem.readdirSync
- Defined in src/backends/store/fs.ts:385

readSync

readSync(path: string, buffer: Uint8Array, offset: number, end: number): void
Reads into a buffer
Parameters
- path: string
- buffer: Uint8Array
  The buffer to read into. You must set the byteOffset and byteLength appropriately!
- offset: number
- end: number
  The position in the file to stop reading
Returns void
Overrides FileSystem.readSync
- Defined in src/backends/store/fs.ts:449

ready

ready(): Promise<void>
Returns Promise<void>
Overrides FileSystem.ready
- Defined in src/backends/store/fs.ts:90

`Protected`remove

remove(path: string, isDir: boolean): Promise<void>
Remove all traces of path from the file system.
Parameters
- path: string
  The path to remove from the file system.
- isDir: boolean
  Does the path belong to a directory, or a file?
Returns Promise<void>
- Defined in src/backends/store/fs.ts:785

`Protected`removeSync

removeSync(path: string, isDir: boolean): void
Remove all traces of path from the file system.
Parameters
- path: string
  The path to remove from the file system.
- isDir: boolean
  Does the path belong to a directory, or a file?
Returns void
- Defined in src/backends/store/fs.ts:821

rename

rename(oldPath: string, newPath: string): Promise<void>
Parameters
- oldPath: string
- newPath: string
Returns Promise<void>
Todo
Make rename compatible with the cache.
Overrides FileSystem.rename
- Defined in src/backends/store/fs.ts:214

renameSync

renameSync(oldPath: string, newPath: string): void
Parameters
- oldPath: string
- newPath: string
Returns void
Overrides FileSystem.renameSync
- Defined in src/backends/store/fs.ts:260

rmdir

rmdir(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
Overrides FileSystem.rmdir
- Defined in src/backends/store/fs.ts:359

rmdirSync

rmdirSync(path: string): void
Parameters
- path: string
Returns void
Overrides FileSystem.rmdirSync
- Defined in src/backends/store/fs.ts:364

stat

stat(path: string): Promise<InodeLike>
Parameters
- path: string
Returns Promise<InodeLike>
Overrides FileSystem.stat
- Defined in src/backends/store/fs.ts:306

statSync

statSync(path: string): InodeLike
Parameters
- path: string
Returns InodeLike
Overrides FileSystem.statSync
- Defined in src/backends/store/fs.ts:311

streamRead

streamRead(path: string, options: StreamOptions): ReadableStream
Read a file using a stream.
Parameters
- path: string
- options: StreamOptions
Returns ReadableStream
Inherited from FileSystem.streamRead
- Defined in src/internal/filesystem.ts:308

streamWrite

streamWrite(path: string, options: StreamOptions): WritableStream
Write a file using stream.
Parameters
- path: string
- options: StreamOptions
Returns WritableStream
Inherited from FileSystem.streamWrite
- Defined in src/internal/filesystem.ts:331

sync

sync(): Promise<void>
Updated the inode and data node at path

Returns Promise<void>
Overrides FileSystem.sync
- Defined in src/backends/store/fs.ts:394

syncSync

syncSync(): void
Updated the inode and data node at path

Returns void
Overrides FileSystem.syncSync
- Defined in src/backends/store/fs.ts:399

toString

toString(): string
Returns string
Inherited from FileSystem.toString
- Defined in src/internal/filesystem.ts:191

touch

touch(path: string, metadata: Partial<InodeLike>): Promise<void>
Modify metadata.
Parameters
- path: string
- metadata: Partial<InodeLike>
Returns Promise<void>
Overrides FileSystem.touch
- Defined in src/backends/store/fs.ts:316

touchSync

touchSync(path: string, metadata: Partial<InodeLike>): void
Modify metadata.
Parameters
- path: string
- metadata: Partial<InodeLike>
Returns void
Overrides FileSystem.touchSync
- Defined in src/backends/store/fs.ts:328

unlink

unlink(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
Overrides FileSystem.unlink
- Defined in src/backends/store/fs.ts:351

unlinkSync

unlinkSync(path: string): void
Parameters
- path: string
Returns void
Overrides FileSystem.unlinkSync
- Defined in src/backends/store/fs.ts:355

usage

usage(): UsageInfo
Experimental
Returns UsageInfo
Overrides FileSystem.usage
- Defined in src/backends/store/fs.ts:110

write

write(path: string, data: Uint8Array, offset: number): Promise<void>
Writes a buffer to a file
Parameters
- path: string
- data: Uint8Array
- offset: number
  The offset in the file to start writing
Returns Promise<void>
Overrides FileSystem.write
- Defined in src/backends/store/fs.ts:461

writeSync

writeSync(path: string, data: Uint8Array, offset: number): void
Writes a buffer to a file
Parameters
- path: string
- data: Uint8Array
- offset: number
  The offset in the file to start writing
Returns void
Overrides FileSystem.writeSync
- Defined in src/backends/store/fs.ts:480

Class StoreFS<T>Internal

Todo

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns StoreFS<T>

Properties

Protected_initialized

Protected Optional Internal_mountPoint

Protected Internal_uuid

Readonlyattributes

See

Optionallabel

Readonlyname

Protected Readonlystore

Readonlytype

Accessors

uuid

Returns `${string}-${string}-${string}-${string}-${string}`

Methods

_add

Parameters

Returns void

_move

Parameters

Returns void

_path

Parameters

Returns undefined | string

_remove

Parameters

Returns void

ProtectedallocNew

Parameters

Returns number

checkRoot

Returns Promise<void>

checkRootSync

Returns void

ProtectedcommitNew

Parameters

Returns Promise<Inode>

ProtectedcommitNewSync

Parameters

Returns Inode

createFile

Parameters

Returns Promise<InodeLike>

createFileSync

Parameters

Returns InodeLike

createIndex

Returns Promise<Index>

createIndexSync

Returns Index

exists

Parameters

Returns Promise<boolean>

existsSync

Parameters

Returns boolean

ProtectedfindInode

Parameters

Returns Promise<Inode>

Todo

ProtectedfindInodeSync

Parameters

Returns Inode

Todo

link

Parameters

Returns Promise<void>

Class StoreFS<T>`Internal`

`Protected`_initialized

`Protected` `Optional` `Internal`_mountPoint

`Protected` `Internal`_uuid

`Readonly`attributes

`Optional`label

`Readonly`name

`Protected` `Readonly`store

`Readonly`type

`Protected`allocNew

`Protected`commitNew

`Protected`commitNewSync

`Protected`findInode

`Protected`findInodeSync

`Protected`remove

`Protected`removeSync