8000 docs: adding ReactQuery.Provider.make docs · rescriptbr/react-query@d4894f6 · GitHub
[go: up one dir, main page]

Skip to content< 8000 /a>

Commit d4894f6

Browse files
vinibispovmarcosp
authored andcommitted
docs: adding ReactQuery.Provider.make docs
1 parent 2e98b79 commit d4894f6

File tree

1 file changed

+31
-2
lines changed

1 file changed

+31
-2
lines changed

docs/api-reference.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,37 @@
11
# API Reference
22
---
3-
- [`ReactQuery.Provider.createClient(...)`](#reactqueryprovidercreateclient)
3+
- [`ReactQuery.Provider.createClient()`](#reactqueryprovidercreateclient)
4+
- [`ReactQuery.Provider.make()`](#reactqueryprovidermake)
45

56

6-
### `ReactQuery.Provider.createClient(...)`
7+
### `ReactQuery.Provider.createClient()`
78

89
The function responsible to create the query client
10+
11+
Definition:
12+
13+
```rescript
14+
module Provider = {
15+
let createClient: unit => queryClientValue
16+
}
17+
```
18+
Usage:
19+
```rescript
20+
let client = ReactQuery.Provider.createClient()
21+
```
22+
23+
### `ReactQuery.Provider.make()`
24+
25+
The React Context Provider responsible to hold all the react-query context
26+
27+
Definition:
28+
29+
```rescript
30+
module Provider = {
31+
let make: (
32+
~client: queryClientValue,
33+
~contextSharing: bool,
34+
~children: React.element
35+
) => React.element
36+
}
37+
```

0 commit comments

Comments
 (0)
0