Class EmscriptenFS

Mounts an Emscripten file system into the ZenFS file system.

Hierarchy

AsyncFSMethods<this> & FileSystem<this>
- EmscriptenFS

Index

Constructors

constructor

new EmscriptenFS(em: typeof FS): EmscriptenFS
Parameters
- em: typeof FS
  The Emscripten FS
Returns EmscriptenFS
Overrides Sync(FileSystem).constructor
- Defined in src/backend.ts:30

Properties

`Protected` `Optional` `Internal`_mountPoint

_mountPoint?: string

The last place this file system was mounted

`Protected` `Internal`_uuid

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

The UUID of the file system.

`Readonly`attributes

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

See

FileSystemAttributes

`Protected`em

em: typeof FS

The Emscripten FS

`Optional`label

label?: string

`Readonly`name

name: string

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

`Readonly`type

type: number

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

Accessors

uuid

get uuid(): `${string}-${string}-${string}-${string}-${string}`
Returns `${string}-${string}-${string}-${string}-${string}`
Inherited from Sync(FileSystem).uuid
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:150

Methods

chmodSync

chmodSync(path: string, mode: number): void
Parameters
- path: string
- mode: number
Returns void
- Defined in src/backend.ts:129

chownSync

chownSync(path: string, new_uid: number, new_gid: number): void
Parameters
- path: string
- new_uid: number
- new_gid: number
Returns void
- Defined in src/backend.ts:137

`Abstract`createFile

createFile(path: string, options: CreationOptions): Promise<InodeLike<number>>
Create the file at path with the given options.
Parameters
- path: string
- options: CreationOptions
Returns Promise<InodeLike<number>>
Inherited from Sync(FileSystem).createFile
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:185

createFileSync

createFileSync(path: string, options: CreationOptions): Inode
Create the file at path with the given options.
Parameters
- path: string
- options: CreationOptions
Returns Inode
Overrides Sync(FileSystem).createFileSync
- Defined in src/backend.ts:76

exists

exists(path: string): Promise<boolean>
Test whether or not path exists.
Parameters
- path: string
Returns Promise<boolean>
Inherited from Sync(FileSystem).exists
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:201

existsSync

existsSync(path: string): boolean
Test whether or not path exists.
Parameters
- path: string
Returns boolean
Inherited from Sync(FileSystem).existsSync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:205

`Abstract`link

link(target: string, link: string): Promise<void>
Parameters
- target: string
- link: string
Returns Promise<void>
Inherited from Sync(FileSystem).link
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:206

linkSync

linkSync(srcpath: string, dstpath: string): void
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
- Defined in src/backend.ts:157

`Abstract`mkdir

mkdir(path: string, options: CreationOptions): Promise<InodeLike<number>>
Parameters
- path: string
- options: CreationOptions
Returns Promise<InodeLike<number>>
Inherited from Sync(FileSystem).mkdir
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:194

mkdirSync

mkdirSync(path: string, options: CreationOptions): Inode
Parameters
- path: string
- options: CreationOptions
Returns Inode
Overrides Sync(FileSystem).mkdirSync
- Defined in src/backend.ts:103

`Abstract`read

read(
    path: string,
    buffer: Uint8Array,
    start: number,
    end: number,
): Promise<void>
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
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:216

`Abstract`readdir

readdir(path: string): Promise<string[]>
Parameters
- path: string
Returns Promise<string[]>
Inherited from Sync(FileSystem).readdir
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:196

readdirSync

readdirSync(path: string): string[]
Parameters
- path: string
Returns string[]
Overrides Sync(FileSystem).readdirSync
- Defined in src/backend.ts:112

readlinkSync

readlinkSync(path: string): string
Parameters
- path: string
Returns string
- Defined in src/backend.ts:165

readSync

readSync(path: string, buffer: Uint8Array, offset: number, end: number): void
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
- Defined in src/backend.ts:181

ready

ready(): Promise<void>
Returns Promise<void>
Inherited from Sync(FileSystem).ready
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:173

`Abstract`rename

rename(oldPath: string, newPath: string): Promise<void>
Parameters
- oldPath: string
- newPath: string
Returns Promise<void>
Inherited from Sync(FileSystem).rename
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:174

renameSync

renameSync(oldPath: string, newPath: string): void
Parameters
- oldPath: string
- newPath: string
Returns void
Overrides Sync(FileSystem).renameSync
- Defined in src/backend.ts:53

`Abstract`rmdir

