KC's Workspace
    Preparing search index...
    interface FsSynchronousApi {
        accessSync: (path: PathLike, mode?: number) => void;
        appendFileSync: (
            id: TFileId,
            data: TData,
            options?: string | IAppendFileOptions,
        ) => void;
        chmodSync: (path: PathLike, mode: TMode) => void;
        chownSync: (path: PathLike, uid: number, gid: number) => void;
        closeSync: (fd: number) => void;
        copyFileSync: (src: PathLike, dest: PathLike, flags?: number) => void;
        cpSync: (
            src: string | URL,
            dest: string | URL,
            options?: ICpOptions,
        ) => void;
        existsSync: (path: PathLike) => boolean;
        fchmodSync: (fd: number, mode: TMode) => void;
        fchownSync: (fd: number, uid: number, gid: number) => void;
        fdatasyncSync: (fd: number) => void;
        fstatSync: {
            (fd: number, options: { bigint: false }): IStats<number>;
            (fd: number, options: { bigint: true }): IStats<bigint>;
            (fd: number): IStats<number>;
        };
        fsyncSync: (fd: number) => void;
        ftruncateSync: (fd: number, len?: number) => void;
        futimesSync: (fd: number, atime: TTime, mtime: TTime) => void;
        globSync: (pattern: string, options?: IGlobOptions) => string[];
        lchmodSync: (path: PathLike, mode: TMode) => void;
        lchownSync: (path: PathLike, uid: number, gid: number) => void;
        linkSync: (existingPath: PathLike, newPath: PathLike) => void;
        lstatSync: {
            (
                path: PathLike,
                options: { bigint: false; throwIfNoEntry: false },
            ): IStats<number> | undefined;
            (
                path: PathLike,
                options: { bigint: false; throwIfNoEntry?: true },
            ): IStats<number>;
            (
                path: PathLike,
                options: { bigint: true; throwIfNoEntry: false },
            ): IStats<bigint> | undefined;
            (
                path: PathLike,
                options: { bigint: true; throwIfNoEntry?: true },
            ): IStats<bigint>;
            (
                path: PathLike,
                options: { throwIfNoEntry: false },
            ): IStats<number> | undefined;
            (path: PathLike, options: { throwIfNoEntry?: true }): IStats<number>;
            (path: PathLike): IStats<number>;
        };
        lutimesSync: (
            path: PathLike,
            atime: string | number | Date,
            time: string | number | Date,
        ) => void;
        mkdirSync: {
            (
                path: PathLike,
                options: IMkdirOptions & { recursive: true },
            ): string | undefined;
            (
                path: PathLike,
                options?: TMode | IMkdirOptions & { recursive?: false },
            ): void;
            (path: PathLike, options?: IMkdirOptions | TMode): string | undefined;
        };
        mkdtempSync: (prefix: string, options?: IOptions) => TDataOut;
        opendirSync: (path: PathLike, options?: IOpendirOptions) => IDir;
        openSync: (path: PathLike, flags: TFlags, mode?: TMode) => number;
        readdirSync: (
            path: PathLike,
            options?: string | IReaddirOptions,
        ) => TDataOut[] | IDirent[];
        readFileSync: (
            file: TFileId,
            options?: string | IReadFileOptions,
        ) => TDataOut;
        readlinkSync: (path: PathLike, options?: IOptions) => TDataOut;
        readSync: (
            fd: number,
            buffer:
                | Buffer<ArrayBufferLike>
                | DataView<ArrayBufferLike>
                | ArrayBufferView<ArrayBufferLike>,
            offset: number,
            length: number,
            position: number,
        ) => number;
        readvSync: (
            fd: number,
            buffers: ArrayBufferView<ArrayBufferLike>[],
            position?: number | null,
        ) => number;
        realpathSync: (
            path: PathLike,
            options?: string | IRealpathOptions,
        ) => TDataOut;
        renameSync: (oldPath: PathLike, newPath: PathLike) => void;
        rmdirSync: (path: PathLike, options?: IRmdirOptions) => void;
        rmSync: (path: PathLike, options?: IRmOptions) => void;
        statfsSync: (path: PathLike, options?: IStafsOptions) => IStatFs;
        statSync: {
            (
                path: PathLike,
                options: { bigint: false; throwIfNoEntry: false },
            ): IStats<number> | undefined;
            (
                path: PathLike,
                options: { bigint: false; throwIfNoEntry?: true },
            ): IStats<number>;
            (
                path: PathLike,
                options: { bigint: true; throwIfNoEntry: false },
            ): IStats<bigint> | undefined;
            (
                path: PathLike,
                options: { bigint: true; throwIfNoEntry?: true },
            ): IStats<bigint>;
            (
                path: PathLike,
                options: { throwIfNoEntry: false },
            ): IStats<number> | undefined;
            (path: PathLike, options: { throwIfNoEntry?: true }): IStats<number>;
            (path: PathLike): IStats<number>;
        };
        symlinkSync: (target: PathLike, path: PathLike, type?: Type) => void;
        truncateSync: (id: TFileId, len?: number) => void;
        unlinkSync: (path: PathLike) => void;
        utimesSync: (path: PathLike, atime: TTime, mtime: TTime) => void;
        writeFileSync: (
            id: TFileId,
            data: TData,
            options?: IWriteFileOptions,
        ) => void;
        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;
        };
        writevSync: (
            fd: number,
            buffers: ArrayBufferView<ArrayBufferLike>[],
            position?: number | null,
        ) => number;
    }

    Implemented by

    Index

    Properties

    accessSync: (path: PathLike, mode?: number) => void
    appendFileSync: (
        id: TFileId,
        data: TData,
        options?: string | IAppendFileOptions,
    ) => void
    chmodSync: (path: PathLike, mode: TMode) => void
    chownSync: (path: PathLike, uid: number, gid: number) => void
    closeSync: (fd: number) => void
    copyFileSync: (src: PathLike, dest: PathLike, flags?: number) => void
    cpSync: (src: string | URL, dest: string | URL, options?: ICpOptions) => void
    existsSync: (path: PathLike) => boolean
    fchmodSync: (fd: number, mode: TMode) => void
    fchownSync: (fd: number, uid: number, gid: number) => void
    fdatasyncSync: (fd: number) => void
    fstatSync: {
        (fd: number, options: { bigint: false }): IStats<number>;
        (fd: number, options: { bigint: true }): IStats<bigint>;
        (fd: number): IStats<number>;
    }
    fsyncSync: (fd: number) => void
    ftruncateSync: (fd: number, len?: number) => void
    futimesSync: (fd: number, atime: TTime, mtime: TTime) => void
    globSync: (pattern: string, options?: IGlobOptions) => string[]
    lchmodSync: (path: PathLike, mode: TMode) => void
    lchownSync: (path: PathLike, uid: number, gid: number) => void
    linkSync: (existingPath: PathLike, newPath: PathLike) => void
    lstatSync: {
        (
            path: PathLike,
            options: { bigint: false; throwIfNoEntry: false },
        ): IStats<number> | undefined;
        (
            path: PathLike,
            options: { bigint: false; throwIfNoEntry?: true },
        ): IStats<number>;
        (
            path: PathLike,
            options: { bigint: true; throwIfNoEntry: false },
        ): IStats<bigint> | undefined;
        (
            path: PathLike,
            options: { bigint: true; throwIfNoEntry?: true },
        ): IStats<bigint>;
        (
            path: PathLike,
            options: { throwIfNoEntry: false },
        ): IStats<number> | undefined;
        (path: PathLike, options: { throwIfNoEntry?: true }): IStats<number>;
        (path: PathLike): IStats<number>;
    }
    lutimesSync: (
        path: PathLike,
        atime: string | number | Date,
        time: string | number | Date,
    ) => void
    mkdirSync: {
        (
            path: PathLike,
            options: IMkdirOptions & { recursive: true },
        ): string | undefined;
        (
            path: PathLike,
            options?: TMode | IMkdirOptions & { recursive?: false },
        ): void;
        (path: PathLike, options?: IMkdirOptions | TMode): string | undefined;
    }
    mkdtempSync: (prefix: string, options?: IOptions) => TDataOut
    opendirSync: (path: PathLike, options?: IOpendirOptions) => IDir
    openSync: (path: PathLike, flags: TFlags, mode?: TMode) => number
    readdirSync: (
        path: PathLike,
        options?: string | IReaddirOptions,
    ) => TDataOut[] | IDirent[]
    readFileSync: (file: TFileId, options?: string | IReadFileOptions) => TDataOut
    readlinkSync: (path: PathLike, options?: IOptions) => TDataOut
    readSync: (
        fd: number,
        buffer:
            | Buffer<ArrayBufferLike>
            | DataView<ArrayBufferLike>
            | ArrayBufferView<ArrayBufferLike>,
        offset: number,
        length: number,
        position: number,
    ) => number
    readvSync: (
        fd: number,
        buffers: ArrayBufferView<ArrayBufferLike>[],
        position?: number | null,
    ) => number
    realpathSync: (path: PathLike, options?: string | IRealpathOptions) => TDataOut
    renameSync: (oldPath: PathLike, newPath: PathLike) => void
    rmdirSync: (path: PathLike, options?: IRmdirOptions) => void
    rmSync: (path: PathLike, options?: IRmOptions) => void
    statfsSync: (path: PathLike, options?: IStafsOptions) => IStatFs
    statSync: {
        (
            path: PathLike,
            options: { bigint: false; throwIfNoEntry: false },
        ): IStats<number> | undefined;
        (
            path: PathLike,
            options: { bigint: false; throwIfNoEntry?: true },
        ): IStats<number>;
        (
            path: PathLike,
            options: { bigint: true; throwIfNoEntry: false },
        ): IStats<bigint> | undefined;
        (
            path: PathLike,
            options: { bigint: true; throwIfNoEntry?: true },
        ): IStats<bigint>;
        (
            path: PathLike,
            options: { throwIfNoEntry: false },
        ): IStats<number> | undefined;
        (path: PathLike, options: { throwIfNoEntry?: true }): IStats<number>;
        (path: PathLike): IStats<number>;
    }
    symlinkSync: (target: PathLike, path: PathLike, type?: Type) => void
    truncateSync: (id: TFileId, len?: number) => void
    unlinkSync: (path: PathLike) => void
    utimesSync: (path: PathLike, atime: TTime, mtime: TTime) => void
    writeFileSync: (id: TFileId, data: TData, options?: IWriteFileOptions) => void
    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;
    }
    writevSync: (
        fd: number,
        buffers: ArrayBufferView<ArrayBufferLike>[],
        position?: number | null,
    ) => number