DevTmpFS

Defined in: src/fs/devtmpfs.ts:57

A temporary file system that manages and interfaces with devices

Extends

• StoreFS<InMemoryStore>

Constructors

Constructor

new DevTmpFS(): DevTmpFS

Defined in: src/fs/devtmpfs.ts:58

Returns

DevTmpFS

Overrides

StoreFS<InMemoryStore>.constructor

Properties

_initialized

protected _initialized: boolean

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:41

Inherited from

StoreFS._initialized

---

_mountPoint?

protected optional _mountPoint?: string

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:144

Internal

The last place this file system was mounted

Inherited from

StoreFS._mountPoint

---

_uuid

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

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:150

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: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:155

See

FileSystemAttributes

Inherited from

StoreFS.attributes

---

label?

optional label?: string

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:139

Inherited from

StoreFS.label

---

name

readonly name: string

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:138

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: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:14

Inherited from

StoreFS.store

---

type

readonly type: number

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:133

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: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:151

Returns

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

Inherited from

StoreFS.uuid

Methods

_add()

_add(ino, path): void

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:32

Add a inode/path pair

Parameters

ino

number

path

string

Returns

void

Inherited from

StoreFS._add

---

_create_path()

protected _create_path(path): void

Defined in: src/fs/devtmpfs.ts:93

mkdir -p for the parents of a node in a subdirectory

Parameters

path

string

Returns

void

---

_delete_path()

protected _delete_path(path): void

Defined in: src/fs/devtmpfs.ts:103

Remove the directories a node was in, as long as they are empty

Parameters

path

string

Returns

void

---

_device()

protected _device(path, inode?): DeviceFile & object | undefined

Defined in: src/fs/devtmpfs.ts:153

The driver handling the node at path, if it is a device node.

Parameters

path

string

inode?

InodeLike = ...

The node’s inode, for callers that already have an authoritative one

Returns

DeviceFile & object | undefined

Throws

ENXIO when nothing has claimed the node’s device number

---

_mount()

protected _mount(): void

Defined in: src/fs/devtmpfs.ts:77

Take over as the devtmpfs and create nodes for devices registered before we existed

Returns

void

---

_move()

_move(from, to): void

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:40

Move paths in the tables

Parameters

from

string

to

string

Returns

void

Inherited from

StoreFS._move

---

_path()

_path(id): string | undefined

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:28

Gets the first path associated with an inode

Parameters

id

number

Returns

string | undefined

Inherited from

StoreFS._path

---

_remove()

_remove(ino): void

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:36

Remove a inode/path pair

Parameters

ino

number

Returns

void

Inherited from

StoreFS._remove

---

allocNew()

protected allocNew(path): number

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:135

Allocates a new ID and adds the ID/path

Parameters

path

string

Returns

number

Inherited from

StoreFS.allocNew

---

checkRoot()

checkRoot(): Promise<void>

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:102

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

Returns

Promise<void>

Inherited from

StoreFS.checkRoot

---

checkRootSync()

checkRootSync(): void

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:106

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: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:143

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: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:152

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

---

create_node()

create_node(device): void

Defined in: src/fs/devtmpfs.ts:113

Internal

Parameters

device

Device

Returns

void

---

createFile()

createFile(path, options): Promise<Inode>

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:70

Create the file at path with the given options.

Parameters

path

string

options

CreationOptions

Returns

Promise<Inode>

Inherited from

StoreFS.createFile

---

createFileSync()

createFileSync(path, options): Inode

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:71

Create the file at path with the given options.

Parameters

path

string

options

CreationOptions

Returns

Inode

Inherited from

StoreFS.createFileSync

---

createIndex()

createIndex(): Promise<Index>

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:59

Returns

Promise<Index>

Inherited from

StoreFS.createIndex

---

createIndexSync()

createIndexSync(): Index

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:60

Returns

Index

Inherited from

StoreFS.createIndexSync

---

delete_node()

delete_node(device): void

Defined in: src/fs/devtmpfs.ts:128

Internal

Only remove a node if it is one we created and it still refers to this device, so a node someone replaced is left alone. This is Linux’s dev_mynode.

Parameters

device

Device

Returns

void

---

exists()

exists(path): Promise<boolean>

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:203

Test whether or not path exists.

Parameters

path

string

Returns

Promise<boolean>

Inherited from

StoreFS.exists

---

existsSync()

existsSync(path): boolean

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:207

Test whether or not path exists.

Parameters

path

string

Returns

boolean

Inherited from

StoreFS.existsSync

---

findInode()

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

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:125

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: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:132

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<unknown>

Defined in: src/fs/devtmpfs.ts:202

Internal

Parameters

context

IoctlContext

command

number

args

…unknown[]

Returns

Promise<unknown>

Overrides

StoreFS.ioctl

---

ioctlSync()

ioctlSync(context, command, …args): unknown

Defined in: src/fs/devtmpfs.ts:196

Internal

Parameters

context

IoctlContext

command

number

args

…unknown[]

Returns

unknown

Overrides

StoreFS.ioctlSync

---

link()

link(target, link): Promise<void>

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:88

