react-hooks-localstorage/dist/localStorage.types.d.ts

Complete React hooks library for localStorage with TTL, encryption, caching, sync, and advanced utilities.

export type ExpiringLocalStorageValue<T> = {
    value: T;
    expiresAt: number | null;
    createdAt: number;
    version?: string;
};
export type LocalStorageOptions<T = unknown> = {
    ttl?: number;
    autoEncrypt?: boolean;
    secretKey?: string;
    serialize?: (value: T) => string;
    deserialize?: (value: string) => T;
    syncAcrossTabs?: boolean;
    version?: string;
};
export type UseLocalStorageReturn<T> = [
    T,
    {
        setValue: (value: T | ((prevValue: T) => T)) => void;
        removeValue: () => void;
        refreshValue: () => void;
        isExpired: () => boolean;
        getCreatedAt: () => number | null;
        getExpiresAt: () => number | null;
        getRemainingTime: () => number | null;
    }
];
export type LocalStorageEventDetail<T> = {
    key: string;
    newValue: T;
    oldValue: T;
};
export type LocalStorageError = {
    type: "QUOTA_EXCEEDED" | "SERIALIZATION_ERROR" | "DESERIALIZATION_ERROR" | "UNKNOWN_ERROR";
    message: string;
    originalError?: Error;
};
export type LocalStorageManagerOptions = {
    prefix?: string;
    version?: string;
    onError?: (error: LocalStorageError) => void;
};
//# sourceMappingURL=localStorage.types.d.ts.map