Class XMLFS

Hierarchy

  • AsyncFSMethods & FileSystem<this>
    • XMLFS

Constructors

constructor

Properties

_mountPoint? _uuid attributes label? name root type

Accessors

uuid

Methods

add create createFile createFileSync exists existsSync get link linkSync mkdir mkdirSync read readdir readdirSync readSync ready remove rename renameSync rmdir rmdirSync stat statSync streamRead streamWrite sync syncSync toString touch touchSync unlink unlinkSync usage write writeSync

Constructors

constructor

  • new XMLFS(root?: Element): XMLFS

    Parameters

    • root: Element = ...

      The root fs element

    Returns XMLFS

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

Optionallabel

label?: string

Readonlyname

name: string

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

Readonlyroot

root: Element = ...

The root fs element

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

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<InodeLike> & Pick<StatsLike<number | bigint>, "mode">,
    ): Element

    Parameters

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

    Returns Element

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

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

Abstractmkdir

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

    Parameters

    • path: string
    • options: CreationOptions

    Returns Promise<InodeLike>

mkdirSync

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

    Parameters

    • path: string
    • options: CreationOptions

    Returns InodeLike

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[]

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>

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

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, metadata: Partial<InodeLike>): void

    Modify metadata.

    Parameters

    • path: string
    • metadata: Partial<InodeLike>

    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

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