fake-node 0.3.0 → 0.4.0

package/lib/_fs.d.ts

@@ -0,0 +1,254 @@
+import { Buffer, type BufferEncoding } from './buffer';
+export declare const constants: {
+    F_OK: number;
+    X_OK: number;
+    W_OK: number;
+    R_OK: number;
+    COPYFILE_EXCL: number;
+    COPYFILE_FICLONE: number;
+    COPYFILE_FICLONE_FORCE: number;
+    O_RDONLY: number;
+    O_WRONLY: number;
+    O_RDWR: number;
+    O_CREAT: number;
+    O_EXCL: number;
+    O_NOCTTY: number;
+    O_TRUNC: number;
+    O_APPEND: number;
+    O_DIRECTORY: number;
+    O_NOATIME: number;
+    O_NOFOLLOW: number;
+    O_SYNC: number;
+    O_DSYNC: number;
+    O_SYMLINK: number;
+    O_DIRECT: number;
+    O_NONBLOCK: number;
+    UV_FS_O_FILEMAP: number;
+    S_IMFT: number;
+    S_IFREG: number;
+    S_IFDIR: number;
+    S_IFCHR: number;
+    S_IFBLK: number;
+    S_IFIFO: number;
+    S_IFLNK: number;
+    S_IFSOCK: number;
+    S_IRWXU: number;
+    S_IRUSR: number;
+    S_IWUSR: number;
+    S_IXUSR: number;
+    S_IRWXG: number;
+    S_IRGRP: number;
+    S_IWGRP: number;
+    S_IXGRP: number;
+    S_IRWXO: number;
+    S_IROTH: number;
+    S_IWOTH: number;
+    S_IXOTH: number;
+};
+export declare function normalize(path: string): string;
+export declare let cwdGetter: () => string;
+export declare let uidGetter: () => number;
+export declare let gidGetter: () => number;
+export declare function setCwdGetter(newGetter: () => string): void;
+export declare function setUidGetter(newGetter: () => number): void;
+export declare function setGidGetter(newGetter: () => number): void;
+export declare function resolve(...paths: string[]): string;
+export type PathArg = string | URL | Buffer;
+export declare function parsePathArg(arg: PathArg): string;
+declare const flags: {
+    a: number;
+    ax: number;
+    'a+': number;
+    'ax+': number;
+    as: number;
+    'as+': number;
+    r: number;
+    rs: number;
+    'r+': number;
+    'rs+': number;
+    w: number;
+    wx: number;
+    'w+': number;
+    'wx+': number;
+};
+export type Flag = number | keyof typeof flags;
+export declare function parseFlag(flag: Flag): number;
+export type TimeArg = number | string | bigint | Date;
+export declare function parseTimeArg(time: TimeArg): bigint;
+type TypedArray = Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array | BigInt64Array | BigUint64Array;
+export type DataArg = string | TypedArray | DataView | Iterable<any>;
+export declare function parseDataArg(data: DataArg, encoding?: BufferEncoding): Uint8Array;
+export type ModeArg = string | number;
+export declare function parseModeArg(mode: ModeArg): number;
+declare abstract class BaseStats {
+    abstract mode: number | bigint;
+    isBlockDevice(): boolean;
+    isCharacterDevice(): boolean;
+    isDirectory(): boolean;
+    isFIFO(): boolean;
+    isFile(): boolean;
+    isSocket(): boolean;
+    isSymbolicLink(): boolean;
+}
+export declare class Stats extends BaseStats {
+    dev: number;
+    ino: number;
+    mode: number;
+    nlink: number;
+    uid: number;
+    gid: number;
+    rdev: number;
+    size: number;
+    blksize: number;
+    blocks: number;
+    atimeMs: number;
+    mtimeMs: number;
+    ctimeMs: number;
+    birthtimeMs: number;
+    atime: Date;
+    mtime: Date;
+    ctime: Date;
+    birthtime: Date;
+}
+export declare class BigIntStats extends BaseStats {
+    dev: bigint;
+    ino: bigint;
+    mode: bigint;
+    nlink: bigint;
+    uid: bigint;
+    gid: bigint;
+    rdev: bigint;
+    size: bigint;
+    blksize: bigint;
+    blocks: bigint;
+    atimeMs: bigint;
+    mtimeMs: bigint;
+    ctimeMs: bigint;
+    birthtimeMs: bigint;
+    atimeNs: bigint;
+    mtimeNs: bigint;
+    ctimeNs: bigint;
+    birthtimeNs: bigint;
+    atime: Date;
+    mtime: Date;
+    ctime: Date;
+    birthtime: Date;
+}
+export declare class StatFs {
+    bavail: number;
+    bfree: number;
+    blocks: number;
+    bsize: number;
+    ffree: number;
+    files: number;
+    type: number;
+}
+export declare class BigIntStatFs {
+    bavail: bigint;
+    bfree: bigint;
+    blocks: bigint;
+    bsize: bigint;
+    ffree: bigint;
+    files: bigint;
+    type: bigint;
+}
+export type ExportFormatVersion = 1;
+export declare const currentExportFormatVersion: ExportFormatVersion;
+export interface FileParams {
+    mode?: number;
+    uid: number;
+    gid: number;
+}
+export interface FileMetadata {
+    mode: number;
+    uid: number;
+    gid: number;
+    size: number;
+    birthtime: bigint;
+    atime: bigint;
+    mtime: bigint;
+    ctime: bigint;
+}
+export declare class FileObject implements FileMetadata {
+    mode: number;
+    uid: number;
+    gid: number;
+    birthtime: bigint;
+    atime: bigint;
+    mtime: bigint;
+    ctime: bigint;
+    rdev: number;
+    constructor({ mode, uid, gid }: FileParams);
+    setAtime(): void;
+    setMtime(): void;
+    setCtime(): void;
+    access(mode?: ModeArg): void;
+    chmod(mode: string | number): void;
+    chown(uid: number, gid: number): void;
+    cp(): FileObject;
+    cpr(): FileObject;
+    get size(): number;
+    utimes(atime: TimeArg, mtime: TimeArg): void;
+    stat(bigint?: false): Stats;
+    stat(bigint: true): BigIntStats;
+    _export(): Uint8Array;
+    static _import(data: Uint8Array, version?: ExportFormatVersion): FileMetadata;
+    export(): Uint8Array;
+}
+export declare class RegularFile extends FileObject {
+    data: Uint8Array;
+    constructor(data: DataArg, { mode, encoding, ...params }: FileParams & {
+        encoding?: BufferEncoding;
+    });
+    cp(): RegularFile;
+    read(encoding?: BufferEncoding, start?: number, length?: number): string;
+    read(encoding: 'uint8array', start?: number, length?: number): Uint8Array;
+    read(encoding: 'buffer', start?: number, length?: number): Buffer;
+    write(data: string, position?: number, encoding?: BufferEncoding): void;
+    write(data: TypedArray | DataView | Iterable<any>, offset?: number, length?: number): void;
+    append(data: DataArg, encoding?: BufferEncoding): void;
+    get size(): number;
+    export(): Uint8Array;
+    static import(data: Uint8Array, version?: ExportFormatVersion): RegularFile;
+}
+export declare class Directory extends FileObject {
+    files: Map<string, FileObject>;
+    constructor(files: Map<string, FileObject>, { mode, ...params }: FileParams);
+    constructor(files: {
+        [key: string]: FileObject;
+    }, { mode, ...params }: FileParams);
+    constructor(files: MapIterator<[string, FileObject]>, { mode, ...params }: FileParams);
+    cp(): Directory;
+    cpr(): Directory;
+    get size(): number;
+    get recursiveSize(): number;
+    get(path: PathArg): FileObject;
+    getRegular(path: PathArg): RegularFile;
+    getDir(path: PathArg): Directory;
+    lget(path: PathArg): FileObject;
+    exists(path: PathArg): boolean;
+    link(path: PathArg, file: FileObject): void;
+    unlink(path: PathArg): FileObject;
+    symlink(target: PathArg, path: PathArg): void;
+    mkdir(path: PathArg, recursive?: boolean, mode?: ModeArg): Directory;
+    readFrom(path: PathArg, encoding?: BufferEncoding, start?: number, length?: number): string;
+    readFrom(path: PathArg, encoding: 'uint8array', start?: number, length?: number): Uint8Array;
+    readFrom(path: PathArg, encoding: 'buffer', start?: number, length?: number): Buffer;
+    writeTo(path: PathArg, data: string, position?: number, encoding?: BufferEncoding): void;
+    writeTo(path: PathArg, data: TypedArray | DataView | Iterable<any>, offset?: number, length?: number): void;
+    export(): Uint8Array;
+    static import(data: Uint8Array, version?: ExportFormatVersion): Directory;
+}
+export declare class FileSystem extends Directory {
+    fileDescriptors: (FileObject | null)[];
+    constructor(files?: Map<string, FileObject>);
+    getfd(fd: number): FileObject;
+    getfdRegular(fd: number): RegularFile;
+    open(path: PathArg, flags: Flag, mode?: ModeArg): number;
+    statfs(bigint?: false): StatFs;
+    statfs(bigint: true): BigIntStatFs;
+    fsExport(): Uint8Array;
+    static fsImport(data: Uint8Array): FileSystem;
+}
+export declare const DEFAULT_FILES: Map<any, any>;
+export {};