fs: update rm/rmdir validation messages

The validation code for the rm/rmdir functions treated the options as distinct parameters instead of the options properties that they are. This commit updates the validation to treat them like properties. PR-URL: #35565 Reviewed-By: Ben Coe <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Denys Otrishko <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Masashi Hirano <[email protected]>
nodejs · Oct 14, 2020 · 3a401b8 · 3a401b8
1 parent 937fa5d
commit 3a401b8
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 12 deletions.
diff --git a/lib/internal/fs/utils.js b/lib/internal/fs/utils.js
@@ -675,7 +675,7 @@ const defaultRmdirOptions = {
 const validateRmOptions = hideStackFrames((path, options, callback) => {
   try {
     options = validateRmdirOptions(options, defaultRmOptions);
-    validateBoolean(options.force, 'force');
+    validateBoolean(options.force, 'options.force');
   } catch (err) {
     return callback(err);
   }
@@ -703,7 +703,7 @@ const validateRmOptions = hideStackFrames((path, options, callback) => {
 
 const validateRmOptionsSync = hideStackFrames((path, options) => {
   options = validateRmdirOptions(options, defaultRmOptions);
-  validateBoolean(options.force, 'force');
+  validateBoolean(options.force, 'options.force');
 
   try {
     const stats = lazyLoadFs().statSync(path);
@@ -737,9 +737,9 @@ const validateRmdirOptions = hideStackFrames(
 
     options = { ...defaults, ...options };
 
-    validateBoolean(options.recursive, 'recursive');
-    validateInt32(options.retryDelay, 'retryDelay', 0);
-    validateUint32(options.maxRetries, 'maxRetries');
+    validateBoolean(options.recursive, 'options.recursive');
+    validateInt32(options.retryDelay, 'options.retryDelay', 0);
+    validateUint32(options.maxRetries, 'options.maxRetries');
 
     return options;
   });

diff --git a/test/parallel/test-fs-rm.js b/test/parallel/test-fs-rm.js
@@ -251,7 +251,7 @@ function removeAsync(dir) {
     }, {
       code: 'ERR_INVALID_ARG_TYPE',
       name: 'TypeError',
-      message: /^The "recursive" argument must be of type boolean\./
+      message: /^The "options\.recursive" property must be of type boolean\./
     });
   });
 
@@ -261,7 +261,7 @@ function removeAsync(dir) {
     }, {
       code: 'ERR_INVALID_ARG_TYPE',
       name: 'TypeError',
-      message: /^The "force" argument must be of type boolean\./
+      message: /^The "options\.force" property must be of type boolean\./
     });
   });
 
@@ -270,14 +270,14 @@ function removeAsync(dir) {
   }, {
     code: 'ERR_OUT_OF_RANGE',
     name: 'RangeError',
-    message: /^The value of "retryDelay" is out of range\./
+    message: /^The value of "options\.retryDelay" is out of range\./
   });
 
   assert.throws(() => {
     validateRmOptionsSync(filePath, { maxRetries: -1 });
   }, {
     code: 'ERR_OUT_OF_RANGE',
     name: 'RangeError',
-    message: /^The value of "maxRetries" is out of range\./
+    message: /^The value of "options\.maxRetries" is out of range\./
   });
 }
diff --git a/test/parallel/test-fs-rmdir-recursive.js b/test/parallel/test-fs-rmdir-recursive.js
@@ -191,7 +191,7 @@ function removeAsync(dir) {
     }, {
       code: 'ERR_INVALID_ARG_TYPE',
       name: 'TypeError',
-      message: /^The "recursive" argument must be of type boolean\./
+      message: /^The "options\.recursive" property must be of type boolean\./
     });
   });
 
@@ -200,14 +200,14 @@ function removeAsync(dir) {
   }, {
     code: 'ERR_OUT_OF_RANGE',
     name: 'RangeError',
-    message: /^The value of "retryDelay" is out of range\./
+    message: /^The value of "options\.retryDelay" is out of range\./
   });
 
   assert.throws(() => {
     validateRmdirOptions({ maxRetries: -1 });
   }, {
     code: 'ERR_OUT_OF_RANGE',
     name: 'RangeError',
-    message: /^The value of "maxRetries" is out of range\./
+    message: /^The value of "options\.maxRetries" is out of range\./
   });
 }