DefinitelyTyped/types/mock-fs/index.d.ts

// Type definitions for mock-fs 3.6.0
// Project: https://github.com/tschaub/mock-fs
// Definitions by: Wim Looman <https://github.com/Nemo157>, Qubo <https://github.com/tkqubo>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/// <reference types="node" />


import nodefs = require("fs");

declare function mock(config?: mock.Config, options?: mock.Options): void;

declare namespace mock {
    function file(config: FileConfig): File;
    function directory(config: DirectoryConfig): Directory;
    function symlink(config: SymlinkConfig): Symlink;

    function restore(): void;

    function fs(config?: Config, options?: Options): typeof nodefs;

    interface Config {
        [path: string]: string | Buffer | File | Directory | Symlink | Config;
    }

    interface Options {
        createCwd?: boolean;
        createTmp?: boolean;
    }

    interface CommonConfig {
        mode?: number;
        uid?: number;
        git?: number;
        atime?: Date;
        ctime?: Date;
        mtime?: Date;
        birthtime?: Date;
    }

    interface FileConfig extends CommonConfig {
        content: string | Buffer;
    }
    interface DirectoryConfig extends CommonConfig {
        items: Config;
    }
    interface SymlinkConfig extends CommonConfig {
        path: string;
    }

    class File { private _file: any; }
    class Directory { private _directory: any; }
    class Symlink { private _symlink: any; }
}

export = mock;