KC's Workspace
    Preparing search index...

    Class Volume

    Volume represents a file system.

    Implements

    Index

    Constructors

    constructor

    Properties

    _core access accessSync appendFile appendFileSync chmod chmodSync chown chownSync close closeSync copyFile copyFileSync cp cpSync exists existsSync fchmod fchmodSync fchown fchownSync fdatasync fdatasyncSync FSWatcher fsync fsyncSync ftruncate ftruncateSync futimes futimesSync glob globSync lchmod lchmodSync lchown lchownSync link linkSync lstatSync lutimes lutimesSync mkdir mkdirSync mkdtemp mkdtempSync open openAsBlob opendir opendirSync openSync read readdir readdirSync readFile readFileSync readlink readlinkSync ReadStream readSync readv readvSync realpath realpathSync rename renameSync rm rmdir rmdirSync rmSync StatWatcher symlink symlinkSync truncate truncateSync unlink unlinkSync utimes utimesSync write writeFile writeFileSync WriteStream writeSync writev writevSync fromJSON fromNestedJSON

    Accessors

    promises

    Methods

    createReadStream createWriteStream fromJSON fromNestedJSON fstat fstatSync lstat mountSync reset stat statfs statfsSync statSync toJSON toTree unwatchFile watch watchFile

    Constructors

    Properties

    Readonly_core

    _core: Superblock
    access: {
        (path: PathLike, callback: TCallback<void>): any;
        (path: PathLike, mode: number, callback: TCallback<void>): any;
    }
    accessSync: (path: PathLike, mode?: number) => void
    appendFile: {
        (id: TFileId, data: TData, callback: TCallback<void>): any;
        (
            id: TFileId,
            data: TData,
            options: string | IAppendFileOptions,
            callback: TCallback<void>,
        ): any;
    }
    appendFileSync: (
        id: TFileId,
        data: TData,
        options?: string | IAppendFileOptions,
    ) => void
    chmod: (path: PathLike, mode: TMode, callback: TCallback<void>) => void
    chmodSync: (path: PathLike, mode: TMode) => void
    chown: (
        path: PathLike,
        uid: number,
        gid: number,
        callback: TCallback<void>,
    ) => void
    chownSync: (path: PathLike, uid: number, gid: number) => void
    close: (fd: number, callback: TCallback<void>) => void
    closeSync: (fd: number) => void
    copyFile: {
        (src: PathLike, dest: PathLike, callback: TCallback<void>): any;
        (
            src: PathLike,
            dest: PathLike,
            flags: number,
            callback: TCallback<void>,
        ): any;
    }
    copyFileSync: (src: PathLike, dest: PathLike, flags?: number) => void
    cp: {
        (src: string | URL, dest: string | URL, callback: TCallback<void>): any;
        (
            src: string | URL,
            dest: string | URL,
            options: ICpOptions,
            callback: TCallback<void>,
        ): any;
    }
    cpSync: (src: string | URL, dest: string | URL, options?: ICpOptions) => void
    exists: (path: PathLike, callback: (exists: boolean) => void) => void
    existsSync: (path: PathLike) => boolean
    fchmod: (fd: number, mode: TMode, callback: TCallback<void>) => void
    fchmodSync: (fd: number, mode: TMode) => void
    fchown: (
        fd: number,
        uid: number,
        gid: number,
        callback: TCallback<void>,
    ) => void
    fchownSync: (fd: number, uid: number, gid: number) => void
    fdatasync: (fd: number, callback: TCallback<void>) => void
    fdatasyncSync: (fd: number) => void
    FSWatcher: new () => FSWatcher
    fsync: (fd: number, callback: TCallback<void>) => void
    fsyncSync: (fd: number) => void
    ftruncate: {
        (fd: number, callback: TCallback<void>): any;
        (fd: number, len: number, callback: TCallback<void>): any;
    }
    ftruncateSync: (fd: number, len?: number) => void
    futimes: (
        fd: number,
        atime: TTime,
        mtime: TTime,
        callback: TCallback<void>,
    ) => void
    futimesSync: (fd: number, atime: TTime, mtime: TTime) => void
    glob: {
        (pattern: string, callback: TCallback<string[]>): void;
        (
            pattern: string,
            options: IGlobOptions,
            callback: TCallback<string[]>,
        ): void;
    }
    globSync: (pattern: string, options?: IGlobOptions) => string[]
    lchmod: (path: PathLike, mode: TMode, callback: TCallback<void>) => void
    lchmodSync: (path: PathLike, mode: TMode) => void
    lchown: (
        path: PathLike,
        uid: number,
        gid: number,
        callback: TCallback<void>,
    ) => void
    lchownSync: (path: PathLike, uid: number, gid: number) => void
    link: (
        existingPath: PathLike,
        newPath: PathLike,
        callback: TCallback<void>,
    ) => void
    linkSync: (existingPath: PathLike, newPath: PathLike) => void
    lstatSync: {
        (path: PathLike): Stats<number>;
        (path: PathLike, options: { throwIfNoEntry?: true }): Stats<number>;
        (
            path: PathLike,
            options: { bigint: false; throwIfNoEntry?: true },
        ): Stats<number>;
        (
            path: PathLike,
            options: { bigint: true; throwIfNoEntry?: true },
        ): Stats<bigint>;
        (
            path: PathLike,
            options: { throwIfNoEntry: false },
        ): Stats<number> | undefined;
        (
            path: PathLike,
            options: { bigint: false; throwIfNoEntry: false },
        ): Stats<number> | undefined;
        (
            path: PathLike,
            options: { bigint: true; throwIfNoEntry: false },
        ): Stats<bigint> | undefined;
    }
    lutimes: (
        path: PathLike,
        atime: TTime,
        mtime: TTime,
        callback: TCallback<void>,
    ) => void
    lutimesSync: (path: PathLike, atime: TTime, mtime: TTime) => void
    mkdir: {
        (path: PathLike, callback: TCallback<void>): any;
        (
            path: PathLike,
            mode: TMode | IMkdirOptions & { recursive?: false },
            callback: TCallback<void>,
        ): any;
        (
            path: PathLike,
            mode: IMkdirOptions & { recursive: true },
            callback: TCallback<string>,
        ): any;
        (
            path: PathLike,
            mode: TMode | IMkdirOptions,
            callback: TCallback<string>,
        ): any;
    }
    mkdirSync: {
        (
            path: PathLike,
            options: IMkdirOptions & { recursive: true },
        ): string | undefined;
        (
            path: PathLike,
            options?: TMode | IMkdirOptions & { recursive?: false },
        ): void;
        (path: PathLike, options?: TMode | IMkdirOptions): string | undefined;
    }
    mkdtemp: {
        (prefix: string, callback: TCallback<string>): any;
        (prefix: string, options: IOptions, callback: TCallback<string>): any;
    }
    mkdtempSync: (prefix: string, options?: IOptions) => TDataOut
    open: {
        (path: PathLike, flags: TFlags, callback: TCallback<number>): void;
        (
            path: PathLike,
            flags: TFlags,
            mode: TMode,
            callback: TCallback<number>,
        ): void;
    }
    openAsBlob: (path: PathLike, options?: IOpenAsBlobOptions) => Promise<Blob>
    opendir: {
        (path: PathLike, callback: TCallback<Dir>): any;
        (
            path: PathLike,
            options: string | IOpendirOptions,
            callback: TCallback<Dir>,
        ): any;
    }
    opendirSync: (path: PathLike, options?: string | IOpendirOptions) => Dir
    openSync: (path: PathLike, flags: TFlags, mode?: TMode) => number
    read: (
        fd: number,
        buffer:
            | Buffer<ArrayBufferLike>
            | DataView<ArrayBufferLike>
            | ArrayBufferView<ArrayBufferLike>,
        offset: number,
        length: number,
        position: number | null,
        callback: (
            err?: Error | null,
            bytesRead?: number,
            buffer?:
                | Buffer<ArrayBufferLike>
                | DataView<ArrayBufferLike>
                | ArrayBufferView<ArrayBufferLike>,
        ) => void,
    ) => void
    readdir: {
        (path: PathLike, callback: TCallback<TDataOut[] | Dirent[]>): any;
        (
            path: PathLike,
            options: string | IReaddirOptions,
            callback: TCallback<TDataOut[] | Dirent[]>,
        ): any;
    }
    readdirSync: (
        path: PathLike,
        options?: string | IReaddirOptions,
    ) => TDataOut[] | Dirent[]
    readFile: {
        (id: TFileId, callback: TCallback<TDataOut>): any;
        (
            id: TFileId,
            options: string | IReadFileOptions,
            callback: TCallback<TDataOut>,
        ): any;
    }
    readFileSync: (file: TFileId, options?: string | IReadFileOptions) => TDataOut
    readlink: {
        (path: PathLike, callback: TCallback<TDataOut>): any;
        (path: PathLike, options: IOptions, callback: TCallback<TDataOut>): any;
    }
    readlinkSync: (path: PathLike, options?: IOptions) => TDataOut
    ReadStream: new (...args: any[]) => IReadStream
    readSync: (
        fd: number,
        buffer:
            | Buffer<ArrayBufferLike>
            | DataView<ArrayBufferLike>
            | ArrayBufferView<ArrayBufferLike>,
        offset: number,
        length: number,
        position: number | null,
    ) => number
    readv: {
        (
            fd: number,
            buffers: ArrayBufferView<ArrayBufferLike>[],
            callback: TCallback2<number, ArrayBufferView<ArrayBufferLike>[]>,
        ): void;
        (
            fd: number,
            buffers: ArrayBufferView<ArrayBufferLike>[],
            position: number | null,
            callback: TCallback2<number, ArrayBufferView<ArrayBufferLike>[]>,
        ): void;
    }
    readvSync: (
        fd: number,
        buffers: ArrayBufferView<ArrayBufferLike>[],
        position?: number | null,
    ) => number
    realpath: {
        native: {
            (path: PathLike, callback: TCallback<TDataOut>): void;
            (
                path: PathLike,
                options: string | IRealpathOptions,
                callback: TCallback<TDataOut>,
            ): void;
        };
        (path: PathLike, callback: TCallback<TDataOut>): void;
        (
            path: PathLike,
            options: string | IRealpathOptions,
            callback: TCallback<TDataOut>,
        ): void;
    }
    realpathSync: {
        native: (
            path: PathLike,
            options?: string | IRealpathOptions,
        ) => TDataOut;
        (path: PathLike, options?: string | IRealpathOptions): TDataOut;
    }
    rename: (
        oldPath: PathLike,
        newPath: PathLike,
        callback: TCallback<void>,
    ) => void
    renameSync: (oldPath: PathLike, newPath: PathLike) => void
    rm: {
        (path: PathLike, callback: TCallback<void>): void;
        (path: PathLike, options: IRmOptions, callback: TCallback<void>): void;
    }
    rmdir: {
        (path: PathLike, callback: TCallback<void>): any;
        (path: PathLike, options: IRmdirOptions, callback: TCallback<void>): any;
    }
    rmdirSync: (path: PathLike, options?: IRmdirOptions) => void
    rmSync: (path: PathLike, options?: IRmOptions) => void
    StatWatcher: new () => StatWatcher
    symlink: {
        (target: PathLike, path: PathLike, callback: TCallback<void>): any;
        (
            target: PathLike,
            path: PathLike,
            type: Type,
            callback: TCallback<void>,
        ): any;
    }
    symlinkSync: (target: PathLike, path: PathLike, type?: Type) => void

    type argument works only on Windows.

    truncate: {
        (id: TFileId, callback: TCallback<void>): any;
        (id: TFileId, len: number, callback: TCallback<void>): any;
    }
    truncateSync: (id: TFileId, len?: number) => void

    id should be a file descriptor or a path. id as file descriptor will not be supported soon.

    unlink: (path: PathLike, callback: TCallback<void>) => void
    unlinkSync: (path: PathLike) => void
    utimes: (
        path: PathLike,
        atime: TTime,
        mtime: TTime,
        callback: TCallback<void>,
    ) => void
    utimesSync: (path: PathLike, atime: TTime, mtime: TTime) => void
    write: {
        (
            fd: number,
            buffer:
                | Buffer<ArrayBufferLike>
                | DataView<ArrayBufferLike>
                | ArrayBufferView<ArrayBufferLike>,
            callback: (...args: any[]) => void,
        ): any;
        (
            fd: number,
            buffer:
                | Buffer<ArrayBufferLike>
                | DataView<ArrayBufferLike>
                | ArrayBufferView<ArrayBufferLike>,
            offset: number,
            callback: (...args: any[]) => void,
        ): any;
        (
            fd: number,
            buffer:
                | Buffer<ArrayBufferLike>
                | DataView<ArrayBufferLike>
                | ArrayBufferView<ArrayBufferLike>,
            offset: number,
            length: number,
            callback: (...args: any[]) => void,
        ): any;
        (
            fd: number,
            buffer:
                | Buffer<ArrayBufferLike>
                | DataView<ArrayBufferLike>
                | ArrayBufferView<ArrayBufferLike>,
            offset: number,
            length: number,
            position: number,
            callback: (...args: any[]) => void,
        ): any;
        (fd: number, str: string, callback: (...args: any[]) => void): any;
        (
            fd: number,
            str: string,
            position: number,
            callback: (...args: any[]) => void,
        ): any;
        (
            fd: number,
            str: string,
            position: number,
            encoding: BufferEncoding,
            callback: (...args: any[]) => void,
        ): any;
    }
    writeFile: {
        (id: TFileId, data: TData, callback: TCallback<void>): void;
        (
            id: TFileId,
            data: TData,
            options: string | IWriteFileOptions,
            callback: TCallback<void>,
        ): void;
    }
    writeFileSync: (id: TFileId, data: TData, options?: IWriteFileOptions) => void
    WriteStream: new (...args: any[]) => IWriteStream
    writeSync: {
        (
            fd: number,
            buffer:
                | Buffer<ArrayBufferLike>
                | DataView<ArrayBufferLike>
                | ArrayBufferView<ArrayBufferLike>,
            offset?: number,
            length?: number,
            position?: number | null,
        ): number;
        (
            fd: number,
            str: string,
            position?: number,
            encoding?: BufferEncoding,
        ): number;
    }
    writev: {
        (
            fd: number,
            buffers: ArrayBufferView<ArrayBufferLike>[],
            callback: WritevCallback,
        ): void;
        (
            fd: number,
            buffers: ArrayBufferView<ArrayBufferLike>[],
            position: number | null,
            callback: WritevCallback,
        ): void;
    }
    writevSync: (
        fd: number,
        buffers: ArrayBufferView<ArrayBufferLike>[],
        position?: number | null,
    ) => number
    fromJSON: (json: DirectoryJSON, cwd?: string) => Volume
    fromNestedJSON: (json: NestedDirectoryJSON, cwd?: string) => Volume

    Accessors

    Methods

    • Returns void

    • Parameters

      • Optionalpaths: PathLike | PathLike[]
      • Optionaljson: {}
      • OptionalisRelative: boolean
      • OptionalasBuffer: boolean

      Returns DirectoryJSON<string | null>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods