Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@nodelib/fs.macchiato

nodelib5.7kMIT3.0.0TypeScript support: included

A set of classes for easy testing of built-in structures of FS

NodeLib, fs, FileSystem, file system, mock, stat, dirent

readme

@nodelib/fs.macchiato

A set of classes for easy testing of built-in structures of FS.

Install

$ npm install @nodelib/fs.macchiato

Usage

import { Stats, StatsMode, Dirent, DirentType } from '@nodelib/fs.macchiato';

const stats = new Stats({ mode: StatsMode.File });
const dirent = new Dirent('file.txt', DirentType.File);

API

Stats

Creates a fake instance of fs.Stats. Can accept options to control parameter values.

const stats = new Stats({
    mode: StatsMode.File,
    ino: 3
});

Dirent

Creates a fake instance of fs.Dirent. Can accept options to control parameter values.

const dirent = new Dirent('file.txt', DirentType.Link);

Changelog

See the Releases section of our GitHub project for changelogs for each release version.

License

This software is released under the terms of the MIT license.