useMemory

类别

Browser

导出体积

538 B

上次更改

2 months ago

响应式内存信息。

示例

源码 playground (beta)

你的浏览器不支持性能内存 API

使用方法

import { useMemory
 } from '@vueuse/core'

const { isSupported
, memory
 } = useMemory
()

类型声明

/**
 * Performance.memory
 *
 * @see https://developer.mozilla.org/en-US/docs/Web/API/Performance/memory
 */
export interface MemoryInfo {
  /**
   * 上下文可用的堆的最大大小（以字节为单位）。
   */
  readonly jsHeapSizeLimit
: number
  /**
   * 分配的堆的总大小（以字节为单位）。
   */
  readonly totalJSHeapSize
: number
  /**
   * 当前活动的 JS 堆段大小（以字节为单位）。
   */
  readonly usedJSHeapSize
: number
  [Symbol
.toStringTag
]: "MemoryInfo"
}
export interface UseMemoryOptions extends UseIntervalFnOptions {
  interval
?: number
}
/**
 * 响应式内存信息
 *
 * @see https://vueuse.org/useMemory
 * @param options
 *
 * @__NO_SIDE_EFFECTS__
 */
export declare function useMemory
(options
?: UseMemoryOptions): {
  isSupported
: ComputedRef
<boolean>
  memory
: Ref
<MemoryInfo | undefined, MemoryInfo | undefined>
}
export type UseMemoryReturn
 = ReturnType
<typeof useMemory
>