Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
imp-dance authored May 27, 2024
1 parent 1ca1bc4 commit 9acbad7
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,53 @@ npm i @ryfylke-react/rtk-query-loader

You can read more about the features @ [the docs](https://rtk-query-loader.ryfylke.dev/Features/).



<details>
<summary> πŸ”¬ We're also properly tested! (βœ“ 30/30)</summary>

---

* **aggregateToQuery**
* βœ“ It aggregates query status (167 ms)
* **useCreateQuery**
* βœ“ It creates a query (107 ms)
* βœ“ The query can throw error (108 ms)
* βœ“ You can refetch the query (645 ms)
* **<AwaitLoader />**
* βœ“ Renders loading state until data is available (130 ms)
* βœ“ Will pass arguments properly (129 ms)
* **withLoader**
* βœ“ Renders loading state until data is available (132 ms)
* βœ“ onError renders when applicable (130 ms)
* βœ“ onFetching renders when applicable (319 ms)
* βœ“ Internal state won't reset when using whileFetching (272 ms)
* βœ“ Internal state will reset when using onFetching (271 ms)
* βœ“ Can use custom loader component (129 ms)
* βœ“ loaderComponent is backwards compatible (121 ms)
* βœ“ Can defer some queries (231 ms)
* βœ“ Can defer all queries (130 ms)
* βœ“ Loaders with no queries render immediately (4 ms)
* βœ“ Can remount a component that has a failed query (161 ms)
* **createLoader**
* βœ“ Normally, deferred queries do not throw (205 ms)
* βœ“ Deferred queries throw error when configured to (209 ms)
* βœ“ Can send static payload to loader (7 ms)
* βœ“ Loader passes props through queriesArg to queries (128 ms)
* **.extend()**
* βœ“ Can extend onLoading (5 ms)
* βœ“ Can extend onError (128 ms)
* βœ“ Can extend onFetching (156 ms)
* βœ“ Can extend whileFetching (133 ms)
* βœ“ Can extend queries (122 ms)
* βœ“ Can extend deferred queries (230 ms)
* βœ“ Can extend many times (282 ms)
* βœ“ Can extend with only transform (133 ms)
* βœ“ Can partially extend config (138 ms)

---
</details>

## Example
A simple example of a component using rtk-query-loader:

Expand Down

0 comments on commit 9acbad7

Please sign in to comment.