@t8/react-pending 1.0.16 → 1.0.18

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Alexander Tkačenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -4,20 +4,31 @@
 
 *Concise async action state tracking for React apps*
 
-No need to rearrange the app's shared state setup and to rewrite the async actions.
+- Shared or local pending state tracking
+- Without rewrites in the app's shared state or async actions' internals
+- With a concise API
+
+```diff
++ let [state, withState] = usePendingState("fetch-items");
+
+- fetchItems().then(setItems);
++ withState(fetchItems()).then(setItems);
+
++ if (!state.complete) return <p>Loading...</p>;
+```
 
 Installation: `npm i @t8/react-pending`
 
-## Example
+## Shared pending state
 
-Objective: Track the pending state of the async `fetchItems()` action to tell the user whether the UI is busy or encountered an error (preferably without rewriting the action and the app's state management).
+Objective: Track the pending state of the asynchronous action `fetchItems()` to tell the user whether the UI is busy or encountered an error (preferably without rewriting the action and the app's state management). In our setup, there are two components rendering their content with regard to the current state of `fetchItems()`.
 
 ```diff
 + import { usePendingState } from "@t8/react-pending";
 
-  export const ItemList = () => {
-    const [items, setItems] = useState([]);
-+   const [state, withState] = usePendingState("fetch-items");
+  export let ItemList = () => {
+    let [items, setItems] = useState([]);
++   let [state, withState] = usePendingState("fetch-items");
 
     useEffect(() => {
 -     fetchItems().then(setItems);
@@ -34,8 +45,8 @@ Objective: Track the pending state of the async `fetchItems()` action to tell th
 ```diff
 + import { usePendingState } from "@t8/react-pending";
 
-  export const Status = () => {
-+   const [state] = usePendingState("fetch-items");
+  export let Status = () => {
++   let [state] = usePendingState("fetch-items");
 
     if (!state.initialized) return "";
     if (!state.complete) return "Busy";
@@ -47,15 +58,15 @@ Objective: Track the pending state of the async `fetchItems()` action to tell th
 
 [Live demo](https://codesandbox.io/p/sandbox/rrr9cl?file=%2Fsrc%2FItemList.tsx)
 
-🔹 In this example, the action's value (the `items` array) is stored in the component's local state, but it can be stored in any app state of the developer's choice.
+🔹 In this example, the value returned from the async action, the `items` array, is stored in the component's local state, but it can be stored in any app state of the developer's choice without affecting how `usePendingState()` is used.
 
-## Shared and local pending state
+## Local pending state
 
 Omit the custom string key parameter of `usePendingState()` to scope the pending state locally within a single component:
 
 ```diff
-- const [state, withState] = usePendingState("fetch-items"); // shared
-+ const [state, withState] = usePendingState(); // local
+- let [state, withState] = usePendingState("fetch-items"); // shared
++ let [state, withState] = usePendingState(); // local
 ```
 
 ## Silent tracking of background and optimistic updates
@@ -101,7 +112,7 @@ Omit the custom string key parameter of `usePendingState()` to scope the pending
 ## Providing custom initial pending state
 
 ```diff
-+ const initialState = {
++ let initialState = {
 +   "fetch-items": { initialized: true, complete: true },
 + };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@t8/react-pending",
-  "version": "1.0.16",
+  "version": "1.0.18",
   "description": "Concise async action state tracking for React apps",
   "main": "dist/index.js",
   "type": "module",
@@ -16,7 +16,7 @@
     "typecheck": "tsc --noEmit"
   },
   "author": "axtk",
-  "license": "ISC",
+  "license": "MIT",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/t8js/react-pending.git"
@@ -31,8 +31,8 @@
     "react": ">=16.8"
   },
   "devDependencies": {
-    "@playwright/test": "^1.55.1",
-    "@t8/serve": "^0.1.29",
+    "@playwright/test": "^1.56.0",
+    "@t8/serve": "^0.1.30",
     "@types/node": "^24.5.2",
     "@types/react": "^19.1.10",
     "@types/react-dom": "^19.1.9",
@@ -40,6 +40,6 @@
     "typescript": "^5.9.3"
   },
   "dependencies": {
-    "@t8/react-store": "^1.0.23"
+    "@t8/react-store": "^1.0.27"
   }
 }