Interface AsyncMixinInternal

interface AsyncMixin {
    _sync?: FileSystem;
    createFileSync(path: string, options: CreationOptions): InodeLike;
    linkSync(target: string, link: string): void;
    mkdirSync(path: string, options: CreationOptions): InodeLike;
    queueDone(): Promise<void>;
    readdirSync(path: string): string[];
    readSync(
        path: string,
        buffer: Uint8Array,
        start: number,
        end: number,
    ): void;
    ready(): Promise<void>;
    renameSync(oldPath: string, newPath: string): void;
    rmdirSync(path: string): void;
    statSync(path: string): InodeLike;
    syncSync(path: string): void;
    touchSync(path: string, metadata: Partial<InodeLike>): void;
    unlinkSync(path: string): void;
    writeSync(path: string, buffer: Uint8Array, offset: number): void;
}

Hierarchy

  • Pick<FileSystem, Exclude<_SyncFSKeys, "existsSync">>
    • AsyncMixin

Properties

_sync?

Methods

createFileSync linkSync mkdirSync queueDone readdirSync readSync ready renameSync rmdirSync statSync syncSync touchSync unlinkSync writeSync

Properties

Protected Optional Internal_sync

_sync?: FileSystem

Methods

AbstractcreateFileSync

AbstractlinkSync

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

    Parameters

    • target: string
    • link: string

    Returns void

AbstractmkdirSync

queueDone

AbstractreaddirSync

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

AbstractrenameSync

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

    Parameters

    • oldPath: string
    • newPath: string

    Returns void

AbstractrmdirSync

AbstractstatSync

AbstractsyncSync

AbstracttouchSync

AbstractunlinkSync

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

Properties
Methods