import type { UseIntervalFnOptions } from "../use-interval-fn/index.js";
/**
 * Performance.memory
 *
 * @see https://developer.mozilla.org/en-US/docs/Web/API/Performance/memory
 */
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 UseBrowserMemoryOptions extends UseIntervalFnOptions {
    /**
     * The interval to update the memory info
     */
    interval?: number;
}
export interface UseBrowserMemoryReturns {
    /**
     * The timestamp when the memory info was last updated.
     */
    timestamp: number;
    /**
     * The memory info.
     */
    memory: MemoryInfo | undefined;
    /**
     * The maximum size of the heap, in bytes, that is available to the context.
     */
    jsHeapSizeLimit: number;
    /**
     * The total allocated heap size, in bytes.
     */
    totalJSHeapSize: number;
    /**
     * The used heap size, in bytes.
     */
    usedJSHeapSize: number;
    /**
     *  Whether the browser supports the `Performance.memory` API.
     */
    isSupported: boolean;
    /**
     * Update the memory info.
     */
    update(): void;
}
/**
 * A React Hook that helps to get the memory info of the browser.
 *
 * @param {UseBrowserMemoryOptions} [options={}] - `UseBrowserMemoryOptions`, options to configure the hook, see {@link UseBrowserMemoryOptions}
 * @returns {UseBrowserMemoryReturns} `UseBrowserMemoryReturns`, see {@link UseBrowserMemoryReturns}
 * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Performance/memory#browser_compatibility | Performance.memory's browser compatibility - MDN}
 */
export declare function useBrowserMemory(options?: UseBrowserMemoryOptions): UseBrowserMemoryReturns;
export {};