DeviceFS

Defined in: src/internal/devices.ts:116

A temporary file system that manages and interfaces with devices

Extends

• StoreFS<InMemoryStore>

Constructors

Constructor

new DeviceFS(): DeviceFS

Defined in: src/internal/devices.ts:180

Returns

DeviceFS

Overrides

StoreFS.constructor

Properties

_initialized

protected _initialized: boolean = false

Defined in: src/backends/store/fs.ts:89

Inherited from

StoreFS._initialized

---

_mountPoint?

protected optional _mountPoint?: string

Defined in: src/internal/filesystem.ts:162

Internal

The last place this file system was mounted

Inherited from

StoreFS._mountPoint

---

_uuid

protected _uuid: `${string}-${string}-${string}-${string}-${string}`

Defined in: src/internal/filesystem.ts:169

Internal

The UUID of the file system.

Inherited from

StoreFS._uuid

---

attributes

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

Defined in: src/internal/filesystem.ts:178

See

FileSystemAttributes

Inherited from

StoreFS.attributes

---

devices

protected readonly devices: Map<string, Device<any>>

Defined in: src/internal/devices.ts:117

---

label?

optional label?: string

Defined in: src/internal/filesystem.ts:156

Inherited from

StoreFS.label

---

name

readonly name: string

Defined in: src/internal/filesystem.ts:191

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

Inherited from

StoreFS.name

---

store

protected readonly store: InMemoryStore

Defined in: src/backends/store/fs.ts:115

Inherited from

StoreFS.store

---

type

readonly type: number

Defined in: src/internal/filesystem.ts:185

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

Inherited from

StoreFS.type

Accessors

uuid

Get Signature

get uuid(): `${string}-${string}-${string}-${string}-${string}`

Defined in: src/internal/filesystem.ts:171

Returns

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

Inherited from

StoreFS.uuid

Methods

_add()

_add(ino, path): void

Defined in: src/backends/store/fs.ts:47

Add a inode/path pair

Parameters

ino

number

path

string

Returns

void

Inherited from

StoreFS._add

---

_createDevice()

_createDevice<TData>(driver, options?): Device<TData | Record<string, never>>

Defined in: src/internal/devices.ts:138

Internal

Type Parameters

TData

TData = any

Parameters

driver

DeviceDriver<TData>

options?

object = {}

Returns

Device<TData | Record<string, never>>

---

_move()

_move(from, to): void

Defined in: src/backends/store/fs.ts:66

Move paths in the tables

Parameters

from

string

to

string

Returns

void

Inherited from

StoreFS._move

---

_path()

_path(id): string | undefined

Defined in: src/backends/store/fs.ts:39

Gets the first path associated with an inode

Parameters

id

number

Returns

string | undefined

Inherited from

StoreFS._path

---

_remove()

_remove(ino): void

Defined in: src/backends/store/fs.ts:56

Remove a inode/path pair

Parameters

ino

number

Returns

void

Inherited from

StoreFS._remove

---

addDefaults()

addDefaults(): void

Defined in: src/internal/devices.ts:171

Adds default devices

Returns

void

---

allocNew()

protected allocNew(path): number

Defined in: src/backends/store/fs.ts:784

Allocates a new ID and adds the ID/path

Parameters

path

string

Returns

number

Inherited from

StoreFS.allocNew

---

checkRoot()

checkRoot(): Promise<void>

Defined in: src/backends/store/fs.ts:544

Checks if the root directory exists. Creates it if it doesn’t.

Returns

Promise<void>

Inherited from

StoreFS.checkRoot

---

checkRootSync()

checkRootSync(): void

Defined in: src/backends/store/fs.ts:559

Checks if the root directory exists. Creates it if it doesn’t.

Returns

void

Inherited from

StoreFS.checkRootSync

---

commitNew()

protected commitNew(path, options, data): Promise<Inode>

Defined in: src/backends/store/fs.ts:801

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>

Inherited from

StoreFS.commitNew

---

commitNewSync()

protected commitNewSync(path, options, data): Inode

Defined in: src/backends/store/fs.ts:847

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.

Inherited from

StoreFS.commitNewSync

---

createFile()

createFile(path, options): Promise<Inode>

Defined in: src/internal/devices.ts:222

Create the file at path with the given options.

Parameters

path

string

options

