Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: add shouldInvalidateCache option to cache utils #746

Merged
merged 6 commits into from
Jan 16, 2023
Merged

feat: add shouldInvalidateCache option to cache utils #746

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e4166b1
feat: add force refresh fn
yassilah Dec 10, 2022
da79e5b
fix: add h3event param
yassilah Dec 10, 2022
b3acb11
fix: conflicts with main
yassilah Jan 5, 2023
14f5de5
fix: rename refresh to shouldInvalidateCache
yassilah Jan 5, 2023
71e1ec8
docs: reference new shouldInvalidateCache option
yassilah Jan 5, 2023
ca1cbc3
Merge branch 'main' into pr/yassilah/746
pi0 Jan 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix: add h3event param
  • Loading branch information
@yassilah
yassilah committed Dec 10, 2022
commit da79e5ba468fcfe461357a4128efa7182392aba0
11 changes: 7 additions & 4 deletions src/runtime/cache.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ export interface CacheOptions<T = any> {
getKey?: (...args: any[]) => string;
transform?: (entry: CacheEntry<T>, ...args: any[]) => any;
validate?: (entry: CacheEntry<T>) => boolean;
refresh?: () => boolean;
refresh?: (...args: any[]) => boolean;
group?: string;
integrity?: any;
maxAge?: number;
Expand Down Expand Up @@ -54,7 +54,8 @@ export function defineCachedFunction<T = any>(

async function get(
key: string,
resolver: () => T | Promise<T>
resolver: () => T | Promise<T>,
refresh?: boolean
): Promise<CacheEntry<T>> {
// Use extension for key to avoid conflicting with parent namespace (foo/bar and foo/bar/baz)
const cacheKey = [opts.base, group, name, key + ".json"]
Expand All @@ -70,7 +71,7 @@ export function defineCachedFunction<T = any>(
}

const expired =
opts.refresh?.() ||
refresh ||
pi0 marked this conversation as resolved.
Show resolved Hide resolved
entry.integrity !== integrity ||
(ttl && Date.now() - (entry.mtime || 0) > ttl) ||
!validate(entry);
Expand Down Expand Up @@ -109,7 +110,8 @@ export function defineCachedFunction<T = any>(

return async (...args) => {
const key = (opts.getKey || getKey)(...args);
const entry = await get(key, () => fn(...args));
const refresh = opts.refresh?.(...args);
const entry = await get(key, () => fn(...args), refresh);
let value = entry.value;
if (opts.transform) {
value = (await opts.transform(entry, ...args)) || value;
Expand All @@ -135,6 +137,7 @@ export interface CachedEventHandlerOptions<T = any>
CacheOptions<ResponseCacheEntry<T>>,
"getKey" | "transform" | "validate"
> {
refresh?: (event: H3Event) => boolean;
headersOnly?: boolean;
}

Expand Down