repos / starfx

supercharged async flow control library.
git clone https://github.com/neurosnap/starfx.git

commit
9ea5759
parent
9756e62
author
Eric Bower
date
2024-02-16 15:20:08 +0000 UTC
docs: react
1 files changed,  +9, -10
M docs/posts/react.md
+9, -10
 1@@ -50,8 +50,8 @@ function App() {
 2 
 3 ## `useLoader`
 4 
 5-This selector will accept an action creator or action and return the loader
 6-associated with it.
 7+Will accept an action creator or action and return the loader associated with
 8+it.
 9 
10 ```tsx
11 import { useLoader } from "starfx/react";
12@@ -70,9 +70,8 @@ function App() {
13 
14 ## `useApi`
15 
16-useApi will take an action creator or action itself and fetch the associated
17-loader and create a `trigger` function that you can call later in your react
18-component.
19+Will take an action creator or action itself and fetch the associated loader and
20+create a `trigger` function that you can call later in your react component.
21 
22 This hook will _not_ fetch the data for you because it does not know how to
23 fetch data from your redux state.
24@@ -97,7 +96,7 @@ const View = () => {
25 
26 ## `useQuery`
27 
28-useQuery uses [useApi](#useapi) and automatically calls `useApi().trigger()`
29+Uses [useApi](#useapi) and automatically calls `useApi().trigger()`
30 
31 ```ts
32 import { useQuery } from 'starfx/react';
33@@ -116,8 +115,8 @@ const View = () => {
34 
35 ## `useCache`
36 
37-useCache uses [useQuery](#usequery) and automatically selects the cached data
38-associated with the action creator or action provided.
39+Uses [useQuery](#usequery) and automatically selects the cached data associated
40+with the action creator or action provided.
41 
42 ```ts
43 import { useCache } from 'starfx/react';
44@@ -134,8 +133,8 @@ const View = () => {
45 
46 ## `useLoaderSuccess`
47 
48-useLoaderSuccess will activate the callback provided when the loader transitions
49-from some state to success.
50+Will activate the callback provided when the loader transitions from some state
51+to success.
52 
53 ```ts
54 import { useApi, useLoaderSuccess } from "starfx/react";