CreationOptions

Returns

Promise<Inode>

Overrides

StoreFS.createFile

---

createFileSync()

createFileSync(path, options): Inode

Defined in: src/internal/devices.ts:227

Create the file at path with the given options.

Parameters

path

string

options

CreationOptions

Returns

Inode

Overrides

StoreFS.createFileSync

---

createIndex()

createIndex(): Promise<Index>

Defined in: src/backends/store/fs.ts:171

Returns

Promise<Index>

Inherited from

StoreFS.createIndex

---

createIndexSync()

createIndexSync(): Index

Defined in: src/backends/store/fs.ts:199

Returns

Index

Inherited from

StoreFS.createIndexSync

---

devicesWithDriver()

protected devicesWithDriver(driver, forceIdentity?): Device<any>[]

Defined in: src/internal/devices.ts:119

Parameters

driver

string | DeviceDriver<unknown>

forceIdentity?

boolean

Returns

Device<any>[]

---

exists()

exists(path): Promise<boolean>

Defined in: src/internal/filesystem.ts:257

Test whether or not path exists.

Parameters

path

string

Returns

Promise<boolean>

Inherited from

StoreFS.exists

---

existsSync()

existsSync(path): boolean

Defined in: src/internal/filesystem.ts:269

Test whether or not path exists.

Parameters

path

string

Returns

boolean

Inherited from

StoreFS.existsSync

---

findInode()

protected findInode(tx, path): Promise<Inode>

Defined in: src/backends/store/fs.ts:761

Finds the Inode of path.

Parameters

tx

WrappedTransaction

path

string

The path to look up.

Returns

Promise<Inode>

Todo

memoize/cache

Inherited from

StoreFS.findInode

---

findInodeSync()

protected findInodeSync(tx, path): Inode

Defined in: src/backends/store/fs.ts:774

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

Inherited from

StoreFS.findInodeSync

---

ioctl()

ioctl(context, command, …args): Promise<any>

Defined in: src/internal/filesystem.ts:359

Internal

Parameters

context

IoctlContext

command

number

args

…any[]

Returns

Promise<any>

Inherited from

StoreFS.ioctl

---

ioctlSync()

ioctlSync(context, command, …args): any

Defined in: src/internal/filesystem.ts:367

Internal

Parameters

context

IoctlContext

command

number

args

…any[]

Returns

any

Inherited from

StoreFS.ioctlSync

---

link()

link(target, link): Promise<void>

Defined in: src/internal/devices.ts:280

Parameters

target

string

link

string

Returns

Promise<void>

Overrides

StoreFS.link

---

linkSync()

linkSync(target, link): void

Defined in: src/internal/devices.ts:286

Parameters

target

string

link

string

Returns

void

Overrides

StoreFS.linkSync

---

loadIndex()

loadIndex(index): Promise<void>

Defined in: src/backends/store/fs.ts:139

Load an index into the StoreFS. You must manually add non-directory files

Parameters

index

Index

Returns

Promise<void>

Inherited from

StoreFS.loadIndex

---

loadIndexSync()

loadIndexSync(index): void

Defined in: src/backends/store/fs.ts:157

Load an index into the StoreFS. You must manually add non-directory files

Parameters

index

Index

Returns

void

Inherited from

StoreFS.loadIndexSync

---

mkdir()

mkdir(path, options): Promise<Inode>

Defined in: src/internal/devices.ts:250

Parameters

path

string

options

CreationOptions

Returns

Promise<Inode>

Overrides

StoreFS.mkdir

---

mkdirSync()

mkdirSync(path, options): Inode

Defined in: src/internal/devices.ts:255

Parameters

path

string

options

CreationOptions

Returns

Inode

Overrides

StoreFS.mkdirSync

---

read()

read(path, buffer, offset, end): Promise<void>

Defined in: src/internal/devices.ts:306

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

StoreFS.read

---

readdir()

readdir(path): Promise<string[]>

Defined in: src/internal/devices.ts:260

Parameters

path

string

Returns

Promise<string[]>

Overrides

StoreFS.readdir

---

readdirSync()

readdirSync(path): string[]

Defined in: src/internal/devices.ts:270

Parameters

path

string

Returns

string[]

Overrides

StoreFS.readdirSync

---

readSync()

readSync(path, buffer, offset, end): void

