@udecode/zustood/dist/types.d.ts

A modular store factory using zustand

import { Draft } from 'immer';
import { StoreApi as RawStoreApi, UseBoundStore } from 'zustand';
import { GetState, StateSelector } from 'zustand/vanilla';
import { NamedSet } from 'zustand/middleware';
export declare type StoreApiGet<T extends State = {}, TSelectors = {}> = StateGetters<T> & TSelectors;
export declare type StoreApiUse<T extends State = {}, TSelectors = {}> = GetRecord<T> & TSelectors;
export declare type StoreApiUseTracked<T extends State = {}, TSelectors = {}> = GetRecord<T> & TSelectors;
export declare type StoreApiSet<TActions = {}> = TActions;
export declare type StoreApi<TName extends string, T extends State = {}, TActions = {}, TSelectors = {}> = {
    get: StoreApiGet<T, TSelectors>;
    name: TName;
    set: StoreApiSet<TActions>;
    store: ImmerStoreApi<T>;
    use: StoreApiUse<T, TSelectors>;
    useTracked: StoreApiUseTracked<T, TSelectors>;
    useStore: UseImmerStore<T>;
    useTrackedStore: () => T;
    extendSelectors<SB extends SelectorBuilder<TName, T, TActions, TSelectors>>(builder: SB): StoreApi<TName, T, StateActions<T> & TActions, TSelectors & ReturnType<SB>>;
    extendActions<AB extends ActionBuilder<TName, T, StateActions<T> & TActions, TSelectors>>(builder: AB): StoreApi<TName, T, StateActions<T> & TActions & ReturnType<AB>, TSelectors>;
};
export declare type State = unknown;
export declare type EqualityChecker<T> = (state: T, newState: T) => boolean;
export declare type MergeState<T extends State> = (state: Partial<T>, actionName?: string) => void;
export declare type StateActions<T extends State> = SetRecord<T> & {
    state: SetImmerState<T>;
    mergeState: MergeState<T>;
};
export declare type StateGetters<T extends State> = GetRecord<T> & {
    state: GetState<T>;
};
export declare type SelectorRecord<T> = Record<string, (state: T) => any>;
export declare type SelectorBuilder<TName extends string, T extends State, TActions = {}, TSelectors = {}> = (state: T, get: StoreApiGet<T, TSelectors>, api: StoreApi<TName, T, TActions, TSelectors>) => Record<string, (...args: any[]) => any>;
export declare type ActionBuilder<TName extends string, T extends State, TActions = {}, TSelectors = {}> = (set: StoreApiSet<TActions>, get: StoreApiGet<T, TSelectors>, api: StoreApi<TName, T, TActions, TSelectors>) => any;
export declare type SetImmerState<T> = (fn: (draft: Draft<T>) => void, actionName?: string) => void;
export declare type StateCreatorWithDevtools<T extends State, CustomSetState = NamedSet<T>, CustomGetState = GetState<T>, CustomStoreApi extends RawStoreApi<T> = RawStoreApi<T>> = (set: CustomSetState, get: CustomGetState, api: CustomStoreApi) => T;
export interface ImmerStoreApi<T extends State> extends Omit<RawStoreApi<T>, 'setState'> {
    setState: SetImmerState<T>;
}
export interface UseImmerStore<T extends State> extends Omit<UseBoundStore<RawStoreApi<T>>, 'setState'> {
    (): T;
    <U>(selector: StateSelector<T, U>, equalityFn?: EqualityChecker<U>): U;
    setState: SetImmerState<T>;
}
export declare type GetRecord<O> = {
    [K in keyof O]: (equalityFn?: EqualityChecker<O[K]>) => O[K];
};
export declare type SetRecord<O> = {
    [K in keyof O]: (value: O[K]) => void;
};
//# sourceMappingURL=types.d.ts.map