m-fs

Helper functions for node fs.

Installation

yarn add m-fs

Usage

import * as mfs from 'm-fs';

API

readFileAsync

fs.readFile in a Promise.

nodeWriteFileAsync

fs.writeFile in a Promise. Consider using writeFileAsync instead as fs.writeFile errors when it writes to a non-existent directory.

writeFileAsync

Unlike nodeWriteFileAsync, this method makes ensure the target directory is created before writing the file.

statAsync

fs.stat in a Promise.

statOrNullAsync

Like statAsync, but returns null on error.

pathExists, dirExists, fileExists

Returns true if the given path/directory/file exists.

subPaths, subDirs, subFiles

await subPaths('./data/docs');
// ['backup', 'resume.pdf', 'readme.md']

await subPathsWithType('./data/docs');
// [{ path: 'backup', isFile: false }, { path: 'resume.pdf', isFile: true }, { path: 'readme.md', isFile: true }]

await subDirs('./data/docs');
// ['backup']

await subFiles('./data/docs');
// ['resume.pdf', 'readme.md']