EmscriptenFS

Defined in: src/backend.ts:29

Mounts an Emscripten file system into the ZenFS file system.

Extends

• AsyncFSMethods<this> & FileSystem<this>

Constructors

Constructor

new EmscriptenFS(em): EmscriptenFS

Defined in: src/backend.ts:30

Parameters

em

typeof FS

The Emscripten FS

Returns

EmscriptenFS

Overrides

Sync(FileSystem).constructor

Properties

_mountPoint?

protected optional _mountPoint?: string

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

Internal

The last place this file system was mounted

Inherited from

Sync(FileSystem)._mountPoint

---

_uuid

protected _uuid: UUID

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

Internal

The UUID of the file system.

Inherited from

Sync(FileSystem)._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:156

See

FileSystemAttributes

Inherited from

Sync(FileSystem).attributes

---

em

protected em: typeof FS

Defined in: src/backend.ts:34

The Emscripten FS

---

label?

optional label?: string

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

Inherited from

Sync(FileSystem).label

---

name

readonly name: string

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

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

Inherited from

Sync(FileSystem).name

---

type

readonly type: number

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

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

Inherited from

Sync(FileSystem).type

Accessors

uuid

Get Signature

get uuid(): UUID

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

Returns

UUID

Inherited from

Sync(FileSystem).uuid

Methods

chmodSync()

chmodSync(path, mode): void

Defined in: src/backend.ts:129

Parameters

path

string

mode

number

Returns

void

---

chownSync()

chownSync(path, new_uid, new_gid): void

Defined in: src/backend.ts:137

Parameters

path

string

new_uid

number

new_gid

number

Returns

void

---

createFile()

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

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

Create the file at path with the given options.

Parameters

path

string

options

CreationOptions

Returns

Promise<InodeLike<number>>

Inherited from

Sync(FileSystem).createFile

---

createFileSync()

createFileSync(path, options): Inode

Defined in: src/backend.ts:76

Create the file at path with the given options.

Parameters

path

string

options

CreationOptions

Returns

Inode

Overrides

Sync(FileSystem).createFileSync

---

exists()

exists(path): Promise<boolean>

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

Test whether or not path exists.

Parameters

path

string

Returns

Promise<boolean>

Inherited from

Sync(FileSystem).exists

---

existsSync()

existsSync(path): boolean

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

Test whether or not path exists.

Parameters

path

string

Returns

boolean

Inherited from

Sync(FileSystem).existsSync

---

ioctl()

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

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

Internal

Parameters

context

IoctlContext

command

number

args

…any[]

Returns

Promise<any>

Inherited from

Sync(FileSystem).ioctl

---

ioctlSync()

ioctlSync(context, command, …args): any

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

Internal

Parameters

context

IoctlContext

command

number

args

…any[]

Returns

any

Inherited from

Sync(FileSystem).ioctlSync

---

link()

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

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

Parameters

target

string

link

string

Returns

Promise<void>

Inherited from

Sync(FileSystem).link

---

linkSync()

linkSync(srcpath, dstpath): void

Defined in: src/backend.ts:157

Right now this method is just a mask for symlinks

Parameters

srcpath

string

dstpath

string

Returns

void

Todo

track hard links

Overrides

Sync(FileSystem).linkSync

---

mkdir()

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

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

Parameters

path

string

options

CreationOptions

Returns

Promise<InodeLike<number>>

Inherited from

Sync(FileSystem).mkdir

---

mkdirSync()

mkdirSync(path, options): Inode

Defined in: src/backend.ts:103

Parameters

path

string

options

CreationOptions

Returns

Inode

Overrides

Sync(FileSystem).mkdirSync

---

read()

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

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

Reads into a buffer

Parameters

path

string

buffer

Uint8Array

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

start

number

The offset into the file to start reading from

end

number

The position in the file to stop reading

Returns

Promise<void>

Inherited from

Sync(FileSystem).read

---

readdir()

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

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

Parameters

path

string

Returns

Promise<string[]>

Inherited from

Sync(FileSystem).readdir

---

readdirSync()

readdirSync(path): string[]

Defined in: src/backend.ts:112

Parameters

path

string

Returns

string[]

Overrides

Sync(FileSystem).readdirSync

