useMemory

分类

浏览器

导出大小

538 B

上次更改

3 个月前

响应式内存信息。

演示

源代码在线演练 (beta)

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

用法

import { useMemory
 } from '@vueuse/core'

const { isSupported
, memory
 } = useMemory
()

类型声明

/**
 * Performance.memory
 *
 * @see https://mdn.org.cn/en-US/docs/Web/API/Performance/memory
 */
export interface MemoryInfo {
  /**
   * The maximum size of the heap, in bytes, that is available to the context.
   */
  readonly jsHeapSizeLimit
: number
  /**
   *  The total allocated heap size, in bytes.
   */
  readonly totalJSHeapSize
: number
  /**
   * The currently active segment of JS heap, in bytes.
   */
  readonly usedJSHeapSize
: number
  [Symbol
.toStringTag
]: "MemoryInfo"
}
export interface UseMemoryOptions extends UseIntervalFnOptions {
  interval
?: number
}
/**
 * Reactive Memory Info.
 *
 * @see https://vueuse.org.cn/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
>