Class FileSystemAbstract Internal

Provides a consistent and easy to use internal API. Default implementations for exists and existsSync are included. If you are extending this class, note that every path is an absolute path and all arguments are present.

Hierarchy (View Summary)

Constructors

constructor

Properties

_disableSync?

Methods

createFile createFileSync exists existsSync link linkSync metadata mkdir mkdirSync openFile openFileSync read readdir readdirSync readSync ready rename renameSync rmdir rmdirSync stat statSync sync syncSync unlink unlinkSync write writeSync

Constructors

constructor

Properties

Protected Optional Internal_disableSync

_disableSync?: boolean

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

Methods

AbstractcreateFile

AbstractcreateFileSync

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>

AbstractlinkSync

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

  • Parameters

    • target: string
    • link: string

    Returns void

metadata

Abstractmkdir

AbstractmkdirSync

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

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>

Abstractread

  • read(
        path: string,
        buffer: Uint8Array<ArrayBufferLike>,
        offset: number,
        end: number,
    ): Promise<void>

  • Reads into a buffer

    Parameters

    • path: string
    • buffer: Uint8Array<ArrayBufferLike>

      The buffer to read into. You must set the byteOffset and byteLength appropriately!

    • offset: 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[]>

AbstractreaddirSync

  • readdirSync(path: string): string[]

  • Parameters

    • path: string

    Returns string[]

AbstractreadSync

  • readSync(
        path: string,
        buffer: Uint8Array<ArrayBufferLike>,
        offset: number,
        end: number,
    ): void

  • Reads into a buffer

    Parameters

    • path: string
    • buffer: Uint8Array<ArrayBufferLike>

      The buffer to read into. You must set the byteOffset and byteLength appropriately!

    • offset: number

      The offset into the file to start reading from

    • end: number

      The position in the file to stop reading

    Returns void

ready

Abstractrename

  • 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

Abstractrmdir

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

  • Parameters

    • path: string

    Returns Promise<void>

AbstractrmdirSync

Abstractstat

AbstractstatSync

Abstractsync

  • sync(
        path: string,
        data?: Uint8Array<ArrayBufferLike>,
        stats?: Readonly<Partial<StatsLike<number | bigint>>>,
    ): Promise<void>

  • Parameters

    • path: string
    • Optionaldata: Uint8Array<ArrayBufferLike>
    • Optionalstats: Readonly<Partial<StatsLike<number | bigint>>>

    Returns Promise<void>

AbstractsyncSync

  • syncSync(
        path: string,
        data?: Uint8Array<ArrayBufferLike>,
        stats?: Readonly<Partial<StatsLike<number | bigint>>>,
    ): void

  • Parameters

    • path: string
    • Optionaldata: Uint8Array<ArrayBufferLike>
    • Optionalstats: Readonly<Partial<StatsLike<number | bigint>>>

    Returns void

Abstractunlink

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

  • Parameters

    • path: string

    Returns Promise<void>

AbstractunlinkSync

Abstractwrite

  • write(
        path: string,
        buffer: Uint8Array<ArrayBufferLike>,
        offset: number,
    ): Promise<void>

  • Writes a buffer to a file

    Parameters

    • path: string
    • buffer: Uint8Array<ArrayBufferLike>

      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<ArrayBufferLike>,
        offset: number,
    ): void

  • Writes a buffer to a file

    Parameters

    • path: string
    • buffer: Uint8Array<ArrayBufferLike>

      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
Methods