Class XMLFS

Hierarchy

  • AsyncFSMethods & FileSystem<this>
    • XMLFS

Constructors

constructor

Properties

_disableSync? root

Methods

add create createFile createFileSync exists existsSync get link linkSync metadata mkdir mkdirSync openFile openFileSync readdir readdirSync ready remove rename renameSync rmdir rmdirSync stat statSync sync syncSync toString unlink unlinkSync

Constructors

constructor

  • new XMLFS(root?: Element): XMLFS

  • Parameters

    • root: Element = ...

      The root fs element

    Returns XMLFS

Properties

Protected Optional Internal_disableSync

_disableSync?: boolean

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

Readonlyroot

root: Element = ...

The root fs element

Methods

Protectedadd

  • add(syscall: string, node: Element, path: string, contents?: boolean): void

  • Parameters

    • syscall: string
    • node: Element
    • path: string
    • contents: boolean = false

    Returns void

Protectedcreate

  • create(
        syscall: string,
        path: string,
        stats: Partial<StatsLike<number>> & Pick<
            StatsLike<number | bigint>,
            "mode",
        >,
    ): Element

  • Parameters

    • syscall: string
    • path: string
    • stats: Partial<StatsLike<number>> & Pick<StatsLike<number | bigint>, "mode">

    Returns Element

AbstractcreateFile

  • createFile(
        path: string,
        flag: string,
        mode: number,
        options: CreationOptions,
    ): Promise<File<FileSystem>>

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

    Parameters

    • path: string
    • flag: string
    • mode: number
    • options: CreationOptions

    Returns Promise<File<FileSystem>>

createFileSync

  • createFileSync(
        path: string,
        flag: string,
        mode: number,
        __namedParameters: CreationOptions,
    ): File<FileSystem>

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

    Parameters

    • path: string
    • flag: string
    • mode: number
    • __namedParameters: CreationOptions

    Returns File<FileSystem>

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

Protectedget

  • get(syscall: string, path: string): Element

  • Parameters

    • syscall: string
    • path: string

    Returns Element

Abstractlink

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

  • Parameters

    • target: string
    • link: string

    Returns Promise<void>

linkSync

  • linkSync(target: string, link: string): void

  • Parameters

    • target: string
    • link: string

    Returns void

metadata

  • metadata(): FileSystemMetadata

  • Get metadata about the current file system

    Returns FileSystemMetadata

Abstractmkdir

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

  • Parameters

    • path: string
    • mode: number
    • options: CreationOptions

    Returns Promise<void>

mkdirSync

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

  • Parameters

    • path: string
    • mode: number
    • __namedParameters: CreationOptions

    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): 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 File<FileSystem>

Abstractreaddir

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

  • Parameters

    • path: string

    Returns Promise<string[]>

readdirSync

  • readdirSync(path: string): string[]

  • Parameters

    • path: string

    Returns string[]

ready

  • ready(): Promise<void>

  • Returns Promise<void>

Protectedremove

  • remove(syscall: string, node: Element, path: string, contents?: boolean): void

  • Parameters

    • syscall: string
    • node: Element
    • path: string
    • contents: boolean = false

    Returns 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

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<Stats>,
    ): void

  • Parameters

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

    Returns void

toString

  • toString(): string

  • Returns a string representation of an object.

    Returns string

Abstractunlink

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

  • Parameters

    • path: string

    Returns Promise<void>

unlinkSync

  • unlinkSync(path: string): void

  • Parameters

    • path: string

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods