Class WebAccessFS

Hierarchy

  • AsyncMixin<this> & FileSystem<this>
    • WebAccessFS

Constructors

constructor

Properties

_disableSync?

Methods

createFile createFileSync exists existsSync getHandle link linkSync metadata mkdir mkdirSync openFile openFileSync queueDone readdir readdirSync ready rename renameSync rmdir rmdirSync stat statSync sync syncSync unlink unlinkSync writeFile

Constructors

constructor

  • new WebAccessFS(handle: FileSystemDirectoryHandle): WebAccessFS

  • Parameters

    • handle: FileSystemDirectoryHandle

    Returns WebAccessFS

Properties

Protected Optional Internal_disableSync

_disableSync?: boolean

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

Methods

createFile

  • createFile(path: string, flag: string): Promise<PreloadFile<WebAccessFS>>

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

    Parameters

    • path: string
    • flag: string

    Returns Promise<PreloadFile<WebAccessFS>>

AbstractcreateFileSync

  • createFileSync(
        path: string,
        flag: string,
        mode: number,
        options: CreationOptions,
    ): 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 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

ProtectedgetHandle

  • getHandle(path: string): Promise<undefined | FileSystemHandle>

  • Parameters

    • path: string

    Returns Promise<undefined | FileSystemHandle>

link

  • link(srcpath: string): Promise<void>

  • Parameters

    • srcpath: string

    Returns Promise<void>

AbstractlinkSync

  • 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

mkdir

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

  • Parameters

    • path: string
    • Optionalmode: number
    • Optionaloptions: CreationOptions

    Returns Promise<void>

AbstractmkdirSync

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

  • Parameters

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

    Returns void

openFile

  • openFile(path: string, flag: string): Promise<PreloadFile<WebAccessFS>>

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

AbstractopenFileSync

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

queueDone

  • queueDone(): Promise<void>

  • Returns Promise<void>

readdir

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

  • Parameters

    • path: string

    Returns Promise<string[]>

AbstractreaddirSync

  • readdirSync(path: string): string[]

  • Parameters

    • path: string

    Returns string[]

ready

  • ready(): Promise<void>

  • Returns Promise<void>

rename

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

  • Parameters

    • oldPath: string
    • newPath: string

    Returns Promise<void>

AbstractrenameSync

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

  • Parameters

    • oldPath: string
    • newPath: string

    Returns void

rmdir

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

  • Parameters

    • path: string

    Returns Promise<void>

AbstractrmdirSync

  • rmdirSync(path: string): void

  • Parameters

    • path: string

    Returns void

stat

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

  • Parameters

    • path: string

    Returns Promise<Stats>

AbstractstatSync

  • statSync(path: string): Stats

  • Parameters

    • path: string

    Returns Stats

sync

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

  • Parameters

    • path: string
    • data: Uint8Array<ArrayBufferLike>

    Returns Promise<void>

AbstractsyncSync

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

  • Parameters

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

    Returns void

unlink

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

  • Parameters

    • path: string

    Returns Promise<void>

AbstractunlinkSync

  • unlinkSync(path: string): void

  • Parameters

    • path: string

    Returns void

writeFile

  • writeFile(path: string, data: Uint8Array<ArrayBufferLike>): Promise<void>

  • Parameters

    • path: string
    • data: Uint8Array<ArrayBufferLike>

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods