Skip to main content

ForceT

import { type ForceT } from '@dr.pogodin/react-global-state';

ForceT is a special type for «unlocking» overloads of hooks and functions that allow to enforce arbitrary value types.

For example, useGlobalState() has such overload:

function useGlobalState<
Forced extends ForceT | LockT = LockT,
ValueT = void,
>(
path: null | string | undefined,
initialValue?: ValueOrInitializerT<TypeLock<Forced, never, ValueT>>,
): UseGlobalStateResT<TypeLock<Forced, void, ValueT>>;

Which can be used with ForceT to enforce arbitrary type of ValueT:

import { type ForceT } from '@dr.pogodin/react-global-state';

const [aString, aStringSetter] = useGlobalState<ForceT, string>('some.path');