diff --git a/packages/typescript-estree/src/clear-caches.ts b/packages/typescript-estree/src/clear-caches.ts index 89c1df9aade..1e7fd42d70b 100644 --- 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();