Async-fs-wrapper NPM

async-fs-wrapper

description

Async wrappers for node's filesystem module

usage

import { readdir, readFile } from 'async-fs-wrapper';

const fileContents = await readFile('./path/to/file.txt', { encoding: 'utf8' }); // get the content of a file

const filesNames = await readdir('./'); // list the files in a folder

console.log(fileNames); /* returns:
[
  '.babelrc',             '.codecov.yml',
  '.eslintrc.js',         '.git',
  '.github',              '.gitignore',
  '.nvmrc',               '.vscode',
  'CHANGELOG.md',         'README.md',
  'commitlint.config.js', 'coverage',
  'dist',                 'jest.config.js',
  'node_modules',         'package-lock.json',
  'package.json',         'prettier.config.js',
  'src',                  'tsconfig.json'
]
 */

api

readFile

src/main/index.ts:33-33

Reads a file asynchronously

Parameters

pointer (string | Buffer) Path to the file to be read
options ReadFileOptions (optional, default {})

Returns Promise [Buffer](https://nodejs.org/api/buffer.html) Resolves to the content of the file

writeFile

src/main/index.ts:55-58

Writes a file asynchronously

Parameters

pointer (string | Buffer) Path to the file to be written
content (string | Buffer | Uint8Array) Content to write to the file

Returns Promise\ Resolves with true if the write was successful

appendFile

src/main/index.ts:66-69

Appends to a file asynchronously

Parameters

pointer (string | Buffer) Path to the file to be written
content (string | Buffer | Uint8Array) Content to write to the file

Returns Promise\ Resolves with true if the write was successful

readdir

src/main/index.ts:89-89

Reads a directory asynchronously

Parameters

path (string | Buffer) The directory to list the contents of
options ReadDirOptions Options opject to pass to readdir (optional, default {})

Returns Promise [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> Array of filenames