Defined in: src/internal/devices.ts:316

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

StoreFS.readSync

---

ready()

ready(): Promise<void>

Defined in: src/backends/store/fs.ts:91

Returns

Promise<void>

Inherited from

StoreFS.ready

---

readySync()

readySync(): void

Defined in: src/backends/store/fs.ts:103

Returns

void

Inherited from

StoreFS.readySync

---

remove()

protected remove(path, isDir): Promise<void>

Defined in: src/backends/store/fs.ts:888

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>

Inherited from

StoreFS.remove

---

removeSync()

protected removeSync(path, isDir): void

Defined in: src/backends/store/fs.ts:924

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

Inherited from

StoreFS.removeSync

---

rename()

rename(oldPath, newPath): Promise<void>

Defined in: src/internal/devices.ts:186

Parameters

oldPath

string

newPath

string

Returns

Promise<void>

Todo

Make rename compatible with the cache.

Overrides

StoreFS.rename

---

renameSync()

renameSync(oldPath, newPath): void

Defined in: src/internal/devices.ts:192

Parameters

oldPath

string

newPath

string

Returns

void

Overrides

StoreFS.renameSync

---

rmdir()

rmdir(path): Promise<void>

Defined in: src/internal/devices.ts:242

Parameters

path

string

Returns

Promise<void>

Overrides

StoreFS.rmdir

---

rmdirSync()

rmdirSync(path): void

Defined in: src/internal/devices.ts:246

Parameters

path

string

Returns

void

Overrides

StoreFS.rmdirSync

---

stat()

stat(path): Promise<Inode>

Defined in: src/internal/devices.ts:198

Parameters

path

string

Returns

Promise<Inode>

Overrides

StoreFS.stat

---

statSync()

statSync(path): Inode

Defined in: src/internal/devices.ts:204

Parameters

path

string

Returns

Inode

Overrides

StoreFS.statSync

---

streamRead()

streamRead(path, options): ReadableStream

Defined in: src/internal/filesystem.ts:317

Read a file using a stream.

Parameters

path

string

options

StreamOptions

Returns

ReadableStream

Inherited from

StoreFS.streamRead

---

streamWrite()

streamWrite(path, options): WritableStream

Defined in: src/internal/filesystem.ts:340

Write a file using stream.

Parameters

path

string

options

StreamOptions

Returns

WritableStream

Inherited from

StoreFS.streamWrite

---

sync()

sync(): Promise<void>

Defined in: src/internal/devices.ts:292

Updated the inode and data node at path

Returns

Promise<void>

Overrides

StoreFS.sync

---

syncSync()

syncSync(): void

Defined in: src/internal/devices.ts:299

Updated the inode and data node at path

Returns

void

Overrides

StoreFS.syncSync

---

toString()

toString(): string

Defined in: src/internal/filesystem.ts:197

Returns

string

Inherited from

StoreFS.toString

---

touch()

touch(path, metadata): Promise<void>

Defined in: src/internal/devices.ts:210

Modify metadata.

Parameters

path

string

metadata

InodeLike

Returns

Promise<void>

Overrides

StoreFS.touch

---

touchSync()

touchSync(path, metadata): void

Defined in: src/internal/devices.ts:216

Modify metadata.

Parameters

path

string

metadata

InodeLike

Returns

void

Overrides

StoreFS.touchSync

---

unlink()

unlink(path): Promise<void>

Defined in: src/internal/devices.ts:232

Parameters

path

string

Returns

Promise<void>

Overrides

StoreFS.unlink

---

unlinkSync()

unlinkSync(path): void

Defined in: src/internal/devices.ts:237

Parameters

path

string

Returns

void

Overrides

StoreFS.unlinkSync

---

usage()

usage(): UsageInfo

Defined in: src/backends/store/fs.ts:126

Experimental

This API should not be used in production and may be trimmed from a public release.

Returns

UsageInfo

Inherited from

StoreFS.usage

---

write()

write(path, data, offset): Promise<void>

Defined in: src/internal/devices.ts:326

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

StoreFS.write

---

writeSync()

writeSync(path, data, offset): void

Defined in: src/internal/devices.ts:335

Writes a buffer to a file

Parameters

path

string

data

Uint8Array

offset

number

The offset in the file to start writing

Returns

void

Overrides

StoreFS.writeSync