react-create-store/dist/index.d.ts

State management just using basic React hooks api within 80 lines of code 在80行代码内仅使用基本的 React hooks API 进行状态管理

import { type Dispatch, type PropsWithChildren, type FC } from "react";
import { type Draft } from "immer";
export { useImmer, useImmerReducer } from "use-immer";
/**
 * Batch declaring providers in JSX
 *
 * [idx] where to start, default is 0
 *
 * [providers] the order of the providers parameter array is exactly the order of the context hierarchy
 *
 * 在 JSX 中批量声明上下文
 *
 * [providers] 参数数组的顺序，正好是上下文层级的顺序
 *
 * [idx] 从哪个位置开始迭代声明，默认是 0
 *
 * @export
 * @param {PropsWithChildren<{
 *   idx?: number
 *   providers: FC<PropsWithChildren>[]
 * }>} {
 *   children,
 *   idx = 0,
 *   providers,
 * }
 * @return {*}
 */
export declare function BatchProviders({ children, idx, providers, }: PropsWithChildren<{
    idx?: number;
    providers: FC<PropsWithChildren>[];
}>): string | number | boolean | Iterable<import("react").ReactNode> | import("react/jsx-runtime").JSX.Element | null | undefined;
/**
 * Create a store，reducer with immer inside
 *
 * 创建一个 store， 内部有 immer 的 reducer
 *
 * @export
 * @template S
 * @template A
 * @template Async
 * @param {S} intialState
 * [initialState] The initial state of the reducer in the store (cannot be null or undefined)
 * [initialState] reducer 的初始状态(不能为 null 或 undefined)
 * @param {(state: Draft<S>, action: Partial<A>) => void} reducer
 * [reducer] The reducer function of the store，State is immutable（by immer）
 * [reducer] store 的 reducer 函数，State 是不可变的（通过 immer）
 * @param {(state: S, dispatch: Dispatch<Partial<A>>) => Async} [useHook=() =>
 *     ({} as unknown as Async)]
 * [useHook] A custom hook that returns an object where each property is an asynchronous function（{} by default）
 * [useHook] 一个自定义 hook，返回一个对象，对象的每个属性都是一个异步函数（默认是 {}）
 * @return {*}
 */
export default function createStore<S extends NonNullable<any>, A extends {
    [key: string]: any;
}, Async extends {
    [key: string]: Function;
} = {}>(intialState: S, reducer: (state: Draft<S>, action: Partial<A>) => void, useHook?: (state: S, dispatch: Dispatch<Partial<A>>) => Async): {
    useReducer(): readonly [S, Dispatch<Partial<A>>, Async];
    useDispatch(): Dispatch<Partial<A>>;
    useAsync(): Async;
    Provider(props: PropsWithChildren<{
        initialState?: S;
    }>): import("react/jsx-runtime").JSX.Element;
};