react-storage-complete/dist/hooks/useBrowserStorage.d.ts

🗄️ React hooks for accessing localStorage and sessionStorage, with syncing and prefix support. The complete package.

/// <reference types="node" />
import EventEmitter from 'events';
export interface StorageOptions<T> {
    prefix?: string;
    prefixSeparator?: string;
    shouldInitialize?: boolean;
    emitterDisabled?: boolean;
    storageEventListenerDisabled?: boolean;
    encode?: StorageEncoder<T>;
    decode?: StorageDecoder<T>;
}
export declare const DEFAULT_BROWSER_STORAGE_OPTIONS: StorageOptions<any>;
export type StorageState<T> = [T | null | undefined, (val: T | null | undefined) => void, boolean, () => void, string];
export declare function useBrowserStorage<T = any>(key: string, defaultWhenUndefined: T | null | undefined, storage: Storage, options?: StorageOptions<T>): StorageState<T>;
export type StorageEncoder<T> = (value: T | null) => string | null;
export type StorageDecoder<T> = (itemString: string | null) => T | null;
export declare function defaultEncode<T>(value: T | null): string | null;
export declare function defaultDecode<T>(itemString: string | null): T | null;
export declare const EMITTER_CHANGE_EVENT_NAME = "change";
export declare const storageEventEmitter: EventEmitter;