Class WebAccessFS

Hierarchy

  • AsyncMixin<this> & IndexFS<this>
    • WebAccessFS

Constructors

constructor

Properties

_handles _mountPoint? _uuid attributes index label? name type

Accessors

uuid

Methods

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

Constructors

constructor

Properties

Protected_handles

_handles: Map<string, FileSystemHandle> = ...

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

Readonlyindex

index: Index

Optionallabel

label?: string

Readonlyname

name: string

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

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

Protected_remove

  • _remove(path: string, isUnlink: boolean): void

    Parameters

    • path: string
    • isUnlink: boolean

    Returns void

Protectedcreate

  • create(path: string, options: CreationOptions): Inode

    Parameters

    • path: string
    • options: CreationOptions

    Returns Inode

createFile

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

    Create the file at path with the given options.

    Parameters

    • path: string
    • options: CreationOptions

    Returns Promise<InodeLike>

AbstractcreateFileSync

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

    Create the file at path with the given options.

    Parameters

    • path: string
    • options: CreationOptions

    Returns InodeLike

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<const T extends null | FileSystemHandleKind>(
        kind?: T,
        path: string,
        syscall?: string,
    ): T extends FileSystemHandleKind ? HKindToType<T<T>> : FileSystemHandle

    Type Parameters

    • const T extends null | FileSystemHandleKind

    Parameters

    • kind: T = ...
    • path: string
    • Optionalsyscall: string

    Returns T extends FileSystemHandleKind ? HKindToType<T<T>> : FileSystemHandle

link

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

    Parameters

    • target: string
    • link: string

    Returns Promise<void>

AbstractlinkSync

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

    Parameters

    • target: string
    • link: string

    Returns void

mkdir

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

    Parameters

    • path: string
    • options: CreationOptions

    Returns Promise<InodeLike>

AbstractmkdirSync

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

    Parameters

    • path: string
    • options: CreationOptions

    Returns InodeLike

queueDone

  • queueDone(): Promise<void>

    Returns Promise<void>

read

  • read(
        path: string,
        buffer: Uint8Array,
        offset: 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!

    • offset: number
    • end: number

      The position in the file to stop reading

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

AbstractreadSync

  • readSync(path: string, buffer: Uint8Array, start: 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!

    • start: number

      The offset into the file to start reading from

    • end: number

      The position in the file to stop reading

    Returns void

ready

  • ready(): Promise<void>

    Returns Promise<void>

remove

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

    Parameters

    • path: string

    Returns Promise<void>

ProtectedremoveSync

  • removeSync(path: string): void

    Parameters

    • path: string

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

    Parameters

    • path: string

    Returns Promise<Inode>

AbstractstatSync

  • statSync(path: string): InodeLike

    Parameters

    • path: string

    Returns InodeLike

  • 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

sync

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

    Parameters

    • path: string

    Returns Promise<void>

AbstractsyncSync

  • syncSync(path: string): void

    Parameters

    • path: string

    Returns void

toString

  • toString(): string

    Returns string

touch

  • touch(path: string, metadata: InodeLike): Promise<void>

    Modify metadata.

    Parameters

    • path: string
    • metadata: InodeLike

    Returns Promise<void>

AbstracttouchSync

  • touchSync(path: string, metadata: Partial<InodeLike>): void

    Modify metadata.

    Parameters

    • path: string
    • metadata: Partial<InodeLike>

    Returns void

  • touchSync(path: string, metadata: InodeLike): void

    Modify metadata.

    Parameters

    • path: string
    • metadata: InodeLike

    Returns void

unlink

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

    Parameters

    • path: string

    Returns Promise<void>

AbstractunlinkSync

  • unlinkSync(path: string): void

    Parameters

    • path: string

    Returns void

usage

  • usage(): UsageInfo
    Experimental

    Default implementation.

    Returns UsageInfo

    Todo

    Implement

write

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

AbstractwriteSync

  • 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