Skip to content

Commit d1af6f2

Browse files
committed
fs: introduce dirent.parentPath
The goal is to replace `dirent.path` using a name that's less likely to create confusion. `dirent.path` value has not been stable, moving it to a different property name should avoid breaking some upgrading user expectations.
1 parent a70d9e5 commit d1af6f2

File tree

5 files changed

+22
-6
lines changed

5 files changed

+22
-6
lines changed

doc/api/fs.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -6638,6 +6638,19 @@ The file name that this {fs.Dirent} object refers to. The type of this
66386638
value is determined by the `options.encoding` passed to [`fs.readdir()`][] or
66396639
[`fs.readdirSync()`][].
66406640
6641+
#### `dirent.parentPath`
6642+
6643+
<!-- YAML
6644+
added:
6645+
- REPLACEME
6646+
-->
6647+
6648+
> Stability: 1 – Experimental
6649+
6650+
* {string}
6651+
6652+
The path to the parent directory of the file this {fs.Dirent} object refers to.
6653+
66416654
#### `dirent.path`
66426655
66436656
<!-- YAML
@@ -6648,7 +6661,7 @@ added:
66486661
66496662
* {string}
66506663
6651-
The base path that this {fs.Dirent} object refers to.
6664+
Alias for `dirent.parentPath`.
66526665
66536666
### Class: `fs.FSWatcher`
66546667

lib/fs.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1426,7 +1426,7 @@ function readdirSyncRecursive(basePath, options) {
14261426
const dirent = getDirent(path, readdirResult[0][i], readdirResult[1][i]);
14271427
ArrayPrototypePush(readdirResults, dirent);
14281428
if (dirent.isDirectory()) {
1429-
ArrayPrototypePush(pathsQueue, pathModule.join(dirent.path, dirent.name));
1429+
ArrayPrototypePush(pathsQueue, pathModule.join(dirent.parentPath, dirent.name));
14301430
}
14311431
}
14321432
} else {

lib/internal/fs/dir.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ class Dir {
161161
}
162162

163163
readSyncRecursive(dirent) {
164-
const path = pathModule.join(dirent.path, dirent.name);
164+
const path = pathModule.join(dirent.parentPath, dirent.name);
165165
const ctx = { path };
166166
const handle = dirBinding.opendir(
167167
pathModule.toNamespacedPath(path),

lib/internal/fs/utils.js

+1
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,7 @@ function assertEncoding(encoding) {
165165
class Dirent {
166166
constructor(name, type, path) {
167167
this.name = name;
168+
this.parentPath = path;
168169
this.path = path;
169170
this[kType] = type;
170171
}

test/parallel/test-fs-opendir.js

+5-3
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,11 @@ const invalidCallbackObj = {
4848
const entries = files.map(() => {
4949
const dirent = dir.readSync();
5050
assertDirent(dirent);
51-
return dirent.name;
52-
});
53-
assert.deepStrictEqual(files, entries.sort());
51+
return { name: dirent.name, path: dirent.path, dirname: dirent.parentPath, toString() { return dirent.name; } };
52+
}).sort();
53+
assert.deepStrictEqual(entries.map((d) => d.name), files);
54+
assert.deepStrictEqual(entries.map((d) => d.path), Array(entries.length).fill(testDir));
55+
assert.deepStrictEqual(entries.map((d) => d.parentPath), Array(entries.length).fill(testDir));
5456

5557
// dir.read should return null when no more entries exist
5658
assert.strictEqual(dir.readSync(), null);

0 commit comments

Comments
 (0)