foxact/create-local-storage-state/index.d.ts

React Hooks/Utils done right. For browser, SSR, and React Server Components.

import { StateHook, ValueHook, SetValueHook } from '../create-storage-state-factory/index.js';
import { NotUndefined, UseStorageRawOption, UseStorageParserOption } from '../create-storage-hook/index.js';

/**
 * @see https://foxact.skk.moe/create-local-storage-state
 *
 * @example
 * ```ts
 * const [useOpenState, useOpen] = createLocalStorageState(
 *   'open', // storage key
 *   false, // server default value
 *   { raw: false } // options
 * );
 *
 * const [open, setOpen] = useOpenState();
 * const open = useOpen();
 * ```
 */
declare const createLocalStorageState: {
    <T>(key: string, serverValue: NotUndefined<T>, options?: UseStorageRawOption | UseStorageParserOption<T>): readonly [StateHook<T>, ValueHook<T>, SetValueHook<T | null>];
    <T>(key: string, serverValue?: undefined, options?: UseStorageRawOption | UseStorageParserOption<T>): readonly [StateHook<T | null>, ValueHook<T | null>, SetValueHook<T | null>];
};

export { createLocalStorageState };