pwd-fs 2.4.2 → 3.1.4

package/lib/test/write.spec.js

@@ -3,131 +3,80 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const assert_1 = __importDefault(require("assert"));
-const path_1 = require("path");
-const mock_fs_1 = __importDefault(require("mock-fs"));
+const node_assert_1 = __importDefault(require("node:assert"));
+const node_fs_1 = __importDefault(require("node:fs"));
 const chance_1 = __importDefault(require("chance"));
-const src_1 = __importDefault(require("../src"));
+const expect_1 = require("expect");
+const __fmock_1 = require("./__fmock");
+const src_1 = require("../src");
 describe('write(src, data[, options])', () => {
+    const chance = new chance_1.default();
     beforeEach(() => {
-        const chance = new chance_1.default();
-        (0, mock_fs_1.default)({
-            'tmpdir': {
-                'binapp': chance.string(),
-                'libxbase': mock_fs_1.default.directory()
-            },
-            'flexapp': mock_fs_1.default.symlink({
-                path: 'tmpdir/binapp'
-            })
+        (0, __fmock_1.fmock)({
+            './tmpdir/tings.txt': {
+                type: 'file',
+                data: chance.string()
+            }
         });
     });
-    afterEach(mock_fs_1.default.restore);
+    afterEach(() => {
+        (0, __fmock_1.restore)('./tmpdir');
+    });
     it('Positive: Must write content to file', async () => {
-        const pfs = new src_1.default();
-        const chance = new chance_1.default();
-        const base = chance.guid();
-        const exists = await pfs.test(`./tmpdir/${base}`);
-        (0, assert_1.default)(exists === false);
         const payload = chance.paragraph();
-        await pfs.write(`./tmpdir/${base}`, payload);
-        const stats = await pfs.stat(`./tmpdir/${base}`);
-        (0, assert_1.default)(stats.size > 0);
+        const guid = chance.guid();
+        await src_1.pfs.write(`./tmpdir/${guid}.txt`, payload);
+        const { size } = node_fs_1.default.lstatSync(`./tmpdir/${guid}.txt`);
+        (0, node_assert_1.default)(payload.length === size);
     });
     it('Positive: Must rewrite content if file already exists', async () => {
-        const pfs = new src_1.default();
-        const chance = new chance_1.default();
         const payload = chance.paragraph();
-        await pfs.write('./tmpdir/binapp', payload);
-        const stats = await pfs.stat(`./tmpdir/binapp`);
-        (0, assert_1.default)(stats.size > 0);
-    });
-    it(`Positive: Must write content to file, when path is absolute`, async () => {
-        const pfs = new src_1.default();
-        const chance = new chance_1.default();
-        const payload = chance.paragraph();
-        const cwd = process.cwd();
-        await pfs.write(`${cwd}${path_1.sep}tmpdir${path_1.sep}binapp`, payload, {
-            resolve: false
-        });
-        const stats = await pfs.stat(`./tmpdir/binapp`);
-        (0, assert_1.default)(stats.size > 0);
+        await src_1.pfs.write('./tmpdir/tings.txt', payload);
+        const { size } = node_fs_1.default.lstatSync('./tmpdir/tings.txt');
+        (0, node_assert_1.default)(payload.length === size);
     });
     it('Negative: Throw if resource is directory', async () => {
-        const pfs = new src_1.default();
-        const chance = new chance_1.default();
-        try {
-            const payload = chance.paragraph();
-            await pfs.write('./tmpdir/libxbase', payload);
-        }
-        catch (err) {
-            (0, assert_1.default)(err.errno === -21);
-        }
+        const payload = chance.paragraph();
+        await (0, expect_1.expect)(async () => {
+            await src_1.pfs.write('./tmpdir', payload);
+        })
+            .rejects
+            .toThrow();
     });
     it(`Negative: Unexpected option 'flag' returns Error`, async () => {
-        const pfs = new src_1.default();
-        const chance = new chance_1.default();
-        try {
-            const payload = chance.paragraph();
-            await pfs.write('./tmpdir/binapp', payload, {
+        const payload = chance.paragraph();
+        await (0, expect_1.expect)(async () => {
+            await src_1.pfs.write('./tmpdir/tings.txt', payload, {
                 flag: 'r'
             });
-        }
-        catch (err) {
-            (0, assert_1.default)(err.errno === -9);
-        }
+        })
+            .rejects
+            .toThrow();
+    });
+    it('[sync] Positive: Write contents even to a non-existent file', () => {
+        const payload = chance.paragraph();
+        const guid = chance.guid();
+        src_1.pfs.write(`./tmpdir/${guid}.txt`, payload, {
+            sync: true
+        });
+        const content = node_fs_1.default.readFileSync(`./tmpdir/${guid}.txt`, 'utf8');
+        (0, node_assert_1.default)(payload === content);
     });
-    describe('sync mode', () => {
-        it('Positive: Must write content to file', async () => {
-            const pfs = new src_1.default();
-            const chance = new chance_1.default();
-            const base = chance.guid();
-            const exists = await pfs.test(`./tmpdir/${base}`);
-            (0, assert_1.default)(exists === false);
-            const payload = chance.paragraph();
-            pfs.write(`./tmpdir/${base}`, payload, {
+    it('[sync] Negative: Throw if resource is directory', () => {
+        const payload = chance.paragraph();
+        node_assert_1.default.throws(() => {
+            src_1.pfs.write('./tmpdir', payload, {
                 sync: true
             });
-            const stats = await pfs.stat(`./tmpdir/${base}`);
-            (0, assert_1.default)(stats.size > 0);
         });
-        it(`Positive: Must write content to file, when path is absolute`, async () => {
-            const pfs = new src_1.default();
-            const chance = new chance_1.default();
-            const payload = chance.paragraph();
-            const cwd = process.cwd();
-            pfs.write(`${cwd}${path_1.sep}tmpdir${path_1.sep}binapp`, payload, {
+    });
+    it(`[sync] Negative: Unexpected option 'flag' returns Error`, () => {
+        const payload = chance.paragraph();
+        node_assert_1.default.throws(() => {
+            src_1.pfs.write('./tmpdir/tings.txt', payload, {
                 sync: true,
-                resolve: false
+                flag: 'r'
             });
-            const stats = await pfs.stat(`./tmpdir/binapp`);
-            (0, assert_1.default)(stats.size > 0);
-        });
-        it('Negative: Throw if resource is directory', async () => {
-            const pfs = new src_1.default();
-            const chance = new chance_1.default();
-            try {
-                const payload = chance.paragraph();
-                pfs.write('./tmpdir/libxbase', payload, {
-                    sync: true
-                });
-            }
-            catch (err) {
-                (0, assert_1.default)(err.errno === -21);
-            }
-        });
-        it(`Negative: Unexpected option 'flag' returns Error`, async () => {
-            const pfs = new src_1.default();
-            const chance = new chance_1.default();
-            try {
-                const payload = chance.paragraph();
-                pfs.write('./tmpdir/binapp', payload, {
-                    sync: true,
-                    flag: 'r'
-                });
-            }
-            catch (err) {
-                (0, assert_1.default)(err.errno === -9);
-            }
         });
     });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pwd-fs",
-  "version": "2.4.2",
+  "version": "3.1.4",
   "description": "Extend the file system the capabilities of declaring the present working directory and recursive execution",
   "keywords": [
     "umask",
@@ -27,7 +27,7 @@
     "url": "https://github.com/woodger/pwd-fs.git"
   },
   "engines": {
-    "node": ">=8.12.0"
+    "node": ">=13.2.0"
   },
   "main": "./lib/src/index.js",
   "types": "./lib/src/index.d.ts",
@@ -36,14 +36,11 @@
     "test": "mocha ./lib/test"
   },
   "devDependencies": {
-    "@tsconfig/node16": "^1.0.3",
-    "@types/chance": "^1.1.1",
-    "@types/mocha": "^10.0.0",
-    "@types/mock-fs": "^4.13.0",
-    "@types/node": "^18.11.9",
-    "chance": "^1.1.9",
-    "mocha": "^10.1.0",
-    "mock-fs": "^5.2.0",
-    "typescript": "^4.8.4"
+    "@types/chance": "^1.1.6",
+    "@types/mocha": "^10.0.6",
+    "chance": "^1.1.11",
+    "expect": "^29.7.0",
+    "mocha": "^10.4.0",
+    "typescript": "^5.4.5"
   }
 }

package/readme.md

@@ -19,7 +19,7 @@ To improve reliability and maintainability the code is migrated to [TypeScript](
 To use `Powered File System` in your project, run:
 
 ```bash
-npm i pwd-fs
+npm install pwd-fs
 ```
 
 #### Table of Contents
@@ -63,19 +63,17 @@ This class implemented by following the [ECMAScript® 2018 Language Specificatio
 String form paths are interpreted as UTF-8 character sequences identifying the absolute or relative filename.
 
 ```ts
-import PoweredFileSystem from 'pwd-fs';
+import { pfs } from 'pwd-fs';
 
 /**
  * pfs.pwd === process.cwd()
  */
-
-const pfs = new PoweredFileSystem();
 ```
 
 Relative paths will be resolved relative to the current working directory as specified by `process.cwd()`:
 
 ```ts
-import PoweredFileSystem from 'pwd-fs';
+import { PoweredFileSystem } from 'pwd-fs';
 
 /**
  * pfs.pwd === `${process.cwd()}/foo/bar`
@@ -87,7 +85,7 @@ const pfs = new PoweredFileSystem('./foo/bar');
 Absolute paths:
 
 ```ts
-import PoweredFileSystem from 'pwd-fs';
+import { PoweredFileSystem } from 'pwd-fs';
 
 /**
  * pfs.pwd === __dirname
@@ -100,7 +98,6 @@ const pfs = new PoweredFileSystem(__dirname);
 
 - `src` <[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)> Absolute or relative path to the resource in the file system. Relative paths will be resolved relative to the present working directory as specified by `pfs.pwd`.
 - `options` <[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>
-  - `resolve` <[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)> Declaration whether relative paths will be resolved. **Default:** `true`.
   - `flag` <[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)> Is an optional string that specifies the accessibility checks to be performed. **Default:** `'e'`.
   - `sync` <[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)> Synchronous execution. **Default:** `false`.
 - returns: <[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)> Following successful read, the `Promise` is resolved with an value with a `boolean`.
@@ -126,7 +123,6 @@ Flag | Description
 
 - `src` <[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)> Absolute or relative path to the resource in the file system. Relative paths will be resolved relative to the present working directory as specified by `pfs.pwd`.
 - `options` <[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>
-  - `resolve` <[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)> Declaration whether relative paths will be resolved. **Default:** `true`.
   - `sync` <[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)> Synchronous execution. **Default:** `false`.
 - returns: <[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)> Following successful read, the `Promise` is resolved with an value with a `fs.Stats`.
 
@@ -137,17 +133,18 @@ These functions return information about a resource in the file system.
 - `src` <[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)> Absolute or relative path to the resource in the file system. Relative paths will be resolved relative to the present working directory as specified by `pfs.pwd`.
 - `mode` <[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)> Is a numeric `bitmask` created using a logical `OR`.
 - `options` <[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>
-  - `resolve` <[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)> Declaration whether relative paths will be resolved. **Default:** `true`.
   - `sync` <[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)> Synchronous execution. **Default:** `false`.
 - returns: <[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)> Following successful change, the `Promise` is resolved with an value with a `undefined`.
 
 Asynchronously changes the permissions of a file.
 
 ```ts
+import { bitmask } from 'pwd-fs';
+
 await pfs.chmod('./path', 0o750);
 const { mode } = await pfs.stat('./path');
 
-console.log(PoweredFileSystem.bitmask(mode) === 0o750); // true
+console.log(bitmask(mode) === 0o750); // true
 ```
 
 > **Caveats:** on Windows only the write permission can be changed, and the distinction among the permissions of group, owner or others is not implemented.
@@ -160,7 +157,6 @@ See manuals [chmod(2)](http://man7.org/linux/man-pages/man2/chmod.2.html)
 - `uid` <[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>
 - `gid` <[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>
 - `options` <[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>
-  - `resolve` <[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)> Declaration whether relative paths will be resolved. **Default:** `true`.
   - `sync` <[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)> Synchronous execution. **Default:** `false`.
 - returns: <[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)> Following successful change, the `Promise` is resolved with an value with a `undefined`.
 
@@ -172,7 +168,6 @@ See manuals [chown(2)](http://man7.org/linux/man-pages/man2/chown.2.html).
 - `src` <[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)> Absolute or relative path to the resource in the file system. Relative paths will be resolved relative to the present working directory as specified by `pfs.pwd`.
 - `use` <[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)> Absolute or relative path to the resource in the file system. If `use` exists, it will not be overwritten.
 - `options` <[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>
-  - `resolve` <[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)> Declaration whether relative paths will be resolved. **Default:** `true`.
   - `sync` <[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)> Synchronous execution. **Default:** `false`.
 - returns: <[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)> Following successful created link, the `Promise` is resolved with an value with a `undefined`.
 
@@ -192,7 +187,6 @@ See manuals [symlink(2)](http://man7.org/linux/man-pages/man2/symlink.2.html).
 - `src` <[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)> Absolute or relative path to the resource in the file system. Relative paths will be resolved relative to the present working directory as specified by `pfs.pwd`.
 - `dir` <[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)> Absolute or relative path to the directory to which the resource is to be copied.
 - `options` <[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>
-  - `resolve` <[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)> Declaration whether relative paths will be resolved. **Default:** `true`.
   - `umask` <[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)> Umask or file [mode creation mask](#mode-creation-mask) is a grouping of bits, each of which restricts how its corresponding permission is set for newly created files or directories. See manuals [umask(2)](http://man7.org/linux/man-pages/man2/umask.2.html). Not supported on Windows system. **Default:** `0o000`.
   - `sync` <[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)> Synchronous execution. **Default:** `false`.
 - returns: <[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)> Following successful copied, the `Promise` is resolved with an value with a `undefined`.
@@ -200,10 +194,12 @@ See manuals [symlink(2)](http://man7.org/linux/man-pages/man2/symlink.2.html).
 Asynchronously recursively copy a file or directory.
 
 ```ts
+import { bitmask } from 'pwd-fs';
+
 await pfs.copy('./path/file.txt', './dist');
 const { mode } = await pfs.stat('./dist/path/file.txt');
 
-console.log(PoweredFileSystem.bitmask(mode) === 0o666); // true
+console.log(bitmask(mode) === 0o666); // true
 ```
 
 #### pfs.rename(src, use[, options])
@@ -211,7 +207,6 @@ console.log(PoweredFileSystem.bitmask(mode) === 0o666); // true
 - `src` <[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)> Absolute or relative path to the resource in the file system. Relative paths will be resolved relative to the present working directory as specified by `pfs.pwd`.
 - `use` <[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)> Absolute or relative path to the resource in the file system.
 - `options` <[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>
-  - `resolve` <[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)> Declaration whether relative paths will be resolved. **Default:** `true`.
   - `sync` <[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)> Synchronous execution. **Default:** `false`.
 - returns: <[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)> Following successful renamed, the `Promise` is resolved with an value with a `undefined`.
 
@@ -225,7 +220,6 @@ await pfs.rename('./path/old_name.txt', './path/new_name.txt');
 
 - `src` <[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)> Absolute or relative path to the resource in the file system. Relative paths will be resolved relative to the present working directory as specified by `pfs.pwd`.
 - `options` <[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>
-  - `resolve` <[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)> Declaration whether relative paths will be resolved. **Default:** `true`.
   - `sync` <[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)> Synchronous execution. **Default:** `false`.
 - returns: <[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)> Following successful removed, the `Promise` is resolved with an value with a `undefined`.
 
@@ -235,7 +229,6 @@ Asynchronously recursively remove a file or directory. Will be `resolve` if the
 
 - `src` <[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)> Absolute or relative path to the resource in the file system. Relative paths will be resolved relative to the present working directory as specified by `pfs.pwd`.
 - `options` <[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>
-  - `resolve` <[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)> Declaration whether relative paths will be resolved. **Default:** `true`.
   - `encoding` <[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)> | <[null](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/null)> Is the expected [string encoding](#string-encoding). **Default:** `'utf8'`.
   - `flag` <[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)> See support of [file system flags](#file-system-flags). **Default:** `'r'`.
   - `sync` <[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)> Synchronous execution. **Default:** `false`.
@@ -253,7 +246,6 @@ console.log(content); // 'Lorem Ipsum...'
 - `src` <[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)> Absolute or relative path to the resource in the file system. Relative paths will be resolved relative to the present working directory as specified by `pfs.pwd`.
 - `data` <[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>
 - `options` <[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>
-  - `resolve` <[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)> Declaration whether relative paths will be resolved. **Default:** `true`.
   - `umask` <[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)> Umask or file [mode creation mask](#mode-creation-mask) is a grouping of bits, each of which restricts how its corresponding permission is set for newly created files or directories. See manuals [umask(2)](http://man7.org/linux/man-pages/man2/umask.2.html). Not supported on Windows system. **Default:** `0o000`.
   - `encoding` <[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)> Is the expected [string encoding](#string-encoding). **Default:** `'utf8'`.
   - `flag` <[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)> See support of [file system flags](#file-system-flags). **Default:** `'w'`.
@@ -275,7 +267,6 @@ await pfs.write('./file.txt', '... some text');
 - `src` <[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)> Absolute or relative path to the resource in the file system. Relative paths will be resolved relative to the present working directory as specified by `pfs.pwd`.
 - `data` <[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>
 - `options` <[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>
-  - `resolve` <[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)> Declaration whether relative paths will be resolved. **Default:** `true`.
   - `umask` <[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)> Umask or file [mode creation mask](#mode-creation-mask) is a grouping of bits, each of which restricts how its corresponding permission is set for newly created files or directories. See manuals [umask(2)](http://man7.org/linux/man-pages/man2/umask.2.html). Not supported on Windows system. **Default:** `0o000`.
   - `encoding` <[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)> Is the expected [string encoding](#string-encoding). **Default:** `'utf8'`.
   - `flag` <[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)> See support of [file system flags](#file-system-flags). **Default:** `'a'`.
@@ -298,7 +289,6 @@ await pfs.write('./file', 'some content', {
 
 - `dir` <[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)> Absolute or relative path to the directory you want to read.
 - `options` <[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>
-  - `resolve` <[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)> Declaration whether relative paths will be resolved. **Default:** `true`.
   - `encoding` <[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)> | <[null](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/null)> Is the expected [string encoding](#string-encoding). **Default:** `'utf8'`.
   - `sync` <[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)> Synchronous execution. **Default:** `false`.
 - returns: <[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)> Following successful write, the `Promise` is resolved with an value with a `Array` of the names of the files in the directory excluding `'.'` and `'..'`. If no encoding is specified <[null](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/null)>, the data is returned as a <[Buffer](https://nodejs.org/api/buffer.html)> object. Otherwise, the data will be a string.
@@ -314,7 +304,6 @@ console.log(list); // ["icons", "logo.svg"]
 
 - `dir` <[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)> Absolute or relative path to the directory you want to read.
 - `options` <[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>
-  - `resolve` <[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)> Declaration whether relative paths will be resolved. **Default:** `true`.
   - `umask` <[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)> Umask or file [mode creation mask](#mode-creation-mask) is a grouping of bits, each of which restricts how its corresponding permission is set for newly created files or directories. See manuals [umask(2)](http://man7.org/linux/man-pages/man2/umask.2.html). Not supported on Windows system. **Default:** `0o000`.
   - `encoding` <[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)> Is the expected [string encoding](#string-encoding). **Default:** `'utf8'`.
   - `sync` <[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)> Synchronous execution. **Default:** `false`.