rmdir(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
Inherited from Sync(FileSystem).rmdir
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:192

rmdirSync

rmdirSync(path: string): void
Parameters
- path: string
Returns void
Overrides Sync(FileSystem).rmdirSync
- Defined in src/backend.ts:95

`Abstract`stat

stat(path: string): Promise<InodeLike<number>>
Parameters
- path: string
Returns Promise<InodeLike<number>>
Inherited from Sync(FileSystem).stat
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:176

statSync

statSync(path: string): Inode
Parameters
- path: string
Returns Inode
Overrides Sync(FileSystem).statSync
- Defined in src/backend.ts:61

streamRead

streamRead(path: string, options: StreamOptions): ReadableStream
Read a file using a stream.
Parameters
- path: string
- options: StreamOptions
Returns ReadableStream
Inherited from Sync(FileSystem).streamRead
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:240

streamWrite

streamWrite(path: string, options: StreamOptions): WritableStream
Write a file using stream.
Parameters
- path: string
- options: StreamOptions
Returns WritableStream
Inherited from Sync(FileSystem).streamWrite
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:245

symlinkSync

symlinkSync(srcpath: string, dstpath: string): void
Parameters
- srcpath: string
- dstpath: string
Returns void
- Defined in src/backend.ts:145

`Abstract`sync

sync(): Promise<void>
Returns Promise<void>
Inherited from Sync(FileSystem).sync
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:208

syncSync

syncSync(): void
Returns void
Overrides Sync(FileSystem).syncSync
- Defined in src/backend.ts:51

toString

toString(): string
Returns string
Inherited from Sync(FileSystem).toString
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:166

`Abstract`touch

touch(path: string, metadata: Partial<InodeLike>): Promise<void>
Modify metadata.
Parameters
- path: string
- metadata: Partial<InodeLike>
Returns Promise<void>
Inherited from Sync(FileSystem).touch
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:179

touchSync

touchSync(path: string, inode: Partial<InodeLike>): void
Modify metadata.
Parameters
- path: string
- inode: Partial<InodeLike>
Returns void
Overrides Sync(FileSystem).touchSync
- Defined in src/backend.ts:40

truncateSync

truncateSync(path: string, len: number): void
Parameters
- path: string
- len: number
Returns void
- Defined in src/backend.ts:121

`Abstract`unlink

unlink(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
Inherited from Sync(FileSystem).unlink
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:190

unlinkSync

unlinkSync(path: string): void
Parameters
- path: string
Returns void
Overrides Sync(FileSystem).unlinkSync
- Defined in src/backend.ts:87

usage

usage(): UsageInfo
Experimental
Default implementation.

Returns UsageInfo
Todo
Implement
Inherited from Sync(FileSystem).usage
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:172

utimesSync

utimesSync(path: string, atime: number, mtime: number): void
Parameters
- path: string
- atime: number
- mtime: number
Returns void
- Defined in src/backend.ts:173

`Abstract`write

write(path: string, buffer: Uint8Array, offset: number): Promise<void>
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
- Defined in node_modules/@zenfs/core/dist/internal/filesystem.d.ts:229

writeSync

writeSync(path: string, buffer: Uint8Array, offset: number): void
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
- Defined in src/backend.ts:190

Class EmscriptenFS

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns EmscriptenFS

Properties

Protected Optional Internal_mountPoint

Protected Internal_uuid

Readonlyattributes

See

Protectedem

Optionallabel

Readonlyname

Readonlytype

Accessors

uuid

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

Methods

chmodSync

Parameters

Returns void

chownSync

Parameters

Returns void

AbstractcreateFile

Parameters

Returns Promise<InodeLike<number>>

createFileSync

Parameters

Returns Inode

exists

Parameters

Returns Promise<boolean>

existsSync

Parameters

Returns boolean

Abstractlink

Parameters

Returns Promise<void>

linkSync

Parameters

Returns void

Todo

Abstractmkdir

Parameters

Returns Promise<InodeLike<number>>

mkdirSync

Parameters

Returns Inode

Abstractread

Parameters

Returns Promise<void>

Abstractreaddir

Parameters

Returns Promise<string[]>

readdirSync

Parameters

Returns string[]

readlinkSync

Parameters

Returns string

readSync

Parameters

Returns void

ready

Returns Promise<void>

Abstractrename

Parameters

Returns Promise<void>

renameSync

Parameters

Returns void

Abstractrmdir

Parameters

`Protected` `Optional` `Internal`_mountPoint

`Protected` `Internal`_uuid

`Readonly`attributes

`Protected`em

`Optional`label

`Readonly`name

`Readonly`type

`Abstract`createFile

`Abstract`link

`Abstract`mkdir

`Abstract`read

`Abstract`readdir

`Abstract`rename

`Abstract`rmdir

`Abstract`stat

`Abstract`sync

`Abstract`touch

`Abstract`unlink

`Abstract`write