docs: update docs

sindresorhus · Mar 15, 2024 · 9a0188e · 9a0188e
1 parent a1da8b6
commit 9a0188e
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/index.d.ts b/index.d.ts
@@ -66,6 +66,8 @@ Clear the internal cache of locked ports.
 
 This can be useful when you want the results to be unaffected by previous calls.
 
+Please note that clearing the cache could cause race conditions.
+
 @example
 ```
 import getPort, {clearLockedPorts} from 'get-port';

diff --git a/readme.md b/readme.md
@@ -113,7 +113,11 @@ The last port of the range. Must be in the range `1024`...`65535` and must be gr
 
 ### clearLockedPorts()
 
-Clear the internal cache of locked ports when you want your results to be unaffected by previous calls.
+Clear the internal cache of locked ports.
+
+This can be useful when you want the results to be unaffected by previous calls.
+
+Please note that clearing the cache could cause race conditions.
 
 ## Beware