floppy-disk 2.12.1 → 2.12.2

package/esm/react/create-query.d.ts

@@ -39,7 +39,7 @@ export type QueryState<TKey extends StoreKey = StoreKey, TResponse = any, TData
      *
      * @returns function to revert the changes & function to invalidate the query
      *
-     * IMPORTANT NOTE: This won't work well on infinite query.
+     * **IMPORTANT NOTE:** This won't work well on infinite query.
      */
     optimisticUpdate: (response: TResponse | ((prevState: QueryState<TKey, TResponse, TData, TError, TPageParam>) => TResponse)) => {
         revert: () => void;
@@ -233,11 +233,15 @@ export type CreateQueryOptions<TKey extends StoreKey = StoreKey, TResponse = any
 };
 export type UseQuery<TKey extends StoreKey = StoreKey, TResponse = any, TData = TResponse, TError = unknown, TPageParam = any> = UseStores<TKey, QueryState<TKey, TResponse, TData, TError, TPageParam>> & {
     /**
+     * ⚛️ (**_Hook_**)
+     *
      * Set query's initial response.
      *
      * This is used for server-side rendered page or static page.
      *
-     * IMPORTANT NOTE: Put this on the root component or parent component, before any component subscribed!
+     * **IMPORTANT NOTE:**
+     * - This is a hook, put it inside of a React component
+     * - Put this on the root component or parent component, before any component subscribed!
      */
     setInitialResponse: (options: {
         key?: Maybe<TKey>;
@@ -265,7 +269,7 @@ export type UseQuery<TKey extends StoreKey = StoreKey, TResponse = any, TData =
      *
      * @returns function to revert the changes & function to invalidate the query
      *
-     * IMPORTANT NOTE: This won't work well on infinite query.
+     * **IMPORTANT NOTE:** This won't work well on infinite query.
      */
     optimisticUpdate: (options: {
         key?: Maybe<TKey>;
@@ -275,7 +279,12 @@ export type UseQuery<TKey extends StoreKey = StoreKey, TResponse = any, TData =
         invalidate: () => void;
     };
     /**
+     * ⚛️ (**_Hook_**)
+     *
      * Use query with suspense mode.
+     *
+     * **IMPORTANT NOTE:**
+     * - This is a hook, put it inside of a React component
      */
     suspend: (key?: Maybe<TKey>) => Extract<QueryState<TKey, TResponse, TData, TError, TPageParam>, {
         status: 'success';

package/esm/react/create-store.d.ts

@@ -8,7 +8,7 @@ export type UseStore<T extends StoreData> = {
      * @param selectDeps A function that return the dependency array (just like in `useEffect`), to trigger reactivity.
      * Defaults to `undefined` (reactive to all state change) if you didn't set `defaultDeps` on `createStore`.
      *
-     * IMPORTANT NOTE: `selectDeps` must not be changed after initialization.
+     * **IMPORTANT NOTE:** `selectDeps` must not be changed after initialization.
      */
     (selectDeps?: SelectDeps<T>): T;
     get: () => T;
@@ -16,9 +16,13 @@ export type UseStore<T extends StoreData> = {
     subscribe: (fn: (state: T) => void, selectDeps?: SelectDeps<T>) => () => void;
     getSubscribers: () => Subscribers<T>;
     /**
-     * Set default values inside a component.
+     * ⚛️ (**_Hook_**)
      *
-     * IMPORTANT NOTE: Put this on the root component or parent component, before any component subscribed!
+     * Set default values **inside of a component**.
+     *
+     * **IMPORTANT NOTE:**
+     * - This is a hook, put it inside of a React component
+     * - Put this on the root component or parent component, before any component subscribed!
      */
     setDefaultValues: (values: SetStoreData<T>) => void;
     Watch: (props: WatchProps<T>) => any;

package/esm/react/create-store.js

@@ -7,7 +7,7 @@ export const createStore = (initializer, options = {}) => {
     const { get, set, subscribe, getSubscribers } = initStore(initializer, options);
     const { defaultDeps } = options;
     /**
-     * IMPORTANT NOTE: selectDeps function must not be changed after initialization.
+     * **IMPORTANT NOTE:** `selectDeps` function must not be changed after initialization.
      */
     const useStore = (selectDeps = defaultDeps) => {
         const [state, setState] = useState(get);

package/esm/react/create-stores.d.ts

@@ -15,7 +15,7 @@ export type UseStores<TKey extends StoreKey = StoreKey, T extends StoreData = St
      * @param selectDeps A function that return the dependency array (just like in `useEffect`), to trigger reactivity.
      * Defaults to `undefined` (reactive to all state change) if you didn't set `defaultDeps` on `createStores`.
      *
-     * IMPORTANT NOTE: `selectDeps` must not be changed after initialization.
+     * **IMPORTANT NOTE:** `selectDeps` must not be changed after initialization.
      */
     (...args: [Maybe<TKey>, SelectDeps<T>?] | [SelectDeps<T>?]): T;
     get: (key?: Maybe<TKey>) => T;
@@ -28,9 +28,13 @@ export type UseStores<TKey extends StoreKey = StoreKey, T extends StoreData = St
     getStore: (key?: Maybe<TKey>) => InitStoreReturn<T>;
     getStores: () => Map<string, InitStoreReturn<T>>;
     /**
-     * Set default values inside a component.
+     * ⚛️ (**_Hook_**)
      *
-     * IMPORTANT NOTE: Put this on the root component or parent component, before any component subscribed!
+     * Set default values **inside of a component**.
+     *
+     * **IMPORTANT NOTE:**
+     * - This is a hook, put it inside of a React component
+     * - Put this on the root component or parent component, before any component subscribed!
      */
     setDefaultValues: (key: Maybe<TKey>, values: SetStoreData<T>) => void;
     Watch: (props: WatchProps<T> & {

package/esm/react/create-stores.js

@@ -17,7 +17,7 @@ export const createStores = (initializer, options = {}) => {
         return stores.get(keyHash);
     };
     /**
-     * IMPORTANT NOTE: selectDeps function must not be changed after initialization.
+     * **IMPORTANT NOTE:** `selectDeps` function must not be changed after initialization.
      */
     const useStores = (...args) => {
         const [_key, selectDeps = defaultDeps] = (typeof args[0] === 'function' ? [{}, args[0]] : args);

package/lib/react/create-query.d.ts

@@ -39,7 +39,7 @@ export type QueryState<TKey extends StoreKey = StoreKey, TResponse = any, TData
      *
      * @returns function to revert the changes & function to invalidate the query
      *
-     * IMPORTANT NOTE: This won't work well on infinite query.
+     * **IMPORTANT NOTE:** This won't work well on infinite query.
      */
     optimisticUpdate: (response: TResponse | ((prevState: QueryState<TKey, TResponse, TData, TError, TPageParam>) => TResponse)) => {
         revert: () => void;
@@ -233,11 +233,15 @@ export type CreateQueryOptions<TKey extends StoreKey = StoreKey, TResponse = any
 };
 export type UseQuery<TKey extends StoreKey = StoreKey, TResponse = any, TData = TResponse, TError = unknown, TPageParam = any> = UseStores<TKey, QueryState<TKey, TResponse, TData, TError, TPageParam>> & {
     /**
+     * ⚛️ (**_Hook_**)
+     *
      * Set query's initial response.
      *
      * This is used for server-side rendered page or static page.
      *
-     * IMPORTANT NOTE: Put this on the root component or parent component, before any component subscribed!
+     * **IMPORTANT NOTE:**
+     * - This is a hook, put it inside of a React component
+     * - Put this on the root component or parent component, before any component subscribed!
      */
     setInitialResponse: (options: {
         key?: Maybe<TKey>;
@@ -265,7 +269,7 @@ export type UseQuery<TKey extends StoreKey = StoreKey, TResponse = any, TData =
      *
      * @returns function to revert the changes & function to invalidate the query
      *
-     * IMPORTANT NOTE: This won't work well on infinite query.
+     * **IMPORTANT NOTE:** This won't work well on infinite query.
      */
     optimisticUpdate: (options: {
         key?: Maybe<TKey>;
@@ -275,7 +279,12 @@ export type UseQuery<TKey extends StoreKey = StoreKey, TResponse = any, TData =
         invalidate: () => void;
     };
     /**
+     * ⚛️ (**_Hook_**)
+     *
      * Use query with suspense mode.
+     *
+     * **IMPORTANT NOTE:**
+     * - This is a hook, put it inside of a React component
      */
     suspend: (key?: Maybe<TKey>) => Extract<QueryState<TKey, TResponse, TData, TError, TPageParam>, {
         status: 'success';

package/lib/react/create-store.d.ts

@@ -8,7 +8,7 @@ export type UseStore<T extends StoreData> = {
      * @param selectDeps A function that return the dependency array (just like in `useEffect`), to trigger reactivity.
      * Defaults to `undefined` (reactive to all state change) if you didn't set `defaultDeps` on `createStore`.
      *
-     * IMPORTANT NOTE: `selectDeps` must not be changed after initialization.
+     * **IMPORTANT NOTE:** `selectDeps` must not be changed after initialization.
      */
     (selectDeps?: SelectDeps<T>): T;
     get: () => T;
@@ -16,9 +16,13 @@ export type UseStore<T extends StoreData> = {
     subscribe: (fn: (state: T) => void, selectDeps?: SelectDeps<T>) => () => void;
     getSubscribers: () => Subscribers<T>;
     /**
-     * Set default values inside a component.
+     * ⚛️ (**_Hook_**)
      *
-     * IMPORTANT NOTE: Put this on the root component or parent component, before any component subscribed!
+     * Set default values **inside of a component**.
+     *
+     * **IMPORTANT NOTE:**
+     * - This is a hook, put it inside of a React component
+     * - Put this on the root component or parent component, before any component subscribed!
      */
     setDefaultValues: (values: SetStoreData<T>) => void;
     Watch: (props: WatchProps<T>) => any;

package/lib/react/create-store.js

@@ -10,7 +10,7 @@ const createStore = (initializer, options = {}) => {
     const { get, set, subscribe, getSubscribers } = (0, vanilla_1.initStore)(initializer, options);
     const { defaultDeps } = options;
     /**
-     * IMPORTANT NOTE: selectDeps function must not be changed after initialization.
+     * **IMPORTANT NOTE:** `selectDeps` function must not be changed after initialization.
      */
     const useStore = (selectDeps = defaultDeps) => {
         const [state, setState] = (0, react_1.useState)(get);

package/lib/react/create-stores.d.ts

@@ -15,7 +15,7 @@ export type UseStores<TKey extends StoreKey = StoreKey, T extends StoreData = St
      * @param selectDeps A function that return the dependency array (just like in `useEffect`), to trigger reactivity.
      * Defaults to `undefined` (reactive to all state change) if you didn't set `defaultDeps` on `createStores`.
      *
-     * IMPORTANT NOTE: `selectDeps` must not be changed after initialization.
+     * **IMPORTANT NOTE:** `selectDeps` must not be changed after initialization.
      */
     (...args: [Maybe<TKey>, SelectDeps<T>?] | [SelectDeps<T>?]): T;
     get: (key?: Maybe<TKey>) => T;
@@ -28,9 +28,13 @@ export type UseStores<TKey extends StoreKey = StoreKey, T extends StoreData = St
     getStore: (key?: Maybe<TKey>) => InitStoreReturn<T>;
     getStores: () => Map<string, InitStoreReturn<T>>;
     /**
-     * Set default values inside a component.
+     * ⚛️ (**_Hook_**)
      *
-     * IMPORTANT NOTE: Put this on the root component or parent component, before any component subscribed!
+     * Set default values **inside of a component**.
+     *
+     * **IMPORTANT NOTE:**
+     * - This is a hook, put it inside of a React component
+     * - Put this on the root component or parent component, before any component subscribed!
      */
     setDefaultValues: (key: Maybe<TKey>, values: SetStoreData<T>) => void;
     Watch: (props: WatchProps<T> & {

package/lib/react/create-stores.js

@@ -20,7 +20,7 @@ const createStores = (initializer, options = {}) => {
         return stores.get(keyHash);
     };
     /**
-     * IMPORTANT NOTE: selectDeps function must not be changed after initialization.
+     * **IMPORTANT NOTE:** `selectDeps` function must not be changed after initialization.
      */
     const useStores = (...args) => {
         const [_key, selectDeps = defaultDeps] = (typeof args[0] === 'function' ? [{}, args[0]] : args);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "floppy-disk",
-  "version": "2.12.1",
+  "version": "2.12.2",
   "description": "FloppyDisk - lightweight, simple, and powerful state management library",
   "keywords": [
     "state",