/
index.ts
146 lines (134 loc) · 3.32 KB
/
index.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
import { del, isVue2, reactive, set } from 'vue-demi'
type CacheKey = any
/**
* Custom memoize cache handler
*/
export interface UseMemoizeCache<Key, Value> {
/**
* Get value for key
*/
get(key: Key): Value | undefined
/**
* Set value for key
*/
set(key: Key, value: Value): void
/**
* Return flag if key exists
*/
has(key: Key): boolean
/**
* Delete value for key
*/
delete(key: Key): void
/**
* Clear cache
*/
clear(): void
}
/**
* Fallback for Vue 2 not able to make a reactive Map
*/
const getMapVue2Compat = <Value>(): UseMemoizeCache<CacheKey, Value> => {
const data: Record<CacheKey, Value> = reactive({})
return {
get: key => data[key],
set: (key, value) => set(data, key, value),
has: key => Object.prototype.hasOwnProperty.call(data, key),
delete: key => del(data, key),
clear: () => {
Object.keys(data).forEach((key) => {
del(data, key)
})
},
}
}
/**
* Memoized function
*/
export interface UseMemoizeReturn <Result, Args extends unknown[]> {
/**
* Get result from cache or call memoized function
*/
(...args: Args): Result
/**
* Call memoized function and update cache
*/
load(...args: Args): Result
/**
* Delete cache of given arguments
*/
delete(...args: Args): void
/**
* Clear cache
*/
clear(): void
/**
* Generate cache key for given arguments
*/
generateKey(...args: Args): CacheKey
/**
* Cache container
*/
cache: UseMemoizeCache<CacheKey, Result>
}
export interface UseMemoizeOptions<Result, Args extends unknown[]> {
getKey?: (...args: Args) => string
cache?: UseMemoizeCache<CacheKey, Result>
}
/**
* Reactive function result cache based on arguments
*/
export function useMemoize<Result, Args extends unknown[]>(
resolver: (...args: Args) => Result,
options?: UseMemoizeOptions<Result, Args>,
): UseMemoizeReturn<Result, Args> {
const initCache = (): UseMemoizeCache<CacheKey, Result> => {
if (options?.cache)
return reactive(options.cache)
// Use fallback for Vue 2 not able to make a reactive Map
if (isVue2)
return getMapVue2Compat<Result>()
return reactive(new Map<CacheKey, Result>())
}
const cache = initCache()
/**
* Generate key from args
*/
const generateKey = (...args: Args) => options?.getKey
? options.getKey(...args)
// Default key: Serialize args
: JSON.stringify(args)
/**
* Load data and save in cache
*/
const _loadData = (key: string, ...args: Args): Result => {
cache.set(key, resolver(...args))
return cache.get(key) as Result
}
const loadData = (...args: Args): Result => _loadData(generateKey(...args), ...args)
/**
* Delete key from cache
*/
const deleteData = (...args: Args): void => {
cache.delete(generateKey(...args))
}
/**
* Clear cached data
*/
const clearData = () => {
cache.clear()
}
const memoized: Partial<UseMemoizeReturn<Result, Args>> = (...args: Args): Result => {
// Get data from cache
const key = generateKey(...args)
if (cache.has(key))
return cache.get(key) as Result
return _loadData(key, ...args)
}
memoized.load = loadData
memoized.delete = deleteData
memoized.clear = clearData
memoized.generateKey = generateKey
memoized.cache = cache
return memoized as UseMemoizeReturn<Result, Args>
}