Skip to content
ZenFSZenFSZenFS

IndexFS

Defined in: src/internal/index_fs.ts:22

Internal

A file system that uses an Index for metadata.

Extends

Section titled “Extends”

Extended by

Section titled “Extended by”

Constructors

Section titled “Constructors”

Constructor

Section titled “Constructor”

new IndexFS(id, name, index?): IndexFS

Defined in: src/internal/index_fs.ts:23

Parameters

Section titled “Parameters”
id
Section titled “id”

number

name
Section titled “name”

string

index?
Section titled “index?”

Index = ...

Returns

Section titled “Returns”

IndexFS

Overrides

Section titled “Overrides”

FileSystem.constructor

Properties

Section titled “Properties”

_mountPoint?

Section titled “_mountPoint?”

protected optional _mountPoint?: string

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

Internal

The last place this file system was mounted

Inherited from

Section titled “Inherited from”

FileSystem._mountPoint

_uuid

Section titled “_uuid”

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

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

Internal

The UUID of the file system.

Inherited from

Section titled “Inherited from”

FileSystem._uuid

attributes

Section titled “attributes”

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

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

See

Section titled “See”

FileSystemAttributes

Inherited from

Section titled “Inherited from”

FileSystem.attributes

index

Section titled “index”

readonly index: Index

Defined in: src/internal/index_fs.ts:26

label?

Section titled “label?”

optional label?: string

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

Inherited from

Section titled “Inherited from”

FileSystem.label

name

Section titled “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

Section titled “Inherited from”

FileSystem.name

type

Section titled “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

Section titled “Inherited from”

FileSystem.type

Accessors

Section titled “Accessors”

uuid

Section titled “uuid”

Get Signature

Section titled “Get Signature”

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

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

Returns
Section titled “Returns”

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

Inherited from

Section titled “Inherited from”

FileSystem.uuid

Methods

Section titled “Methods”

_mkdir()?

Section titled “_mkdir()?”

protected optional _mkdir(path, options): Promise<void>

Defined in: src/internal/index_fs.ts:184

Parameters

Section titled “Parameters”
path
Section titled “path”

string

options
Section titled “options”

CreationOptions

Returns

Section titled “Returns”

Promise<void>

_mkdirSync()?

Section titled “_mkdirSync()?”

protected optional _mkdirSync(path, options): void

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

Parameters

Section titled “Parameters”
path
Section titled “path”

string

options
Section titled “options”

CreationOptions

Returns

Section titled “Returns”

void

_remove()

Section titled “_remove()”

protected _remove(path, isUnlink): void

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

Parameters

Section titled “Parameters”
path
Section titled “path”

string

Section titled “isUnlink”

boolean

Returns

Section titled “Returns”

void

create()

Section titled “create()”

protected create(path, options): Inode

Defined in: src/internal/index_fs.ts:154

Parameters

Section titled “Parameters”
path
Section titled “path”

string

options
Section titled “options”

CreationOptions

Returns

Section titled “Returns”

Inode

createFile()

Section titled “createFile()”

createFile(path, options): Promise<Inode>

Defined in: src/internal/index_fs.ts:176

Create the file at path with the given options.

Parameters

Section titled “Parameters”
path
Section titled “path”

string

options
Section titled “options”

CreationOptions

Returns

Section titled “Returns”

Promise<Inode>

Overrides

Section titled “Overrides”

FileSystem.createFile

createFileSync()

Section titled “createFileSync()”

createFileSync(path, options): Inode

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

Create the file at path with the given options.

Parameters

Section titled “Parameters”
path
Section titled “path”

string

options
Section titled “options”

CreationOptions

Returns

Section titled “Returns”

Inode

Overrides

Section titled “Overrides”

FileSystem.createFileSync

exists()

Section titled “exists()”

exists(path): Promise<boolean>

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

Test whether or not path exists.

Parameters

Section titled “Parameters”
path
Section titled “path”

string

Returns

Section titled “Returns”

Promise<boolean>

Inherited from

Section titled “Inherited from”

FileSystem.exists

existsSync()

Section titled “existsSync()”

existsSync(path): boolean

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

Test whether or not path exists.

Parameters

Section titled “Parameters”
path
Section titled “path”

string

Returns

Section titled “Returns”

boolean

Inherited from

Section titled “Inherited from”

FileSystem.existsSync

ioctl()

Section titled “ioctl()”

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

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

Internal

Parameters

Section titled “Parameters”
context
Section titled “context”

IoctlContext

command
Section titled “command”

number

args
Section titled “args”

…any[]

Returns

Section titled “Returns”

Promise<any>

Inherited from

Section titled “Inherited from”

FileSystem.ioctl

ioctlSync()

Section titled “ioctlSync()”

ioctlSync(context, command, …args): any

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

Internal

Parameters

Section titled “Parameters”
context
Section titled “context”

IoctlContext

command
Section titled “command”

number

args
Section titled “args”

…any[]

Returns

Section titled “Returns”

any

