async-fs-wrapper

description

Async wrappers for node's filesystem module

usage

``typescript
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
* Parameters
* writeFile
* Parameters
* appendFile
* Parameters
* readdir
* Parameters
* copyFile
* Parameters
* copyAllFilesInDir
* Parameters
* mkdir
* Parameters
* rmdir
* Parameters
* access
* Parameters
* unlink
* Parameters

$3

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> Resolves to the content of the file

$3

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

$3

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

$3

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<string>> Array of filenames

$3

src/main/index.ts:111-112

Copy a file asynchronously

#### Parameters

* from (string | Buffer) The src file
* to (string | Buffer) The dest file

Returns Promise\ Resolves with true if the copy is successful

$3

src/main/index.ts:120-134

Copy all files in one directory to another directory

#### Parameters

* from (string | Buffer) Input directory
* to (string | Buffer) Output directory

Returns Promise\ Resolves when the op is complete

$3

src/main/index.ts:141-146

Create a directory

#### Parameters

* pointer (string | Buffer) Path to the directory to create
* opts any?

Returns Promise\ Resolves when the op is complete

$3

src/main/index.ts:153-157

Remove a directory

#### Parameters

* pointer (string | Buffer) Path to the directory to remove
* opts fs.RmDirOptions?

Returns Promise\ Resolves when the op is complete

$3

src/main/index.ts:165-166

Tests a user's permissions for the file or directory specified by pointer.

#### Parameters

* pointer (string | Buffer) Path to the file to test
* mode number? File access mode (optional, default 0)

Returns Promise\

$3

src/main/index.ts:173-174

Asynchronously removes a file or symbolic link.

#### Parameters

* pointer` Path Path to the file to remove

Returns Promise\