xdash API Reference v0.5.14

---

xdash API Reference / cacheFunc

Function: cacheFunc()

cacheFunc<T, Args>(fn, options?): (...args) => Promise<T>

Defined in: src/cache.ts:50

Caches the result of a function

Type Parameters

T

T

Args

Args extends readonly unknown[]

Parameters

fn

(...args) => Promise<T>

function to cache

options?

CacheOptions

cache options

Returns

a function that caches the result of the input function

(...args): Promise<T>

Parameters

args

...Args

Returns

Promise<T>

Examples

const cachedFunc = cacheFunc(async () => {
 return 'hello'
}, { ttl: 1000 })

console.log(await cachedFunc()) // 'hello'
console.log(await cachedFunc()) // 'hello'

const invalidator = new Invalidator()
const cachedFunc = cacheFunc(async () => {
return 'hello'
}, { ttl: 1000, invalidator })

console.log(await cachedFunc()) // 'hello'
invalidator.invalidate()
console.log(await cachedFunc()) // 'hello'

class Example {
 const fn = cacheFunc(bindSelf(this)._fn)
 async _fn() {
    return 'hello'
 }
}