1---
2category: Browser
3---
4 
5# useMemory
6 
7Reactive Memory Info.
8 
9## Usage
10 
11```ts
12import { useMemory } from '@vueuse/core'
13 
14const { isSupported, memory } = useMemory()
15```
16 
17## Type Declarations
18 
19```ts
20/**
21 * Performance.memory
22 *
23 * @see https://developer.mozilla.org/en-US/docs/Web/API/Performance/memory
24 */
25export interface MemoryInfo {
26  /**
27   * The maximum size of the heap, in bytes, that is available to the context.
28   */
29  readonly jsHeapSizeLimit: number
30  /**
31   *  The total allocated heap size, in bytes.
32   */
33  readonly totalJSHeapSize: number
34  /**
35   * The currently active segment of JS heap, in bytes.
36   */
37  readonly usedJSHeapSize: number
38  [Symbol.toStringTag]: "MemoryInfo"
39}
40export interface UseMemoryOptions extends ConfigurableScheduler {
41  /**
42   * Start the timer immediately
43   *
44   * @deprecated Please use `scheduler` option instead
45   * @default true
46   */
47  immediate?: boolean
48  /**
49   * Execute the callback immediately after calling `resume`
50   *
51   * @deprecated Please use `scheduler` option instead
52   * @default false
53   */
54  immediateCallback?: boolean
55  /** @deprecated Please use `scheduler` option instead */
56  interval?: number
57}
58export interface UseMemoryReturn extends Supportable {
59  memory: Ref<MemoryInfo | undefined>
60}
61/**
62 * Reactive Memory Info.
63 *
64 * @see https://vueuse.org/useMemory
65 * @param options
66 *
67 * @__NO_SIDE_EFFECTS__
68 */
69export declare function useMemory(options?: UseMemoryOptions): UseMemoryReturn
70```
71