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: 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, flag: string, mode: number): Promise<File<FileSystem>>

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

    Parameters

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

    Returns Promise<File<FileSystem>>

createFileSync

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

metadata

  • metadata(): FileSystemMetadata

  • Get metadata about the current file system

    Returns FileSystemMetadata

Abstractmkdir

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

  • Parameters

    • path: string
    • mode: number

    Returns Promise<void>

mkdirSync

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

  • Parameters

    • path: string
    • mode: number

    Returns void

AbstractopenFile

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

  • Opens the file at path with 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<FileSystem>>

openFileSync

  • openFileSync(path: string, flag: string): EmscriptenFile

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

    Parameters

    • path: string

      The path to open.

    • flag: string

      The flag to use when opening the file.

    Returns EmscriptenFile

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

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

  • Parameters

    • path: string

    Returns Promise<Stats>

statSync

  • statSync(path: string): Stats

  • Parameters

    • path: string

    Returns Stats

symlinkSync

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

  • Parameters

    • srcpath: string
    • dstpath: string

    Returns void

Abstractsync

  • sync(
        path: string,
        data: Uint8Array<ArrayBufferLike>,
        stats: Readonly<Stats>,
    ): Promise<void>

  • Parameters

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

    Returns Promise<void>

syncSync

  • syncSync(
        path: string,
        data?: Uint8Array<ArrayBufferLike>,
        stats?: Readonly<Partial<Stats>>,
    ): void

  • Parameters

    • path: string
    • Optionaldata: Uint8Array<ArrayBufferLike>
    • stats: Readonly<Partial<Stats>> = {}

    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

utimesSync

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

  • Parameters

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

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods