doc: add note about fs.close() about undefined behavior

Add notes to fs.close and fs.closeSync() about udnefined behavior. PR-URL: #30966 Refs: #30864 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]>
nodejs · Jan 14, 2020 · 42ccf22 · 42ccf22
1 parent d676c6c
commit 42ccf22
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/doc/api/fs.md b/doc/api/fs.md
@@ -1533,6 +1533,9 @@ changes:
 Asynchronous close(2). No arguments other than a possible exception are given
 to the completion callback.
 
+Calling `fs.close()` on any file descriptor (`fd`) that is currently in use
+through any other `fs` operation may lead to undefined behavior.
+
 ## `fs.closeSync(fd)`
 <!-- YAML
 added: v0.1.21
@@ -1542,6 +1545,9 @@ added: v0.1.21
 
 Synchronous close(2). Returns `undefined`.
 
+Calling `fs.closeSync()` on any file descriptor (`fd`) that is currently in use
+through any other `fs` operation may lead to undefined behavior.
+
 ## `fs.constants`
 
 * {Object}