Class DeviceFS

A temporary file system that manages and interfaces with devices

Hierarchy (View Summary)

StoreFS<InMemoryStore>
- DeviceFS

Constructors

constructor

new DeviceFS(): DeviceFS
Returns DeviceFS
Overrides StoreFS.constructor
- Defined in src/devices.ts:347

Properties

`Protected` `Optional` `Internal`_disableSync

_disableSync?: boolean

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

`Protected`_initialized

_initialized: boolean = false

`Protected` `Readonly`devices

devices: Map<string, Device<any>> = ...

`Protected` `Readonly`store

store: InMemoryStore

Methods

_createDevice

_createDevice<TData = any>(
driver: DeviceDriver<TData>,
options?: object,
): Device<Record<string, never> | TData>
Internal
Type Parameters
- TData = any
Parameters
- driver: DeviceDriver<TData>
- options: object = {}
Returns Device<Record<string, never> | TData>
- Defined in src/devices.ts:317

addDefaults

addDefaults(): void
Adds default devices

Returns void
- Defined in src/devices.ts:339

`Protected`allocNew

allocNew(tx: Transaction<Store>, path: string, syscall: string): Promise<number>
Adds a new node under a random ID. Retries before giving up in the exceedingly unlikely chance that we try to reuse a random id.
Parameters
- tx: Transaction<Store>
- path: string
- syscall: string
Returns Promise<number>
Inherited from StoreFS.allocNew
- Defined in src/backends/store/fs.ts:575

`Protected`allocNewSync

allocNewSync(tx: Transaction<Store>, path: string, syscall: string): number
Creates a new node under a random ID. Retries before giving up in the exceedingly unlikely chance that we try to reuse a random id.
Parameters
- tx: Transaction<Store>
- path: string
- syscall: string
Returns number
The ino that the data was stored under.
Inherited from StoreFS.allocNewSync
- Defined in src/backends/store/fs.ts:591

checkRoot

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

Returns Promise<void>
Inherited from StoreFS.checkRoot
- Defined in src/backends/store/fs.ts:457

checkRootSync

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

Returns void
Inherited from StoreFS.checkRootSync
- Defined in src/backends/store/fs.ts:473

`Protected`commitNew

commitNew(
    path: string,
    type: FileType,
    options: PureCreationOptions,
    data: Uint8Array<ArrayBufferLike>,
    syscall: string,
): 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.
- type: FileType
  The type of the new file.
- options: PureCreationOptions
- data: Uint8Array<ArrayBufferLike>
  The data to store at the file's data node.
- syscall: string
Returns Promise<Inode>
Inherited from StoreFS.commitNew
- Defined in src/backends/store/fs.ts:610

`Protected`commitNewSync

commitNewSync(
    path: string,
    type: FileType,
    options: PureCreationOptions,
    data: Uint8Array<ArrayBufferLike>,
    syscall: string,
): 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.
- type: FileType
  The type of the new file.
- options: PureCreationOptions
- data: Uint8Array<ArrayBufferLike>
  The data to store at the file's data node.
- syscall: string
Returns Inode
The Inode for the new file.
Inherited from StoreFS.commitNewSync
- Defined in src/backends/store/fs.ts:658

createDevice

createDevice<TData = any>(
    path: string,
    driver: DeviceDriver<TData>,
    options?: object,
): Device<TData | Record<string, never>>
Creates a new device at path relative to the DeviceFS root.
Type Parameters
- TData = any
Parameters
- path: string
- driver: DeviceDriver<TData>
- options: object = {}
Returns Device<TData | Record<string, never>>
Deprecated
- Defined in src/devices.ts:277

createFile

createFile(
    path: string,
    flag: string,
    mode: number,
    options: CreationOptions,
): Promise<File<FileSystem>>
Create the file at path with the given options. Then, open it with flag.
Parameters
- path: string
- flag: string
- mode: number
- options: CreationOptions
Returns Promise<File<FileSystem>>
Overrides StoreFS.createFile
- Defined in src/devices.ts:401

createFileSync

createFileSync(
    path: string,
    flag: string,
    mode: number,
    options: CreationOptions,
): File<FileSystem>
Create the file at path with the given options. Then, open it with flag.
Parameters
- path: string
- flag: string
- mode: number
- options: CreationOptions
Returns File<FileSystem>
Overrides StoreFS.createFileSync
- Defined in src/devices.ts:408

createIndex

createIndex(): Promise<Index>
Returns Promise<Index>
Inherited from StoreFS.createIndex
- Defined in src/backends/store/fs.ts:105