Parameters

target

string

link

string

Returns

Promise<void>

Inherited from

StoreFS.link

---

linkSync()

linkSync(target, link): void

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:89

Parameters

target

string

link

string

Returns

void

Inherited from

StoreFS.linkSync

---

loadIndex()

loadIndex(index): Promise<void>

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:53

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: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:58

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: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:76

Parameters

path

string

options

CreationOptions

Returns

Promise<Inode>

Inherited from

StoreFS.mkdir

---

mkdirSync()

mkdirSync(path, options): Inode

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:77

Parameters

path

string

options

CreationOptions

Returns

Inode

Inherited from

StoreFS.mkdirSync

---

mknodSync()

mknodSync(path, mode, rdev): InodeLike

Defined in: src/fs/devtmpfs.ts:87

Create a device node, like mknod.

Parameters

path

string

mode

number

rdev

number

The device number

Returns

InodeLike

---

read()

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

Defined in: src/fs/devtmpfs.ts:172

Parameters

path

string

buffer

Uint8Array

start

number

end

number

Returns

Promise<void>

Overrides

StoreFS.read

---

readdir()

readdir(path): Promise<string[]>

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:78

Parameters

path

string

Returns

Promise<string[]>

Inherited from

StoreFS.readdir

---

readdirSync()

readdirSync(path): string[]

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:79

Parameters

path

string

Returns

string[]

Inherited from

StoreFS.readdirSync

---

readSync()

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

Defined in: src/fs/devtmpfs.ts:164

Parameters

path

string

buffer

Uint8Array

start

number

end

number

Returns

void

Overrides

StoreFS.readSync

---

ready()

ready(): Promise<void>

Defined in: src/fs/devtmpfs.ts:66

Returns

Promise<void>

Overrides

StoreFS.ready

---

readySync()

readySync(): void

Defined in: src/fs/devtmpfs.ts:71

Returns

void

Overrides

StoreFS.readySync

---

remove()

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

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:158

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: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:164

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: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:64

Parameters

oldPath

string

newPath

string

Returns

Promise<void>

Todo

Make rename compatible with the cache.

Inherited from

StoreFS.rename

---

renameSync()

renameSync(oldPath, newPath): void

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:65

Parameters

oldPath

string

newPath

string

Returns

void

Inherited from

StoreFS.renameSync

---

rmdir()

rmdir(path): Promise<void>

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:74

Parameters

path

string

Returns

Promise<void>

Inherited from

StoreFS.rmdir

---

rmdirSync()

rmdirSync(path): void

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:75

Parameters

path

string

Returns

void

Inherited from

StoreFS.rmdirSync

---

stat()

stat(path): Promise<Inode>

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:66

Parameters

path

string

Returns

Promise<Inode>

Inherited from

StoreFS.stat

---

statSync()

statSync(path): Inode

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:67

Parameters

path

string

Returns

Inode

Inherited from

StoreFS.statSync

---

streamRead()

streamRead(path, options): ReadableStream

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:242

Read a file using a stream.

Parameters

path

string

options

StreamOptions

Returns

ReadableStream

Inherited from

StoreFS.streamRead

---

streamWrite()

streamWrite(path, options): WritableStream

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:247

Write a file using stream.

Parameters

path

string

options

StreamOptions

Returns

WritableStream

Inherited from

StoreFS.streamWrite

---

sync()

sync(): Promise<void>

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:83

Updated the inode and data node at path

Returns

Promise<void>

Inherited from

StoreFS.sync

---

syncSync()

syncSync(): void

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:87

Updated the inode and data node at path

Returns

void

Inherited from

StoreFS.syncSync

---

toString()

toString(): string

Defined in: node_modules/@zenfs/core/dist/internal/filesystem.d.ts:167

Returns

string

Inherited from

StoreFS.toString

---

touch()

touch(path, metadata): Promise<void>

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:68

Modify metadata.

Parameters

path

string

metadata

Partial<InodeLike>

Returns

Promise<void>

Inherited from

StoreFS.touch

---

touchSync()

touchSync(path, metadata): void

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:69

Modify metadata.

Parameters

path

string

metadata

Partial<InodeLike>

Returns

void

Inherited from

StoreFS.touchSync

---

unlink()

unlink(path): Promise<void>

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:72

Parameters

path

string

Returns

Promise<void>

Inherited from

StoreFS.unlink

---

unlinkSync()

unlinkSync(path): void

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:73

Parameters

path

string

Returns

void

Inherited from

StoreFS.unlinkSync

---

usage()

usage(): UsageInfo

Defined in: node_modules/@zenfs/core/dist/backends/store/fs.d.ts:48

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, buffer, offset): Promise<void>

Defined in: src/fs/devtmpfs.ts:188

Parameters

path

string

buffer

Uint8Array

offset

number

Returns

Promise<void>

Overrides

StoreFS.write

---

writeSync()

writeSync(path, buffer, offset): void

Defined in: src/fs/devtmpfs.ts:180

Parameters

path

string

buffer

Uint8Array

offset

number

Returns

void

Overrides

StoreFS.writeSync