Inherited from

Section titled “Inherited from”

FileSystem.ioctlSync

Section titled “link()”

link(target, link): Promise<void>

Defined in: src/internal/index_fs.ts:201

Parameters

Section titled “Parameters”
target
Section titled “target”

string

Section titled “link”

string

Returns

Section titled “Returns”

Promise<void>

Overrides

Section titled “Overrides”

FileSystem.link

linkSync()

Section titled “linkSync()”

linkSync(target, link): void

Defined in: src/internal/index_fs.ts:205

Parameters

Section titled “Parameters”
target
Section titled “target”

string

Section titled “link”

string

Returns

Section titled “Returns”

void

Overrides

Section titled “Overrides”

FileSystem.linkSync

mkdir()

Section titled “mkdir()”

mkdir(path, options): Promise<Inode>

Defined in: src/internal/index_fs.ts:187

Parameters

Section titled “Parameters”
path
Section titled “path”

string

options
Section titled “options”

CreationOptions

Returns

Section titled “Returns”

Promise<Inode>

Overrides

Section titled “Overrides”

FileSystem.mkdir

mkdirSync()

Section titled “mkdirSync()”

mkdirSync(path, options): Inode

Defined in: src/internal/index_fs.ts:194

Parameters

Section titled “Parameters”
path
Section titled “path”

string

options
Section titled “options”

CreationOptions

Returns

Section titled “Returns”

Inode

Overrides

Section titled “Overrides”

FileSystem.mkdirSync

read()

Section titled “read()”

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

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

Reads into a buffer

Parameters

Section titled “Parameters”
path
Section titled “path”

string

buffer
Section titled “buffer”

Uint8Array

The buffer to read into. You must set the byteOffset and byteLength appropriately!

start
Section titled “start”

number

The offset into the file to start reading from

end
Section titled “end”

number

The position in the file to stop reading

Returns

Section titled “Returns”

Promise<void>

Inherited from

Section titled “Inherited from”

FileSystem.read

readdir()

Section titled “readdir()”

readdir(path): Promise<string[]>

Defined in: src/internal/index_fs.ts:209

Parameters

Section titled “Parameters”
path
Section titled “path”

string

Returns

Section titled “Returns”

Promise<string[]>

Overrides

Section titled “Overrides”

FileSystem.readdir

readdirSync()

Section titled “readdirSync()”

readdirSync(path): string[]

Defined in: src/internal/index_fs.ts:213

Parameters

Section titled “Parameters”
path
Section titled “path”

string

Returns

Section titled “Returns”

string[]

Overrides

Section titled “Overrides”

FileSystem.readdirSync

readSync()

Section titled “readSync()”

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

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

Reads into a buffer

Parameters

Section titled “Parameters”
path
Section titled “path”

string

buffer
Section titled “buffer”

Uint8Array

The buffer to read into. You must set the byteOffset and byteLength appropriately!

start
Section titled “start”

number

The offset into the file to start reading from

end
Section titled “end”

number

The position in the file to stop reading

Returns

Section titled “Returns”

void

Inherited from

Section titled “Inherited from”

FileSystem.readSync

ready()

Section titled “ready()”

ready(): Promise<void>

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

Returns

Section titled “Returns”

Promise<void>

Inherited from

Section titled “Inherited from”

FileSystem.ready

readySync()

Section titled “readySync()”

readySync(): void

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

Returns

Section titled “Returns”

void

Inherited from

Section titled “Inherited from”

FileSystem.readySync

remove()

Section titled “remove()”

abstract protected remove(path): Promise<void>

Defined in: src/internal/index_fs.ts:126

Parameters

Section titled “Parameters”
path
Section titled “path”

string

Returns

Section titled “Returns”

Promise<void>

removeSync()

Section titled “removeSync()”

abstract protected removeSync(path): void

Defined in: src/internal/index_fs.ts:127

Parameters

Section titled “Parameters”
path
Section titled “path”

string

Returns

Section titled “Returns”

void

rename()

Section titled “rename()”

rename(oldPath, newPath): Promise<void>

Defined in: src/internal/index_fs.ts:53

Parameters

Section titled “Parameters”
oldPath
Section titled “oldPath”

string

newPath
Section titled “newPath”

string

Returns

Section titled “Returns”

Promise<void>

Overrides

Section titled “Overrides”

FileSystem.rename

renameSync()

Section titled “renameSync()”

renameSync(oldPath, newPath): void

Defined in: src/internal/index_fs.ts:74

Parameters

Section titled “Parameters”
oldPath
Section titled “oldPath”

string

newPath
Section titled “newPath”

string

Returns

Section titled “Returns”

void

Overrides

Section titled “Overrides”

FileSystem.renameSync

rmdir()

Section titled “rmdir()”

rmdir(path): Promise<void>

Defined in: src/internal/index_fs.ts:139

Parameters

Section titled “Parameters”
path
Section titled “path”

string

Returns

Section titled “Returns”

Promise<void>

Overrides

