valtio-define 1.3.4 → 1.4.0

package/README.md

@@ -124,7 +124,7 @@ Save and restore your store state using the `persist` plugin.
 
 ### Manual Hydration (SSR Friendly)
 
-To avoid hydration mismatches during Server-Side Rendering, disable automatic hydration and mount it in a `useEffect`.
+To avoid hydration mismatches during Server-Side Rendering, disable automatic hydration and rehydrate it in a `useEffect`.
 
 ```tsx
 // Register with hydrate disabled
@@ -132,7 +132,7 @@ store.use(persist({ hydrate: false }))
 
 // In your Client Entry / App Root
 useEffect(() => {
-  store.$persist.mount()
+  store.$persist.rehydrate()
 }, [])
 ```
 
@@ -224,6 +224,11 @@ valtio.use(myPlugin())
 // Local
 const store = defineStore({ /* ... */ })
 store.use(myPlugin())
+
+// Local options
+const store = defineStore({
+  use: [myPlugin()],
+})
 ```
 
 ### Creating a Custom Plugin

package/dist/plugins/persist/index.mjs

@@ -8,7 +8,7 @@ function persist({ hydrate = true } = {}) {
 	return (context) => {
 		const { persist, getters } = context.options;
 		const { $state } = context.store;
-		context.store.$persist?.unmount?.();
+		context.store.$persist?.dehydrate?.();
 		if (!persist) return;
 		const getterKeys = new Set(Object.keys(getters || {}));
 		const options = persist === true ? {} : persist;
@@ -27,17 +27,17 @@ function persist({ hydrate = true } = {}) {
 			}
 			meta.hydrated = true;
 		}
-		function mount() {
+		function rehydrate() {
 			meta.mounted = true;
 			const value = storage.getItem(key);
 			value instanceof Promise ? value.then(initialize) : initialize(value);
 		}
-		function unmount() {
+		function dehydrate() {
 			meta.unsubscribe?.();
 			meta.unsubscribe = void 0;
 		}
 		function watch() {
-			unmount();
+			dehydrate();
 			meta.unsubscribe = subscribe($state, () => {
 				if (!meta.hydrated) return;
 				const statePaths = (options.paths || Object.keys($state)).filter((p) => !getterKeys.has(p)).reduce((acc, p) => set(acc, p, get($state, p)), {});
@@ -45,11 +45,11 @@ function persist({ hydrate = true } = {}) {
 			});
 		}
 		context.store.$persist = {
-			mount,
-			unmount,
+			rehydrate,
+			dehydrate,
 			meta
 		};
-		hydrate && !meta.mounted && mount();
+		hydrate && !meta.mounted && rehydrate();
 		watch();
 	};
 }

package/dist/plugins/persist/types.d.mts

@@ -19,8 +19,8 @@ interface PersistentMeta {
 }
 interface PersistentStore {
   $persist: {
-    mount: () => void;
-    unmount: () => void;
+    rehydrate: () => void;
+    dehydrate: () => void;
     meta: PersistentMeta;
   };
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "valtio-define",
   "type": "module",
-  "version": "1.3.4",
+  "version": "1.4.0",
   "description": "⚡quickly create a fully functional and robust Valtio factory",
   "author": "Hairyf <wwu710632@gmail.com>",
   "license": "MIT",