index.ts

import type {UseStorageValueOptions, UseStorageValueResult} from '../useStorageValue/index.js';
import {useStorageValue} from '../useStorageValue/index.js';
import {isBrowser, noop} from '../util/const.js';

let IS_LOCAL_STORAGE_AVAILABLE: boolean;

try {
	IS_LOCAL_STORAGE_AVAILABLE = isBrowser && Boolean(globalThis.localStorage);
} catch {
	IS_LOCAL_STORAGE_AVAILABLE = false;
}

type UseLocalStorageValue = <
	Type,
	Default extends Type = Type,
	Initialize extends boolean | undefined = boolean | undefined,
>(
	key: string,
	options?: UseStorageValueOptions<Type, Initialize>,
) => UseStorageValueResult<Type, Default, Initialize>;

/**
 * Manages a single localStorage key.
 */
export const useLocalStorageValue: UseLocalStorageValue = IS_LOCAL_STORAGE_AVAILABLE
	? (key, options) => useStorageValue(localStorage, key, options)
	: <Type, Default extends Type = Type, Initialize extends boolean | undefined = boolean | undefined>(
			_key: string,
			_options?: UseStorageValueOptions<Type, Initialize>,
		): UseStorageValueResult<Type, Default, Initialize> => {
			if (isBrowser && process.env.NODE_ENV === 'development') {
				console.warn('LocalStorage is not available in this environment');
			}

			// eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
			return {value: undefined as Type, set: noop, remove: noop, fetch: noop};
		};