Class EmscriptenFS

Mounts an Emscripten file system into the BrowserFS file system.

Hierarchy

  • ExtractProperties<FileSystem, ((...args: any[]) => Promise<unknown>)> & FileSystem<this>
    • EmscriptenFS

Constructors

constructor

Properties

_disableSync? em

Methods

chmodSync chownSync createFile createFileSync exists existsSync link linkSync metadata mkdir mkdirSync openFile openFileSync readdir readdirSync readlinkSync ready rename renameSync rmdir rmdirSync stat statSync symlinkSync sync syncSync truncateSync unlink unlinkSync utimesSync

Constructors

constructor

Properties

Protected Optional Internal_disableSync

_disableSync?: boolean

Whether the sync cache should be disabled. Only affects async things.

Protectedem

em: typeof FS

The Emscripten FS

Methods

chmodSync

  • chmodSync(path, mode): void

  • Parameters

    • path: string
    • mode: number

    Returns void

chownSync

  • chownSync(path, new_uid, new_gid): void

  • Parameters

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

    Returns void

AbstractcreateFile

  • createFile(path, flag, mode): Promise<File>

  • Create the file at path with the given mode. Then, open it with the given flag.

    Parameters

    • path: string
    • flag: string
    • mode: number

    Returns Promise<File>

createFileSync

  • createFileSync(path): EmscriptenFile

  • Create the file at path with the given mode. Then, open it with the given flag.

    Parameters

    • path: string

    Returns EmscriptenFile

exists

  • exists(path): Promise<boolean>

  • Test whether or not the given path exists.

    Parameters

    • path: string

    Returns Promise<boolean>

existsSync

  • existsSync(path): boolean

  • Test whether or not the given path exists.

    Parameters

    • path: string

    Returns boolean

Abstractlink

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

  • Asynchronous link.

    Parameters

    • target: string
    • link: string

    Returns Promise<void>

linkSync

  • linkSync(srcpath, dstpath): void

  • Right now this method is just a mask for symlinks

    Parameters

    • srcpath: string
    • dstpath: string

    Returns void

    Todo

    track hard links

metadata

  • metadata(): FileSystemMetadata

  • Get metadata about the current file system

    Returns FileSystemMetadata

Abstractmkdir

  • mkdir(path, mode): Promise<void>

  • Asynchronous mkdir.

    Parameters

    • path: string
    • mode: number

      Mode to make the directory using.

    Returns Promise<void>

mkdirSync

  • mkdirSync(path, mode): void

  • Synchronous mkdir.

    Parameters

    • path: string
    • mode: number

      Mode to make the directory using.

    Returns void

AbstractopenFile

  • openFile(path, flag): Promise<File>

  • Opens the file at path with the given flag. The file must exist.

    Parameters

    • path: string

      The path to open.

    • flag: string

      The flag to use when opening the file.

    Returns Promise<File>

openFileSync

  • openFileSync(path, flag): EmscriptenFile

  • Opens the file at path with the given flag. The file must exist.

    Parameters

    • path: string

      The path to open.

    • flag: string

      The flag to use when opening the file.

    Returns EmscriptenFile

    A File object corresponding to the opened file.

Abstractreaddir

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

  • Asynchronous readdir. Reads the contents of a directory.

    Parameters

    • path: string

    Returns Promise<string[]>

readdirSync

  • readdirSync(path): string[]

  • Synchronous readdir. Reads the contents of a directory.

    Parameters

    • path: string

    Returns string[]

readlinkSync

  • readlinkSync(path): string

  • Parameters

    • path: string

    Returns string

ready

  • ready(): Promise<void>

  • Returns Promise<void>

Abstractrename

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

  • Asynchronous rename.

    Parameters

    • oldPath: string
    • newPath: string

    Returns Promise<void>

renameSync

  • renameSync(oldPath, newPath): void

  • Synchronous rename.

    Parameters

    • oldPath: string
    • newPath: string

    Returns void

Abstractrmdir

  • rmdir(path): Promise<void>

  • Asynchronous rmdir.

    Parameters

    • path: string

    Returns Promise<void>

rmdirSync

  • rmdirSync(path): void

  • Synchronous rmdir.

    Parameters

    • path: string

    Returns void

Abstractstat

  • stat(path): Promise<Stats>

  • Asynchronous stat.

    Parameters

    • path: string

    Returns Promise<Stats>

statSync

  • statSync(path): Stats

  • Synchronous stat.

    Parameters

    • path: string

    Returns Stats

symlinkSync

  • symlinkSync(srcpath, dstpath): void

  • Parameters

    • srcpath: string
    • dstpath: string

    Returns void

Abstractsync

  • sync(path, data, stats): Promise<void>

  • Synchronize the data and stats for path asynchronously

    Parameters

    • path: string
    • data: Uint8Array
    • stats: Readonly<Stats>

    Returns Promise<void>

syncSync

  • syncSync(path, data, stats): void

  • Synchronize the data and stats for path synchronously

    Parameters

    • path: string
    • data: Uint8Array
    • stats: Readonly<Stats>

    Returns void

truncateSync

  • truncateSync(path, len): void

  • Parameters

    • path: string
    • len: number

    Returns void

Abstractunlink

  • unlink(path): Promise<void>

  • Asynchronous unlink.

    Parameters

    • path: string

    Returns Promise<void>

unlinkSync

  • unlinkSync(path): void

  • Synchronous unlink.

    Parameters

    • path: string

    Returns void

utimesSync

  • utimesSync(path, atime, mtime): void

  • Parameters

    • path: string
    • atime: Date
    • mtime: Date

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods