define-zustand 2.0.0 → 2.0.1

package/dist/index.d.ts

@@ -16,7 +16,7 @@ export interface optionsType<S, G, OptionAction> {
     getter: G;
     actions: actionsType<S, OptionAction>;
 }
-export declare function define<S extends Record<string, any>, G extends defGetterStateType<S>, OptionActions extends Record<string, any>>(options: optionsType<S, G, OptionActions>): import("zustand").UseBoundStore<ZStoreApi<Omit<S & ExtraGetterState<S, G>, "reset" | "setState" | "subscribe" | keyof OptionActions> & {
+export default function defineZustand<S extends Record<string, any>, G extends defGetterStateType<S>, OptionActions extends Record<string, any>>(options: optionsType<S, G, OptionActions>): import("zustand").UseBoundStore<ZStoreApi<Omit<S & ExtraGetterState<S, G>, "reset" | "setState" | "subscribe" | keyof OptionActions> & {
     reset: () => void;
     setState: (updater: Partial<S> | ((state: S) => void), replace?: boolean) => void;
     subscribe: (listener: (state: S & ExtraGetterState<S, G>, prevState: S & ExtraGetterState<S, G>) => void) => () => void;

package/dist/index.js

@@ -3,7 +3,7 @@ import { combine } from 'zustand/middleware';
 import { produce } from 'immer';
 import { keys, isEqualWith, omit, some, pick, forEach, isEqual } from 'lodash-es';
 
-function define(options) {
+function defineZustand(options) {
   function createDefState() {
     const state = options.state();
     forEach(options.getter, (getter, k) => {
@@ -49,4 +49,4 @@ function define(options) {
   }));
 }
 
-export { define };
+export { defineZustand as default };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "define-zustand",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/README.md

@@ -1,46 +0,0 @@
-# define-zustand
-> Quickly define [zustand](https://github.com/pmndrs/zustand) state
-
-## Install
-```shell
-pnpm i define-zustand
-npm i define-zustand
-```
-
-## Use
-```tsx
-import defineStore from 'define-zustand'
-
-/**
- * @return zustand hooks
- */
-const useStore = defineStore({
-    state: () => ({
-        a: 1,
-        b: 1
-    }),
-    action: () => ({}),
-    getter: {
-        count: state => state.a + state.b 
-    }
-})
-function ReactComponent() {
-    const { count, setState, reset } = useStore(state => ({
-        count: state.count,
-        setState: state.setState,
-        reset: state.reset
-    }))
-
-    useEffect(() => {
-        return () => {
-            reset()
-        }
-    }, []);
-    
-    return <div>
-        <button onClick={() => setState({ a: 2 })}>setA</button>
-        <button onClick={() => setState(state => {state.b += 1})}>setB</button>
-        <div>{count}</div>
-    </div>
-}
-```