createIndexSync

createIndexSync(): Index
Returns Index
Inherited from StoreFS.createIndexSync
- Defined in src/backends/store/fs.ts:133

`Protected`devicesWithDriver

devicesWithDriver(
driver: string | DeviceDriver<unknown>,
forceIdentity?: boolean,
): Device<any>[]
Parameters
- driver: string | DeviceDriver<unknown>
- OptionalforceIdentity: boolean
Returns Device<any>[]
- Defined in src/devices.ts:298

empty

empty(): Promise<void>
Delete all contents stored in the file system.

Returns Promise<void>
Deprecated
Inherited from StoreFS.empty
- Defined in src/backends/store/fs.ts:54

emptySync

emptySync(): void
Delete all contents stored in the file system.

Returns void
Deprecated
Inherited from StoreFS.emptySync
- Defined in src/backends/store/fs.ts:64

exists

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

existsSync

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

`Protected`findInodeSync

findInodeSync(
    tx: Transaction<Store>,
    path: string,
    syscall: string,
    visited?: Set<string>,
): Inode
Finds the Inode of path.
Parameters
- tx: Transaction<Store>
- path: string
  The path to look up.
- syscall: string
- visited: Set<string> = ...
Returns Inode
The Inode of the path p.

Todo
memoize/cache
Inherited from StoreFS.findInodeSync
- Defined in src/backends/store/fs.ts:566

link

link(target: string, link: string): Promise<void>
Parameters
- target: string
- link: string
Returns Promise<void>
Overrides StoreFS.link
- Defined in src/devices.ts:471

linkSync

linkSync(target: string, link: string): void
Parameters
- target: string
- link: string
Returns void
Overrides StoreFS.linkSync
- Defined in src/devices.ts:481

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>
Inherited from StoreFS.loadIndex
- Defined in src/backends/store/fs.ts:75

loadIndexSync

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

metadata

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

Returns FileSystemMetadata
Inherited from StoreFS.metadata
- Defined in src/backends/store/fs.ts:41

mkdir

mkdir(path: string, mode: number, options: CreationOptions): Promise<void>
Parameters
- path: string
- mode: number
- options: CreationOptions
Returns Promise<void>
Overrides StoreFS.mkdir
- Defined in src/devices.ts:437

mkdirSync

mkdirSync(path: string, mode: number, options: CreationOptions): void
Parameters
- path: string
- mode: number
- options: CreationOptions
Returns void
Overrides StoreFS.mkdirSync
- Defined in src/devices.ts:444

openFile

openFile(path: string, flag: string): 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>>
Overrides StoreFS.openFile
- Defined in src/devices.ts:387

openFileSync

openFileSync(path: string, flag: string): 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>
Overrides StoreFS.openFileSync
- Defined in src/devices.ts:394

read

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

readdir

readdir(path: string): Promise<string[]>
Parameters
- path: string
Returns Promise<string[]>
Overrides StoreFS.readdir
- Defined in src/devices.ts:451

readdirSync

readdirSync(path: string): string[]
Parameters
- path: string
Returns string[]
Overrides StoreFS.readdirSync
- Defined in src/devices.ts:461

readSync

readSync(
    path: string,
    buffer: Uint8Array<ArrayBufferLike>,
    offset: number,
    end: number,
): void
Reads into a buffer
Parameters
- path: string
- buffer: Uint8Array<ArrayBufferLike>
  The buffer to read into. You must set the byteOffset and byteLength appropriately!
- offset: number
  The offset into the file to start reading from
- end: number
  The position in the file to stop reading
Returns void
Overrides StoreFS.readSync
- Defined in src/devices.ts:515

ready

ready(): Promise<void>
Returns Promise<void>
Inherited from StoreFS.ready
- Defined in src/backends/store/fs.ts:29

`Protected`remove

remove(path: string, isDir: boolean, syscall: string): 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?
- syscall: string
Returns Promise<void>
Todo
Update mtime.
Inherited from StoreFS.remove
- Defined in src/backends/store/fs.ts:703

`Protected`removeSync

removeSync(path: string, isDir: boolean, syscall: string): 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?
- syscall: string
Returns void
Todo
Update mtime.
Inherited from StoreFS.removeSync
- Defined in src/backends/store/fs.ts:744

rename

rename(oldPath: string, newPath: string): Promise<void>
Parameters
- oldPath: string
- newPath: string
Returns Promise<void>
Todo
Make rename compatible with the cache.
Overrides StoreFS.rename
- Defined in src/devices.ts:351

