m-fs

Helper functions for node fs.

Installation

npm add m-fs

Usage

import * as mfs from 'm-fs';

API

readFileAsync

Calls fs.promises.readFile.

writeFileAsync

Calls fs.promises.writeFile. This method also makes ensure the target directory is created before writing the file.

statAsync

Calls fs.promises.stat.

statOrNullAsync

Like statAsync, but instead of throwing an error, it returns null in that case.

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']

mkdirp

Calls fs.promises.mkdir with { recursive: true }.