Section titled “Overrides”

FileSystem.rmdir

rmdirSync()

Section titled “rmdirSync()”

rmdirSync(path): void

Defined in: src/internal/index_fs.ts:147

Parameters

Section titled “Parameters”
path
Section titled “path”

string

Returns

Section titled “Returns”

void

Overrides

Section titled “Overrides”

FileSystem.rmdirSync

stat()

Section titled “stat()”

stat(path): Promise<Inode>

Defined in: src/internal/index_fs.ts:95

Parameters

Section titled “Parameters”
path
Section titled “path”

string

Returns

Section titled “Returns”

Promise<Inode>

Overrides

Section titled “Overrides”

FileSystem.stat

statSync()

Section titled “statSync()”

statSync(path): Inode

Defined in: src/internal/index_fs.ts:101

Parameters

Section titled “Parameters”
path
Section titled “path”

string

Returns

Section titled “Returns”

Inode

Overrides

Section titled “Overrides”

FileSystem.statSync

streamRead()

Section titled “streamRead()”

streamRead(path, options): ReadableStream

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

Read a file using a stream.

Parameters

Section titled “Parameters”
path
Section titled “path”

string

options
Section titled “options”

StreamOptions

Returns

Section titled “Returns”

ReadableStream

Inherited from

Section titled “Inherited from”

FileSystem.streamRead

streamWrite()

Section titled “streamWrite()”

streamWrite(path, options): WritableStream

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

Write a file using stream.

Parameters

Section titled “Parameters”
path
Section titled “path”

string

options
Section titled “options”

StreamOptions

Returns

Section titled “Returns”

WritableStream

Inherited from

Section titled “Inherited from”

FileSystem.streamWrite

sync()

Section titled “sync()”

sync(): Promise<void>

Defined in: src/internal/index_fs.ts:217

Returns

Section titled “Returns”

Promise<void>

Overrides

Section titled “Overrides”

FileSystem.sync

syncSync()

Section titled “syncSync()”

syncSync(): void

Defined in: src/internal/index_fs.ts:219

Returns

Section titled “Returns”

void

Overrides

Section titled “Overrides”

FileSystem.syncSync

toString()

Section titled “toString()”

toString(): string

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

Returns

Section titled “Returns”

string

Inherited from

Section titled “Inherited from”

FileSystem.toString

touch()

Section titled “touch()”

touch(path, metadata): Promise<void>

Defined in: src/internal/index_fs.ts:107

Modify metadata.

Parameters

Section titled “Parameters”
path
Section titled “path”

string

metadata
Section titled “metadata”

InodeLike

Returns

Section titled “Returns”

Promise<void>

Overrides

Section titled “Overrides”

FileSystem.touch

touchSync()

Section titled “touchSync()”

touchSync(path, metadata): void

Defined in: src/internal/index_fs.ts:112

Modify metadata.

Parameters

Section titled “Parameters”
path
Section titled “path”

string

metadata
Section titled “metadata”

InodeLike

Returns

Section titled “Returns”

void

Overrides

Section titled “Overrides”

FileSystem.touchSync

Section titled “unlink()”

unlink(path): Promise<void>

Defined in: src/internal/index_fs.ts:129

Parameters

Section titled “Parameters”
path
Section titled “path”

string

Returns

Section titled “Returns”

Promise<void>

Overrides

Section titled “Overrides”

FileSystem.unlink

unlinkSync()

Section titled “unlinkSync()”

unlinkSync(path): void

Defined in: src/internal/index_fs.ts:134

Parameters

Section titled “Parameters”
path
Section titled “path”

string

Returns

Section titled “Returns”

void

Overrides

Section titled “Overrides”

FileSystem.unlinkSync

usage()

Section titled “usage()”

usage(): UsageInfo

Defined in: src/internal/index_fs.ts:31

Default implementation.

Returns

Section titled “Returns”

UsageInfo

Todo

Section titled “Todo”

Implement

Overrides

Section titled “Overrides”

FileSystem.usage

write()

Section titled “write()”

abstract write(path, buffer, offset): Promise<void>

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

Writes a buffer to a file

Parameters

Section titled “Parameters”
path
Section titled “path”

string

buffer
Section titled “buffer”

Uint8Array

The buffer to write. You must set the byteOffset and byteLength appropriately!

offset
Section titled “offset”

number

The offset in the file to start writing

Returns

Section titled “Returns”

Promise<void>

Inherited from

Section titled “Inherited from”

FileSystem.write

writeSync()

Section titled “writeSync()”

abstract writeSync(path, buffer, offset): void

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

Writes a buffer to a file

Parameters

Section titled “Parameters”
path
Section titled “path”

string

buffer
Section titled “buffer”

Uint8Array

The buffer to write. You must set the byteOffset and byteLength appropriately!

offset
Section titled “offset”

number

The offset in the file to start writing

Returns

Section titled “Returns”

void

Inherited from

Section titled “Inherited from”

FileSystem.writeSync

ContributeSponsor