renameSync

renameSync(oldPath: string, newPath: string): void
Parameters
- oldPath: string
- newPath: string
Returns void
Overrides StoreFS.renameSync
- Defined in src/devices.ts:361

rmdir

rmdir(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
Overrides StoreFS.rmdir
- Defined in src/devices.ts:429

rmdirSync

rmdirSync(path: string): void
Parameters
- path: string
Returns void
Overrides StoreFS.rmdirSync
- Defined in src/devices.ts:433

stat

stat(path: string): Promise<Stats>
Parameters
- path: string
Returns Promise<Stats>
Overrides StoreFS.stat
- Defined in src/devices.ts:371

statSync

statSync(path: string): Stats
Parameters
- path: string
Returns Stats
Overrides StoreFS.statSync
- Defined in src/devices.ts:379

sync

sync(
    path: string,
    data: Uint8Array<ArrayBufferLike>,
    stats: Readonly<Stats>,
): Promise<void>
Updated the inode and data node at path
Parameters
- path: string
- data: Uint8Array<ArrayBufferLike>
- stats: Readonly<Stats>
Returns Promise<void>
Todo
Ensure mtime updates properly, and use that to determine if a data update is required.
Overrides StoreFS.sync
- Defined in src/devices.ts:491

syncSync

syncSync(
    path: string,
    data: Uint8Array<ArrayBufferLike>,
    stats: Readonly<Stats>,
): void
Updated the inode and data node at path
Parameters
- path: string
- data: Uint8Array<ArrayBufferLike>
- stats: Readonly<Stats>
Returns void
Todo
Ensure mtime updates properly, and use that to determine if a data update is required.
Overrides StoreFS.syncSync
- Defined in src/devices.ts:498

unlink

unlink(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
Overrides StoreFS.unlink
- Defined in src/devices.ts:415

unlinkSync

unlinkSync(path: string): void
Parameters
- path: string
Returns void
Overrides StoreFS.unlinkSync
- Defined in src/devices.ts:422

write

write(
    path: string,
    data: Uint8Array<ArrayBufferLike>,
    offset: number,
): Promise<void>
Writes a buffer to a file
Parameters
- path: string
- data: Uint8Array<ArrayBufferLike>
- offset: number
  The offset in the file to start writing
Returns Promise<void>
Overrides StoreFS.write
- Defined in src/devices.ts:525

writeSync

writeSync(path: string, data: Uint8Array<ArrayBufferLike>, offset: number): void
Writes a buffer to a file
Parameters
- path: string
- data: Uint8Array<ArrayBufferLike>
- offset: number
  The offset in the file to start writing
Returns void
Overrides StoreFS.writeSync
- Defined in src/devices.ts:534

Class DeviceFS

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns DeviceFS

Properties

Protected Optional Internal_disableSync

Protected_initialized

Protected Readonlydevices

Protected Readonlystore

Methods

_createDevice

Type Parameters

Parameters

Returns Device<Record<string, never> | TData>

addDefaults

Returns void

ProtectedallocNew

Parameters

Returns Promise<number>

ProtectedallocNewSync

Parameters

Returns number

checkRoot

Returns Promise<void>

checkRootSync

Returns void

ProtectedcommitNew

Parameters

Returns Promise<Inode>

ProtectedcommitNewSync

Parameters

Returns Inode

createDevice

Type Parameters

Parameters

Returns Device<TData | Record<string, never>>

Deprecated

createFile

Parameters

Returns Promise<File<FileSystem>>

createFileSync

Parameters

Returns File<FileSystem>

createIndex

Returns Promise<Index>

createIndexSync

Returns Index

ProtecteddevicesWithDriver

Parameters

Returns Device<any>[]

empty

Returns Promise<void>

Deprecated

emptySync

Returns void

Deprecated

exists

Parameters

Returns Promise<boolean>

existsSync

Parameters

Returns boolean

ProtectedfindInodeSync

Parameters

Returns Inode

Todo

link

Parameters

Returns Promise<void>

linkSync

Parameters

Returns void

loadIndex

Parameters

Returns Promise<void>

`Protected` `Optional` `Internal`_disableSync

`Protected`_initialized

`Protected` `Readonly`devices

`Protected` `Readonly`store

`Protected`allocNew

`Protected`allocNewSync

`Protected`commitNew

`Protected`commitNewSync

`Protected`devicesWithDriver

`Protected`findInodeSync

`Protected`remove

`Protected`removeSync