Class EmscriptenFS

Mounts an Emscripten file system into the ZenFS file system.

Hierarchy

  • AsyncFSMethods & FileSystem<this>
    • EmscriptenFS

Constructors

constructor

Properties

_mountPoint? _uuid attributes em label? name type

Accessors

uuid

Methods

chmodSync chownSync createFile createFileSync exists existsSync link linkSync mkdir mkdirSync read readdir readdirSync readlinkSync readSync ready rename renameSync rmdir rmdirSync stat statSync streamRead streamWrite symlinkSync sync syncSync toString touch touchSync truncateSync unlink unlinkSync usage utimesSync write writeSync

Constructors

constructor

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.

Readonlyattributes

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

See

FileSystemAttributes

Protectedem

em: typeof FS

The Emscripten FS

Optionallabel

label?: string

Readonlyname

name: string

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

Readonlytype

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

Methods

chmodSync

  • chmodSync(path: string, mode: number): void

  • Parameters

    • path: string
    • mode: number

    Returns void

chownSync

  • chownSync(path: string, new_uid: number, new_gid: number): void

  • Parameters

    • path: string
    • new_uid: number
    • new_gid: number

    Returns void

AbstractcreateFile

  • createFile(path: string, options: CreationOptions): Promise<InodeLike>

  • Create the file at path with the given options.

    Parameters

    • path: string
    • options: CreationOptions

    Returns Promise<InodeLike>

createFileSync

  • createFileSync(path: string, options: CreationOptions): Inode

  • Create the file at path with the given options.

    Parameters

    • path: string
    • options: CreationOptions

    Returns Inode

exists

  • exists(path: string): Promise<boolean>

  • Test whether or not path exists.

    Parameters

    • path: string

    Returns Promise<boolean>

existsSync

  • existsSync(path: string): boolean

  • Test whether or not path exists.

    Parameters

    • path: string

    Returns boolean

Abstractlink

  • link(target: string, link: string): Promise<void>

  • Parameters

    • target: string
    • link: string

    Returns Promise<void>

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

Abstractmkdir

  • mkdir(path: string, options: CreationOptions): Promise<InodeLike>

  • Parameters

    • path: string
    • options: CreationOptions

    Returns Promise<InodeLike>

mkdirSync

  • mkdirSync(path: string, options: CreationOptions): Inode

  • Parameters

    • path: string
    • options: CreationOptions

    Returns Inode

Abstractread

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

Abstractreaddir

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

  • Parameters

    • path: string

    Returns Promise<string[]>

readdirSync

  • readdirSync(path: string): string[]

  • Parameters

    • path: string

    Returns string[]

readlinkSync

  • readlinkSync(path: string): string

  • Parameters

    • path: string

    Returns string

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

ready

  • ready(): Promise<void>

  • Returns Promise<void>

Abstractrename

  • rename(oldPath: string, newPath: string): Promise<void>

  • Parameters

    • oldPath: string
    • newPath: string

    Returns Promise<void>

renameSync

  • renameSync(oldPath: string, newPath: string): void

  • Parameters

    • oldPath: string
    • newPath: string

    Returns void

Abstractrmdir

  • rmdir(path: string): Promise<void>

  • Parameters

    • path: string

    Returns Promise<void>

rmdirSync

  • rmdirSync(path: string): void

  • Parameters

    • path: string

    Returns void

Abstractstat

  • stat(path: string): Promise<InodeLike>

  • Parameters

    • path: string

    Returns Promise<InodeLike>

statSync

  • statSync(path: string): Inode

  • Parameters

    • path: string

    Returns Inode

streamRead

  • streamRead(path: string, options: StreamOptions): ReadableStream

  • Read a file using a stream.

    Parameters

    • path: string
    • options: StreamOptions

    Returns ReadableStream

streamWrite

  • streamWrite(path: string, options: StreamOptions): WritableStream

  • Write a file using stream.

    Parameters

    • path: string
    • options: StreamOptions

    Returns WritableStream

symlinkSync

  • symlinkSync(srcpath: string, dstpath: string): void

  • Parameters

    • srcpath: string
    • dstpath: string

    Returns void

Abstractsync

  • sync(path: string): Promise<void>

  • Parameters

    • path: string

    Returns Promise<void>

syncSync

  • syncSync(): void

  • Returns void

toString

  • toString(): string

  • Returns string

Abstracttouch

  • touch(path: string, metadata: Partial<InodeLike>): Promise<void>

  • Modify metadata.

    Parameters

    • path: string
    • metadata: Partial<InodeLike>

    Returns Promise<void>

touchSync

  • touchSync(path: string, inode: Partial<InodeLike>): void

  • Modify metadata.

    Parameters

    • path: string
    • inode: Partial<InodeLike>

    Returns void

truncateSync

  • truncateSync(path: string, len: number): void

  • Parameters

    • path: string
    • len: number

    Returns void

Abstractunlink

  • unlink(path: string): Promise<void>

  • Parameters

    • path: string

    Returns Promise<void>

unlinkSync

  • unlinkSync(path: string): void

  • Parameters

    • path: string

    Returns void

usage

  • usage(): UsageInfo
  • Experimental

    Default implementation.

    Returns UsageInfo

    Todo

    Implement

utimesSync

  • utimesSync(path: string, atime: number, mtime: number): void

  • Parameters

    • path: string
    • atime: number
    • mtime: number

    Returns void

Abstractwrite

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

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

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods