react-hooks-global-states
Version:
This is a package to easily handling global-state across your react-components using hooks.
24 lines (23 loc) • 1.92 kB
TypeScript
import type { ActionCollectionConfig, StateSetter, ActionCollectionResult, StateHook, CustomGlobalHookBuilderParams, BaseMetadata, GlobalStoreCallbacks } from './types';
export interface CustomCreateGlobalState<TCustomConfig extends BaseMetadata | unknown, InheritMetadata extends BaseMetadata | unknown = BaseMetadata> {
<State>(state: State): StateHook<State, StateSetter<State>, BaseMetadata>;
<State, Metadata extends BaseMetadata | unknown, ActionsConfig extends ActionCollectionConfig<State, InheritMetadata & Metadata> | null | {}, PublicStateMutator = keyof ActionsConfig extends never | undefined ? StateSetter<State> : ActionCollectionResult<State, InheritMetadata & Metadata, NonNullable<ActionsConfig>>>(state: State, args: {
name?: string;
metadata?: Metadata;
callbacks?: GlobalStoreCallbacks<State, InheritMetadata & Metadata>;
actions?: ActionsConfig;
config?: TCustomConfig;
}): StateHook<State, PublicStateMutator, InheritMetadata & Metadata>;
<State, Metadata extends BaseMetadata | unknown, ActionsConfig extends Readonly<ActionCollectionConfig<State, InheritMetadata & Metadata>>>(state: State, args: {
name?: string;
metadata?: Metadata;
callbacks?: GlobalStoreCallbacks<State, InheritMetadata & Metadata>;
actions: ActionsConfig;
config?: TCustomConfig;
}): StateHook<State, ActionCollectionResult<State, InheritMetadata & Metadata, ActionsConfig>, InheritMetadata & Metadata>;
}
/**
* @description Simple custom global state hook builder
*/
export declare const createCustomGlobalState: <TCustomConfig extends BaseMetadata | unknown, InheritMetadata extends BaseMetadata | unknown = BaseMetadata>({ onInitialize, onChange, }: CustomGlobalHookBuilderParams<TCustomConfig, InheritMetadata>) => CustomCreateGlobalState<TCustomConfig, InheritMetadata>;
export default createCustomGlobalState;