directus

1
import { useEnv } from '@directus/env';
2
import type Keyv from 'keyv';
3
import type { MutationOptions } from '../types/items.js';
4

5
/**
6
 * Check whether cache should be cleared
7
 *
8
 * @param cache Cache instance
9
 * @param opts Mutation options
10
 * @param collection Collection name to check if cache purging should be ignored
11
 */
12
export function shouldClearCache(
13
	cache: Keyv<any> | null,
14
	opts?: MutationOptions,
15
	collection?: string,
16
): cache is Keyv<any> {
17
	const env = useEnv();
18

19
	if (env['CACHE_AUTO_PURGE']) {
20
		if (collection && (env['CACHE_AUTO_PURGE_IGNORE_LIST'] as string[]).includes(collection)) {
21
			return false;
22
		}
23

24
		if (cache && opts?.autoPurgeCache !== false) {
25
			return true;
26
		}
27
	}
28

29
	return false;
30
}
31