---

readlinkSync()

readlinkSync(path): string

Defined in: src/backend.ts:165

Parameters

path

string

Returns

string

---

readSync()

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

Defined in: src/backend.ts:181

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

Sync(FileSystem).readSync

---

ready()

ready(): Promise<void>

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

Returns

Promise<void>

Inherited from

Sync(FileSystem).ready

---

readySync()

readySync(): void

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

Returns

void

Inherited from

Sync(FileSystem).readySync

---

rename()

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

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

Parameters

oldPath

string

newPath

string

Returns

Promise<void>

Inherited from

Sync(FileSystem).rename

---

renameSync()

renameSync(oldPath, newPath): void

Defined in: src/backend.ts:53

Parameters

oldPath

string

newPath

string

Returns

void

Overrides

Sync(FileSystem).renameSync

---

rmdir()

abstract rmdir(path): Promise<void>

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

Parameters

path

string

Returns

Promise<void>

Inherited from

Sync(FileSystem).rmdir

---

rmdirSync()

rmdirSync(path): void

Defined in: src/backend.ts:95

Parameters

path

string

Returns

void

Overrides

Sync(FileSystem).rmdirSync

---

stat()

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

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

Parameters

path

string

Returns

Promise<InodeLike<number>>

Inherited from

Sync(FileSystem).stat

---

statSync()

statSync(path): Inode

Defined in: src/backend.ts:61

Parameters

path

string

Returns

Inode

Overrides

Sync(FileSystem).statSync

---

streamRead()

streamRead(path, options): ReadableStream

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

Read a file using a stream.

Parameters

path

string

options

StreamOptions

Returns

ReadableStream

Inherited from

Sync(FileSystem).streamRead

---

streamWrite()

streamWrite(path, options): WritableStream

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

Write a file using stream.

Parameters

path

string

options

StreamOptions

Returns

WritableStream

Inherited from

Sync(FileSystem).streamWrite

---

symlinkSync()

symlinkSync(srcpath, dstpath): void

Defined in: src/backend.ts:145

Parameters

srcpath

string

dstpath

string

Returns

void

---

sync()

abstract sync(): Promise<void>

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

Returns

Promise<void>

Inherited from

Sync(FileSystem).sync

---

syncSync()

syncSync(): void

Defined in: src/backend.ts:51

Returns

void

Overrides

Sync(FileSystem).syncSync

---

toString()

toString(): string

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

Returns

string

Inherited from

Sync(FileSystem).toString

---

touch()

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

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

Modify metadata.

Parameters

path

string

metadata

Partial<InodeLike>

Returns

Promise<void>

Inherited from

Sync(FileSystem).touch

---

touchSync()

touchSync(path, inode): void

Defined in: src/backend.ts:40

Modify metadata.

Parameters

path

string

inode

Partial<InodeLike>

Returns

void

Overrides

Sync(FileSystem).touchSync

---

truncateSync()

truncateSync(path, len): void

Defined in: src/backend.ts:121

Parameters

path

string

len

number

Returns

void

---

unlink()

abstract unlink(path): Promise<void>

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

Parameters

path

string

Returns

Promise<void>

Inherited from

Sync(FileSystem).unlink

---

unlinkSync()

unlinkSync(path): void

Defined in: src/backend.ts:87

Parameters

path

string

Returns

void

Overrides

Sync(FileSystem).unlinkSync

---

usage()

usage(): UsageInfo

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

Default implementation.

Experimental

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

Returns

UsageInfo

Todo

Implement

Inherited from

Sync(FileSystem).usage

---

utimesSync()

utimesSync(path, atime, mtime): void

Defined in: src/backend.ts:173

Parameters

path

string

atime

number

mtime

number

Returns

void

---

write()

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

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

Writes a buffer to a file

Parameters

path

string

buffer

Uint8Array

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

offset

number

The offset in the file to start writing

Returns

Promise<void>

Inherited from

Sync(FileSystem).write

---

writeSync()

writeSync(path, buffer, offset): void

Defined in: src/backend.ts:190

Writes a buffer to a file

Parameters

path

string

buffer

Uint8Array

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

offset

number

The offset in the file to start writing

Returns

void

Overrides

Sync(FileSystem).writeSync