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

TypeScript definitions for mock-fs

import FileSystem = require("./lib/filesystem");
import File = require("./lib/file");
import Directory = require("./lib/directory");
import SymbolicLink = require("./lib/symlink");

export = mock;

/**
 * Swap out the fs bindings for a mock file system.
 *
 * _Note:_ Import this file _before_ any other modules that import the `fs`
 * module.
 *
 * @param config Mock file system configuration.
 * @param options Any filesystem options.
 * @param options.createCwd Create a directory for `process.cwd()` (defaults to
 *                          `true`).
 * @param options.createTmp Create a directory for `os.tmpdir()` (defaults to
 *                          `true`).
 */
declare function mock(config?: FileSystem.DirectoryItems, options?: FileSystem.Options): void;

declare namespace mock {
    /**
     * Temporarily bypass the mocked file system and load directly from the real file system.
     *
     * @example
     * const filePath = '/path/file.json';
     * const data = mock.bypass(() => fs.readFileSync(filePath, 'utf-8'));
     */
    function bypass<T>(fn: () => T): T;

    /**
     * Load a real file/folder into the mock file system.
     */
    function load(path: string, options?: FileSystem.LoaderOptions): FileSystem.DirectoryItem;

    /**
     * Get hold of the mocked filesystem's 'root'
     * If fs hasn't currently been replaced, this will return an empty object
     */
    function getMockRoot(): Directory | {};

    /**
     * Restore the fs bindings for the real file system.
     */
    function restore(): void;

    /**
     * Create a file factory.
     */
    function file(config?: FileSystem.FileOptions): () => File;
    /**
     * Create a directory factory.
     */
    function directory(config?: FileSystem.DirectoryOptions): () => Directory;
    /**
     * Create a symbolic link factory.
     */
    function symlink(config: FileSystem.SymlinkOptions): () => SymbolicLink;
}