useMemory

Category

Browser

Export Size

524 B

Last Changed

2 years ago

Reactive Memory Info.

Demo

source

Your browser does not support performance memory API

Usage

import { useMemory } from '@vueuse/core'

const { isSupported, memory } = useMemory()

Type Declarations

/**
 * Performance.memory
 *
 * @see https://developer.mozilla.org/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/useMemory
 * @param options
 */
export declare function useMemory(options?: UseMemoryOptions): {
  isSupported: ComputedRef<boolean>
  memory: Ref<MemoryInfo | undefined>
}
export type UseMemoryReturn = ReturnType<typeof useMemory>

Source

Source • Demo • Docs

Contributors

Anthony Fu

Jelf

webfansplz

Changelog

v9.0.0-beta.1 on 7/20/2022

4bc0f - fix(useIntervalFn)!: rename type IntervalFnOptions to UseIntervalFnOptions (#1943)