memfs/lib/node/types/FsCallbackApi.d.ts

In-memory file-system with Node's fs API.

import type * as misc from './misc';
import type * as opts from './options';
export interface FsCallbackApi {
    access: {
        (path: misc.PathLike, callback: misc.TCallback<void>): void;
        (path: misc.PathLike, mode: number, callback: misc.TCallback<void>): void;
    };
    appendFile: {
        (id: misc.TFileId, data: misc.TData, callback: misc.TCallback<void>): void;
        (id: misc.TFileId, data: misc.TData, options: opts.IAppendFileOptions | string, callback: misc.TCallback<void>): void;
    };
    chmod: (path: misc.PathLike, mode: misc.TMode, callback: misc.TCallback<void>) => void;
    chown: (path: misc.PathLike, uid: number, gid: number, callback: misc.TCallback<void>) => void;
    close: (fd: number, callback: misc.TCallback<void>) => void;
    copyFile: {
        (src: misc.PathLike, dest: misc.PathLike, callback: misc.TCallback<void>): void;
        (src: misc.PathLike, dest: misc.PathLike, flags: misc.TFlagsCopy, callback: misc.TCallback<void>): void;
    };
    cp: {
        (src: string | URL, dest: string | URL, callback: misc.TCallback<void>): void;
        (src: string | URL, dest: string | URL, options: opts.ICpOptions, callback: misc.TCallback<void>): void;
    };
    createReadStream: (path: misc.PathLike, options?: opts.IReadStreamOptions | string) => misc.IReadStream;
    createWriteStream: (path: misc.PathLike, options?: opts.IWriteStreamOptions | string) => misc.IWriteStream;
    exists: (path: misc.PathLike, callback: (exists: boolean) => void) => void;
    fchmod: (fd: number, mode: misc.TMode, callback: misc.TCallback<void>) => void;
    fchown: (fd: number, uid: number, gid: number, callback: misc.TCallback<void>) => void;
    fdatasync: (fd: number, callback: misc.TCallback<void>) => void;
    fsync: (fd: number, callback: misc.TCallback<void>) => void;
    fstat: {
        (fd: number, callback: misc.TCallback<misc.IStats>): void;
        (fd: number, options: opts.IFStatOptions, callback: misc.TCallback<misc.IStats>): void;
    };
    ftruncate: {
        (fd: number, callback: misc.TCallback<void>): void;
        (fd: number, len: number, callback: misc.TCallback<void>): void;
    };
    futimes: (fd: number, atime: misc.TTime, mtime: misc.TTime, callback: misc.TCallback<void>) => void;
    glob: {
        (pattern: string, callback: misc.TCallback<string[]>): void;
        (pattern: string, options: opts.IGlobOptions, callback: misc.TCallback<string[]>): void;
    };
    lchmod: (path: misc.PathLike, mode: misc.TMode, callback: misc.TCallback<void>) => void;
    lchown: (path: misc.PathLike, uid: number, gid: number, callback: misc.TCallback<void>) => void;
    lutimes: (path: misc.PathLike, atime: number | string | Date, mtime: number | string | Date, callback: misc.TCallback<void>) => void;
    link: (existingPath: misc.PathLike, newPath: misc.PathLike, callback: misc.TCallback<void>) => void;
    lstat: {
        (path: misc.PathLike, callback: misc.TCallback<misc.IStats>): void;
        (path: misc.PathLike, options: opts.IStatOptions, callback: misc.TCallback<misc.IStats>): void;
    };
    mkdir: {
        (path: misc.PathLike, callback: misc.TCallback<void>): void;
        (path: misc.PathLike, mode: misc.TMode | (opts.IMkdirOptions & {
            recursive?: false;
        }), callback: misc.TCallback<void>): void;
        (path: misc.PathLike, mode: opts.IMkdirOptions & {
            recursive: true;
        }, callback: misc.TCallback<string>): void;
        (path: misc.PathLike, mode: misc.TMode | opts.IMkdirOptions, callback: misc.TCallback<string>): void;
    };
    mkdtemp: {
        (prefix: string, callback: misc.TCallback<string>): void;
        (prefix: string, options: opts.IOptions, callback: misc.TCallback<string>): void;
    };
    open: {
        (path: misc.PathLike, flags: misc.TFlags, callback: misc.TCallback<number>): void;
        (path: misc.PathLike, flags: misc.TFlags, mode: misc.TMode, callback: misc.TCallback<number>): void;
    };
    openAsBlob: (path: misc.PathLike, options?: opts.IOpenAsBlobOptions) => Promise<Blob>;
    opendir: (path: misc.PathLike, options: opts.IOpendirOptions, callback: misc.TCallback<misc.IDir>) => void;
    read: (fd: number, buffer: Buffer | ArrayBufferView | DataView, offset: number, length: number, position: number, callback: (err?: Error | null, bytesRead?: number, buffer?: Buffer | ArrayBufferView | DataView) => void) => void;
    readdir: {
        (path: misc.PathLike, callback: misc.TCallback<misc.TDataOut[] | misc.IDirent[]>): void;
        (path: misc.PathLike, options: opts.IReaddirOptions | string, callback: misc.TCallback<misc.TDataOut[] | misc.IDirent[]>): void;
    };
    readFile: {
        (id: misc.TFileId, callback: misc.TCallback<misc.TDataOut>): void;
        (id: misc.TFileId, options: opts.IReadFileOptions | string, callback: misc.TCallback<misc.TDataOut>): void;
    };
    readlink: {
        (path: misc.PathLike, callback: misc.TCallback<misc.TDataOut>): void;
        (path: misc.PathLike, options: opts.IOptions, callback: misc.TCallback<misc.TDataOut>): void;
    };
    readv: {
        (fd: number, buffers: ArrayBufferView[], callback: misc.TCallback2<number, ArrayBufferView[]>): void;
        (fd: number, buffers: ArrayBufferView[], position: number | null, callback: misc.TCallback2<number, ArrayBufferView[]>): void;
    };
    realpath: {
        (path: misc.PathLike, callback: misc.TCallback<misc.TDataOut>): void;
        (path: misc.PathLike, options: opts.IRealpathOptions | string, callback: misc.TCallback<misc.TDataOut>): void;
    };
    rename: (oldPath: misc.PathLike, newPath: misc.PathLike, callback: misc.TCallback<void>) => void;
    rmdir: {
        (path: misc.PathLike, callback: misc.TCallback<void>): void;
        (path: misc.PathLike, options: opts.IRmdirOptions, callback: misc.TCallback<void>): void;
    };
    rm: {
        (path: misc.PathLike, callback: misc.TCallback<void>): void;
        (path: misc.PathLike, options: opts.IRmOptions, callback: misc.TCallback<void>): void;
    };
    stat: {
        (path: misc.PathLike, callback: misc.TCallback<misc.IStats>): void;
        (path: misc.PathLike, options: opts.IStatOptions, callback: misc.TCallback<misc.IStats>): void;
    };
    statfs: {
        (path: misc.PathLike, callback: misc.TCallback<misc.IStatFs>): void;
        (path: misc.PathLike, options: opts.IStatOptions, callback: misc.TCallback<misc.IStatFs>): void;
    };
    symlink: {
        (target: misc.PathLike, path: misc.PathLike, callback: misc.TCallback<void>): void;
        (target: misc.PathLike, path: misc.PathLike, type: misc.symlink.Type, callback: misc.TCallback<void>): void;
    };
    truncate: {
        (id: misc.PathLike, callback: misc.TCallback<void>): void;
        (id: misc.PathLike, len: number, callback: misc.TCallback<void>): void;
    };
    unlink: (path: misc.PathLike, callback: misc.TCallback<void>) => void;
    unwatchFile: (path: misc.PathLike, listener?: (curr: misc.IStats, prev: misc.IStats) => void) => void;
    utimes: (path: misc.PathLike, atime: misc.TTime, mtime: misc.TTime, callback: misc.TCallback<void>) => void;
    watch: (path: misc.PathLike, options?: opts.IWatchOptions | string, listener?: (eventType: string, filename: string) => void) => misc.IFSWatcher;
    watchFile: {
        (path: misc.PathLike, listener: (curr: misc.IStats, prev: misc.IStats) => void): misc.IStatWatcher;
        (path: misc.PathLike, options: opts.IWatchFileOptions, listener: (curr: misc.IStats, prev: misc.IStats) => void): misc.IStatWatcher;
    };
    write: {
        (fd: number, buffer: Buffer | ArrayBufferView | DataView, callback: (...args: any[]) => void): void;
        (fd: number, buffer: Buffer | ArrayBufferView | DataView, offset: number, callback: (...args: any[]) => void): void;
        (fd: number, buffer: Buffer | ArrayBufferView | DataView, offset: number, length: number, callback: (...args: any[]) => void): void;
        (fd: number, buffer: Buffer | ArrayBufferView | DataView, offset: number, length: number, position: number, callback: (...args: any[]) => void): void;
        (fd: number, str: string, callback: (...args: any[]) => void): void;
        (fd: number, str: string, position: number, callback: (...args: any[]) => void): void;
        (fd: number, str: string, position: number, encoding: BufferEncoding, callback: (...args: any[]) => void): void;
    };
    writeFile: {
        (id: misc.TFileId, data: misc.TData, callback: misc.TCallback<void>): void;
        (id: misc.TFileId, data: misc.TData, options: opts.IWriteFileOptions | string, callback: misc.TCallback<void>): void;
    };
    writev: {
        (fd: number, buffers: ArrayBufferView[], callback: WritevCallback): void;
        (fd: number, buffers: ArrayBufferView[], position: number | null, callback: WritevCallback): void;
    };
}
export type WritevCallback = (err: Error | null, bytesWritten?: number, buffers?: ArrayBufferView[]) => void;