Make note about NodeJS.ErrnoException

2023-06-19 11:09:08 +01:00
parent 1f18cc3f2c
commit 96bb7058a2
1 changed files with 4 additions and 1 deletions
--- a/extensions/ql-vscode/src/pure/files.ts
+++ b/extensions/ql-vscode/src/pure/files.ts
@@ -109,7 +109,10 @@ export async function* walkDirectory(
 }

 /**
- * Error thrown from methods from the 'fs' module.
+ * Error thrown from methods from the `fs` module.
+ *
+ * In practice, any error matching this is likely an instance of `NodeJS.ErrnoException`.
+ * If desired in the future, we could model more fields or use `NodeJS.ErrnoException` directly.
 */
 export interface IOError {
  readonly code: string;