doc: clarify guide on testing internal errors

PR-URL: #42813 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Mohammed Keyvanzadeh <[email protected]> Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Akhil Marsonya <[email protected]>
nodejs · May 31, 2022 · 20acb48 · 20acb48
1 parent eca030d
commit 20acb48
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/doc/contributing/writing-tests.md b/doc/contributing/writing-tests.md
@@ -312,6 +312,18 @@ assert.throws(
 );
 ```
 
+In the case of internal errors, prefer checking only the `code` property:
+
+```js
+assert.throws(
+  () => {
+    throw new ERR_FS_FILE_TOO_LARGE(`${sizeKiB} Kb`);
+  },
+  { code: 'ERR_FS_FILE_TOO_LARGE' }
+  // Do not include message: /^File size ([0-9]+ Kb) is greater than 2 GiB$/
+);
+```
+
 ### Console output
 
 Output written by tests to stdout or stderr, such as with `console.log()` or