useMemory

Category

Browser

Export Size

508 B

Last Changed

5 days ago

Reactive Memory Info

Demo

Usage

import { useMemory } from '@reause/core'

const { isSupported, memory } = useMemory()

Type Declarations

export interface MemoryInfo {
    readonly jsHeapSizeLimit: number;
    readonly totalJSHeapSize: number;
    readonly usedJSHeapSize: number;
    [Symbol.toStringTag]: 'MemoryInfo';
}

export interface UseMemoryOptions {
    scheduler?: (cb: () => void) => Pausable;
}

export interface UseMemoryReturn {
    isSupported: boolean;
    memory: MemoryInfo | undefined;
}

export interface Pausable {
    isActive: boolean;
    pause: () => void;
    resume: () => void;
}

export function useMemory(options?: UseMemoryOptions): UseMemoryReturn

export function useTimeoutPoll(fn: () => Awaitable<void>, interval: number, options?: UseTimeoutPollOptions): Pausable

Source

Source · Demo · VueUse

Contributors

Changelog

v0.1.0 on

62185 - fix(core): resolve useMemory audit findings (#601)