useMemoize

Category

Utilities

Export Size

242 B

Last Changed

3 hours ago

根据参数缓存函数结果并保持其响应性。它也可以用于异步函数，并会重用现有的 Promise 以避免同时获取相同的数据。

TIP

结果不会自动清除。如果你不再需要结果，请调用 clear()，或者使用自己的缓存机制来避免内存泄漏。

用法

TypeScript

import { useMemoize } from '@vueuse/core'

const getUser = useMemoize(
  async (userId: number): Promise<UserData> =>
    axios.get(`users/${userId}`).then(({ data }) => data),
)

const user1 = await getUser(1) // 请求 users/1
const user2 = await getUser(2) // 请求 users/2
// ...
const user1 = await getUser(1) // 从缓存中获取

// ...
const user1 = await getUser.load(1) // 请求 users/1

// ...
getUser.delete(1) // 删除用户 1 的缓存
getUser.clear() // 清除所有缓存

import { useMemoize } from '@vueuse/core'
const getUser = useMemoize(async (userId) =>
  axios.get(`users/${userId}`).then(({ data }) => data),
)
const user1 = await getUser(1) // 请求 users/1
const user2 = await getUser(2) // 请求 users/2
// ...
const user1 = await getUser(1) // 从缓存中获取
// ...
const user1 = await getUser.load(1) // 请求 users/1
// ...
getUser.delete(1) // 删除用户 1 的缓存
getUser.clear() // 清除所有缓存

与 computed 或 asyncComputed 结合使用以实现响应性：

const user1 = asyncComputed(() => getUser(1))
// ...
await getUser.load(1) // 也会更新 user1

解析缓存键

缓存的键由传递给函数的参数决定，默认使用 JSON.stringify 进行序列化。 这将允许相等的对象获得相同的缓存键。如果你想自定义键，可以传递 getKey

TypeScript

const getUser = useMemoize(
  async (userId: number, headers: AxiosRequestHeaders): Promise<UserData> =>
    axios.get(`users/${userId}`, { headers }).then(({ data }) => data),
  {
    // 仅使用 userId 来获取/设置缓存，忽略 headers
    getKey: (userId, headers) => userId,
  },
)

const getUser = useMemoize(
  async (userId, headers) =>
    axios.get(`users/${userId}`, { headers }).then(({ data }) => data),
  {
    // 仅使用 userId 来获取/设置缓存，忽略 headers
    getKey: (userId, headers) => userId,
  },
)

自定义缓存机制

默认情况下，结果缓存在 Map 中。你可以通过传递具有以下结构的 cache 选项来实现自己的缓存机制：

TypeScript

export interface MemoizeCache<Key, Value> {
  /**
   * 获取键对应的值
   */
  get: (key: Key) => Value | undefined
  /**
   * 设置键对应的值
   */
  set: (key: Key, value: Value) => void
  /**
   * 返回键是否存在的标志
   */
  has: (key: Key) => boolean
  /**
   * 删除键对应的值
   */
  delete: (key: Key) => void
  /**
   * 清除缓存
   */
  clear: () => void
}

export {}

Type Declarations

Show Type Declarations

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
}
/**
 * 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 | number
  cache?: UseMemoizeCache<CacheKey, Result>
}
/**
 * Reactive function result cache based on arguments
 */
export declare function useMemoize<Result, Args extends unknown[]>(
  resolver: (...args: Args) => Result,
  options?: UseMemoizeOptions<Result, Args>,
): UseMemoizeReturn<Result, Args>

Source

Source • Docs

Contributors

jorshen

Changelog

No recent changes