Skip to content
ZenFSZenFSZenFS

FileSystem

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

Internal

Provides a consistent and easy to use internal API. Default implementations for exists and existsSync are included. If you are extending this class, note that every path is an absolute path and all arguments are present.

Extended by

Section titled “Extended by”

Constructors

Section titled “Constructors”

Constructor

Section titled “Constructor”

new FileSystem(type, name): FileSystem

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

Parameters

Section titled “Parameters”
type
Section titled “type”

number

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

name
Section titled “name”

string

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

Returns

Section titled “Returns”

FileSystem

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

_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.

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

label?

Section titled “label?”

optional label?: string

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

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

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

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}`

Methods

Section titled “Methods”

createFile()

Section titled “createFile()”

abstract createFile(path, options): Promise<InodeLike<number>>

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

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<InodeLike<number>>

createFileSync()

Section titled “createFileSync()”

abstract createFileSync(path, options): InodeLike

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

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”

InodeLike

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>

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

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>

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

Section titled “link()”

abstract link(target, link): Promise<void>

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

Parameters

Section titled “Parameters”
target
Section titled “target”

string

Section titled “link”

string

Returns

Section titled “Returns”

Promise<void>

linkSync()

Section titled “linkSync()”

abstract linkSync(target, link): void

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

Parameters

Section titled “Parameters”
target
Section titled “target”

string

Section titled “link”

string

Returns

Section titled “Returns”

void

mkdir()

Section titled “mkdir()”

abstract mkdir(path, options): Promise<InodeLike<number>>

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

Parameters

Section titled “Parameters”
path
Section titled “path”

string

options
Section titled “options”

CreationOptions

Returns

Section titled “Returns”

Promise<InodeLike<number>>

mkdirSync()

Section titled “mkdirSync()”

abstract mkdirSync(path, options): InodeLike

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

Parameters

Section titled “Parameters”
path
Section titled “path”

string

options
Section titled “options”

CreationOptions

Returns

Section titled “Returns”

InodeLike

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>

readdir()

Section titled “readdir()”

abstract readdir(path): Promise<string[]>

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

Parameters

Section titled “Parameters”
path
Section titled “path”

string

Returns

Section titled “Returns”

Promise<string[]>

readdirSync()

Section titled “readdirSync()”

abstract readdirSync(path): string[]

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

Parameters

Section titled “Parameters”
path
Section titled “path”

string

Returns

Section titled “Returns”

string[]

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

ready()

Section titled “ready()”

ready(): Promise<void>

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

Returns

Section titled “Returns”

Promise<void>

readySync()

Section titled “readySync()”

readySync(): void

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

Returns

Section titled “Returns”

void

rename()

Section titled “rename()”

abstract rename(oldPath, newPath): Promise<void>

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

Parameters

Section titled “Parameters”
oldPath
Section titled “oldPath”

string

newPath
Section titled “newPath”

string

Returns

Section titled “Returns”

Promise<void>

renameSync()

Section titled “renameSync()”

abstract renameSync(oldPath, newPath): void

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

Parameters

Section titled “Parameters”
oldPath
Section titled “oldPath”

string

newPath
Section titled “newPath”

string

Returns

Section titled “Returns”

void

rmdir()

Section titled “rmdir()”

abstract rmdir(path): Promise<void>

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

Parameters

Section titled “Parameters”
path
Section titled “path”

string

Returns

Section titled “Returns”

Promise<void>

rmdirSync()

Section titled “rmdirSync()”

abstract rmdirSync(path): void

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

Parameters

Section titled “Parameters”
path
Section titled “path”

string

Returns

Section titled “Returns”

void

stat()

Section titled “stat()”

abstract stat(path): Promise<InodeLike<number>>

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

Parameters

Section titled “Parameters”
path
Section titled “path”

string

Returns

Section titled “Returns”

Promise<InodeLike<number>>

statSync()

Section titled “statSync()”

abstract statSync(path): InodeLike

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

Parameters

Section titled “Parameters”
path
Section titled “path”

string

Returns

Section titled “Returns”

InodeLike

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

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

sync()

Section titled “sync()”

abstract sync(): Promise<void>

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

Returns

Section titled “Returns”

Promise<void>

syncSync()

Section titled “syncSync()”

abstract syncSync(): void

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

Returns

Section titled “Returns”

void

toString()

Section titled “toString()”

toString(): string

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

Returns

Section titled “Returns”

string

touch()

Section titled “touch()”

abstract touch(path, metadata): Promise<void>

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

Modify metadata.

Parameters

Section titled “Parameters”
path
Section titled “path”

string

metadata
Section titled “metadata”

Partial<InodeLike>

Returns

Section titled “Returns”

Promise<void>

touchSync()

Section titled “touchSync()”

abstract touchSync(path, metadata): void

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

Modify metadata.

Parameters

Section titled “Parameters”
path
Section titled “path”

string

metadata
Section titled “metadata”

Partial<InodeLike>

Returns

Section titled “Returns”

void

Section titled “unlink()”

abstract unlink(path): Promise<void>

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

Parameters

Section titled “Parameters”
path
Section titled “path”

string

Returns

Section titled “Returns”

Promise<void>

unlinkSync()

Section titled “unlinkSync()”

abstract unlinkSync(path): void

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

Parameters

Section titled “Parameters”
path
Section titled “path”

string

Returns

Section titled “Returns”

void

usage()

Section titled “usage()”

usage(): UsageInfo

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

Default implementation.

Returns

Section titled “Returns”

UsageInfo

Todo

Section titled “Todo”

Implement

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>

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

ContributeSponsor