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

    Implemented by

    Index

    Properties

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