Update clear-caches.ts

typescript-eslint · Feb 17, 2023 · 9fe72ef · 9fe72ef
1 parent 34ef895
commit 9fe72ef
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/packages/typescript-estree/src/clear-caches.ts b/packages/typescript-estree/src/clear-caches.ts
@@ -5,7 +5,10 @@ import { clearGlobCache } from './parseSettings/resolveProjectList';
 
 /**
  * Clears all of the internal caches.
- * Generally you shouldn't need or want to use this
+ * Generally you shouldn't need or want to use this.
+ * Examples of intended uses:
+ * - In tests to reset parser state to keep tests isolated.
+ * - In custom lint tooling that iteratively lints one project at a time to prevent OOMs. 
  */
 export function clearCaches(): void {
   clearProgramCacheOriginal();