57 lines
1.1 KiB
Markdown
57 lines
1.1 KiB
Markdown
---
|
|
category: Browser
|
|
---
|
|
|
|
# useMemory
|
|
|
|
Reactive Memory Info.
|
|
|
|
## Usage
|
|
|
|
```ts
|
|
import { useMemory } from '@vueuse/core'
|
|
|
|
const { isSupported, memory } = useMemory()
|
|
```
|
|
|
|
## Type Declarations
|
|
|
|
```ts
|
|
/**
|
|
* 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
|
|
*
|
|
* @__NO_SIDE_EFFECTS__
|
|
*/
|
|
export declare function useMemory(options?: UseMemoryOptions): {
|
|
isSupported: ComputedRef<boolean>
|
|
memory: Ref<MemoryInfo | undefined, MemoryInfo | undefined>
|
|
}
|
|
export type UseMemoryReturn = ReturnType<typeof useMemory>
|
|
```
|