async-fs-wrapper
v2.7.0
Published
Async wrappers for node's filesystem module
Downloads
1,881
Readme
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
Table of Contents
readFile
Reads a file asynchronously
Parameters
Returns Promise<Buffer> Resolves to the content of the file
writeFile
Writes a file asynchronously
Parameters
pointer
(string | Buffer) Path to the file to be writtencontent
(string | Buffer | Uint8Array) Content to write to the file
Returns Promise<void> Resolves with true if the write was successful
appendFile
Appends to a file asynchronously
Parameters
pointer
(string | Buffer) Path to the file to be writtencontent
(string | Buffer | Uint8Array) Content to write to the file
Returns Promise<void> Resolves with true if the write was successful
readdir
Reads a directory asynchronously
Parameters
path
(string | Buffer) The directory to list the contents ofoptions
ReadDirOptions Options opject to pass to readdir (optional, default{}
)
Returns Promise<Array<string>> Array of filenames
copyFile
Copy a file asynchronously
Parameters
Returns Promise<void> Resolves with true if the copy is successful
copyAllFilesInDir
Copy all files in one directory to another directory
Parameters
Returns Promise<void> Resolves when the op is complete
mkdir
Create a directory
Parameters
Returns Promise<void> Resolves when the op is complete
rmdir
Remove a directory
Parameters
Returns Promise<void> Resolves when the op is complete
access
Tests a user's permissions for the file or directory specified by pointer.
Parameters
pointer
(string | Buffer) Path to the file to testmode
number? File access mode (optional, default0
)
Returns Promise<void>
unlink
Asynchronously removes a file or symbolic link.
Parameters
pointer
Path Path to the file to remove
Returns Promise<void>