@faasjs/react 0.0.3-beta.41 → 0.0.3-beta.42
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -80
- package/dist/index.d.ts +8 -3
- package/package.json +4 -3
package/README.md
CHANGED
|
@@ -10,7 +10,7 @@ React plugin for FaasJS.
|
|
|
10
10
|
|
|
11
11
|
## Install
|
|
12
12
|
|
|
13
|
-
npm install @faasjs/react
|
|
13
|
+
npm install @faasjs/react react react-dom
|
|
14
14
|
|
|
15
15
|
## Modules
|
|
16
16
|
|
|
@@ -20,14 +20,17 @@ React plugin for FaasJS.
|
|
|
20
20
|
- [Response](classes/Response.md)
|
|
21
21
|
- [ResponseError](classes/ResponseError.md)
|
|
22
22
|
|
|
23
|
+
### Interfaces
|
|
24
|
+
|
|
25
|
+
- [FaasDataInjection](interfaces/FaasDataInjection.md)
|
|
26
|
+
- [FaasDataWrapperProps](interfaces/FaasDataWrapperProps.md)
|
|
27
|
+
- [FaasReactClientInstance](interfaces/FaasReactClientInstance.md)
|
|
28
|
+
|
|
23
29
|
### Type Aliases
|
|
24
30
|
|
|
25
31
|
- [FaasAction](#faasaction)
|
|
26
32
|
- [FaasData](#faasdata)
|
|
27
|
-
- [FaasDataInjection](#faasdatainjection)
|
|
28
|
-
- [FaasDataWrapperProps](#faasdatawrapperprops)
|
|
29
33
|
- [FaasParams](#faasparams)
|
|
30
|
-
- [FaasReactClientInstance](#faasreactclientinstance)
|
|
31
34
|
- [Options](#options)
|
|
32
35
|
- [ResponseHeaders](#responseheaders)
|
|
33
36
|
|
|
@@ -59,61 +62,6 @@ ___
|
|
|
59
62
|
|
|
60
63
|
___
|
|
61
64
|
|
|
62
|
-
### FaasDataInjection
|
|
63
|
-
|
|
64
|
-
Ƭ **FaasDataInjection**<`Data`\>: `Object`
|
|
65
|
-
|
|
66
|
-
Injects FaasData props.
|
|
67
|
-
|
|
68
|
-
#### Type parameters
|
|
69
|
-
|
|
70
|
-
| Name | Type |
|
|
71
|
-
| :------ | :------ |
|
|
72
|
-
| `Data` | `any` |
|
|
73
|
-
|
|
74
|
-
#### Type declaration
|
|
75
|
-
|
|
76
|
-
| Name | Type |
|
|
77
|
-
| :------ | :------ |
|
|
78
|
-
| `action` | `string` \| `any` |
|
|
79
|
-
| `data` | `Data` |
|
|
80
|
-
| `error` | `any` |
|
|
81
|
-
| `loading` | `boolean` |
|
|
82
|
-
| `params` | `Record`<`string`, `any`\> |
|
|
83
|
-
| `promise` | `Promise`<[`Response`](classes/Response.md)<`Data`\>\> |
|
|
84
|
-
| `setData` | `React.Dispatch`<`React.SetStateAction`<`Data`\>\> |
|
|
85
|
-
| `setError` | `React.Dispatch`<`React.SetStateAction`<`any`\>\> |
|
|
86
|
-
| `setLoading` | `React.Dispatch`<`React.SetStateAction`<`boolean`\>\> |
|
|
87
|
-
| `setPromise` | `React.Dispatch`<`React.SetStateAction`<`Promise`<[`Response`](classes/Response.md)<`Data`\>\>\>\> |
|
|
88
|
-
| `reload` | (`params?`: `Record`<`string`, `any`\>) => `Promise`<[`Response`](classes/Response.md)<`Data`\>\> |
|
|
89
|
-
|
|
90
|
-
___
|
|
91
|
-
|
|
92
|
-
### FaasDataWrapperProps
|
|
93
|
-
|
|
94
|
-
Ƭ **FaasDataWrapperProps**<`PathOrData`\>: `Object`
|
|
95
|
-
|
|
96
|
-
#### Type parameters
|
|
97
|
-
|
|
98
|
-
| Name | Type |
|
|
99
|
-
| :------ | :------ |
|
|
100
|
-
| `PathOrData` | extends [`FaasAction`](#faasaction) |
|
|
101
|
-
|
|
102
|
-
#### Type declaration
|
|
103
|
-
|
|
104
|
-
| Name | Type | Description |
|
|
105
|
-
| :------ | :------ | :------ |
|
|
106
|
-
| `action` | `string` | - |
|
|
107
|
-
| `children?` | `JSX.Element` | - |
|
|
108
|
-
| `data?` | [`FaasData`](#faasdata)<`PathOrData`\> | use custom data, should work with setData |
|
|
109
|
-
| `fallback?` | `JSX.Element` \| ``false`` | - |
|
|
110
|
-
| `params?` | [`FaasParams`](#faasparams)<`PathOrData`\> | - |
|
|
111
|
-
| `setData?` | `React.Dispatch`<`React.SetStateAction`<[`FaasData`](#faasdata)<`PathOrData`\>\>\> | use custom setData, should work with data |
|
|
112
|
-
| `onDataChange?` | (`args`: [`FaasDataInjection`](#faasdatainjection)<[`FaasData`](#faasdata)<`PathOrData`\>\>) => `void` | - |
|
|
113
|
-
| `render?` | (`args`: [`FaasDataInjection`](#faasdatainjection)<[`FaasData`](#faasdata)<`PathOrData`\>\>) => `Element` \| `Element`[] | - |
|
|
114
|
-
|
|
115
|
-
___
|
|
116
|
-
|
|
117
65
|
### FaasParams
|
|
118
66
|
|
|
119
67
|
Ƭ **FaasParams**<`T`\>: `T` extends `FaasActionPaths` ? `FaasActions`[`T`][``"Params"``] : `any`
|
|
@@ -126,20 +74,6 @@ ___
|
|
|
126
74
|
|
|
127
75
|
___
|
|
128
76
|
|
|
129
|
-
### FaasReactClientInstance
|
|
130
|
-
|
|
131
|
-
Ƭ **FaasReactClientInstance**: `Object`
|
|
132
|
-
|
|
133
|
-
#### Type declaration
|
|
134
|
-
|
|
135
|
-
| Name | Type |
|
|
136
|
-
| :------ | :------ |
|
|
137
|
-
| `faas` | <PathOrData\>(`action`: `string` \| `PathOrData`, `params`: [`FaasParams`](#faasparams)<`PathOrData`\>) => `Promise`<[`Response`](classes/Response.md)<[`FaasData`](#faasdata)<`PathOrData`\>\>\> |
|
|
138
|
-
| `useFaas` | <PathOrData\>(`action`: `string` \| `PathOrData`, `defaultParams`: [`FaasParams`](#faasparams)<`PathOrData`\>, `options?`: { `data?`: [`FaasData`](#faasdata)<`PathOrData`\> ; `setData?`: `React.Dispatch`<`React.SetStateAction`<[`FaasData`](#faasdata)<`PathOrData`\>\>\> ; `skip?`: `boolean` }) => [`FaasDataInjection`](#faasdatainjection)<[`FaasData`](#faasdata)<`PathOrData`\>\> |
|
|
139
|
-
| `FaasDataWrapper` | <PathOrData\>(`props`: [`FaasDataWrapperProps`](#faasdatawrapperprops)<`PathOrData`\>) => `Element` |
|
|
140
|
-
|
|
141
|
-
___
|
|
142
|
-
|
|
143
77
|
### Options
|
|
144
78
|
|
|
145
79
|
Ƭ **Options**: `RequestInit` & { `beforeRequest?`: (`{
|
|
@@ -174,7 +108,7 @@ A data wrapper for react components
|
|
|
174
108
|
|
|
175
109
|
| Name | Type |
|
|
176
110
|
| :------ | :------ |
|
|
177
|
-
| `props` | [`FaasDataWrapperProps`](
|
|
111
|
+
| `props` | [`FaasDataWrapperProps`](interfaces/FaasDataWrapperProps.md)<`PathOrData`\> |
|
|
178
112
|
|
|
179
113
|
#### Returns
|
|
180
114
|
|
|
@@ -195,7 +129,7 @@ ___
|
|
|
195
129
|
|
|
196
130
|
### FaasReactClient
|
|
197
131
|
|
|
198
|
-
▸ **FaasReactClient**(`«destructured»`): [`FaasReactClientInstance`](
|
|
132
|
+
▸ **FaasReactClient**(`«destructured»`): [`FaasReactClientInstance`](interfaces/FaasReactClientInstance.md)
|
|
199
133
|
|
|
200
134
|
Before use faas, you should initialize a FaasReactClient.
|
|
201
135
|
|
|
@@ -210,7 +144,7 @@ Before use faas, you should initialize a FaasReactClient.
|
|
|
210
144
|
|
|
211
145
|
#### Returns
|
|
212
146
|
|
|
213
|
-
[`FaasReactClientInstance`](
|
|
147
|
+
[`FaasReactClientInstance`](interfaces/FaasReactClientInstance.md)
|
|
214
148
|
|
|
215
149
|
```ts
|
|
216
150
|
const client = FaasReactClient({
|
|
@@ -253,7 +187,7 @@ ___
|
|
|
253
187
|
|
|
254
188
|
### getClient
|
|
255
189
|
|
|
256
|
-
▸ **getClient**(`domain?`): [`FaasReactClientInstance`](
|
|
190
|
+
▸ **getClient**(`domain?`): [`FaasReactClientInstance`](interfaces/FaasReactClientInstance.md)
|
|
257
191
|
|
|
258
192
|
Get FaasReactClient instance
|
|
259
193
|
|
|
@@ -265,7 +199,7 @@ Get FaasReactClient instance
|
|
|
265
199
|
|
|
266
200
|
#### Returns
|
|
267
201
|
|
|
268
|
-
[`FaasReactClientInstance`](
|
|
202
|
+
[`FaasReactClientInstance`](interfaces/FaasReactClientInstance.md)
|
|
269
203
|
|
|
270
204
|
```ts
|
|
271
205
|
getClient()
|
|
@@ -277,7 +211,7 @@ ___
|
|
|
277
211
|
|
|
278
212
|
### useFaas
|
|
279
213
|
|
|
280
|
-
▸ **useFaas**<`PathOrData`\>(`action`, `defaultParams`, `options?`): [`FaasDataInjection`](
|
|
214
|
+
▸ **useFaas**<`PathOrData`\>(`action`, `defaultParams`, `options?`): [`FaasDataInjection`](interfaces/FaasDataInjection.md)<[`FaasData`](#faasdata)<`PathOrData`\>\>
|
|
281
215
|
|
|
282
216
|
Request faas server with React hook
|
|
283
217
|
|
|
@@ -300,7 +234,7 @@ Request faas server with React hook
|
|
|
300
234
|
|
|
301
235
|
#### Returns
|
|
302
236
|
|
|
303
|
-
[`FaasDataInjection`](
|
|
237
|
+
[`FaasDataInjection`](interfaces/FaasDataInjection.md)<[`FaasData`](#faasdata)<`PathOrData`\>\>
|
|
304
238
|
|
|
305
239
|
```ts
|
|
306
240
|
function Post ({ id }) {
|
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,12 @@
|
|
|
1
1
|
import { Response, Options, ResponseError } from '@faasjs/browser';
|
|
2
2
|
export { FaasBrowserClient, Options, Response, ResponseError, ResponseHeaders } from '@faasjs/browser';
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
|
|
4
|
+
interface FaasActions {
|
|
5
|
+
}
|
|
6
|
+
type FaasActionPaths = keyof FaasActions;
|
|
7
|
+
type FaasAction = FaasActionPaths | Record<string, any>;
|
|
8
|
+
type FaasParams<T = any> = T extends FaasActionPaths ? FaasActions[T]['Params'] : any;
|
|
9
|
+
type FaasData<T = any> = T extends FaasActionPaths ? FaasActions[T]['Data'] : T;
|
|
5
10
|
|
|
6
11
|
/**
|
|
7
12
|
* Injects FaasData props.
|
|
@@ -119,4 +124,4 @@ declare function useFaas<PathOrData extends FaasAction>(action: string | PathOrD
|
|
|
119
124
|
*/
|
|
120
125
|
declare function FaasDataWrapper<PathOrData extends FaasAction>(props: FaasDataWrapperProps<PathOrData>): JSX.Element;
|
|
121
126
|
|
|
122
|
-
export { FaasDataInjection, FaasDataWrapper, FaasDataWrapperProps, FaasReactClient, FaasReactClientInstance, faas, getClient, useFaas };
|
|
127
|
+
export { FaasAction, FaasData, FaasDataInjection, FaasDataWrapper, FaasDataWrapperProps, FaasParams, FaasReactClient, FaasReactClientInstance, faas, getClient, useFaas };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@faasjs/react",
|
|
3
|
-
"version": "0.0.3-beta.
|
|
3
|
+
"version": "0.0.3-beta.42",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/index.mjs",
|
|
@@ -22,9 +22,10 @@
|
|
|
22
22
|
"files": [
|
|
23
23
|
"dist"
|
|
24
24
|
],
|
|
25
|
+
"dependencies": {
|
|
26
|
+
"@faasjs/browser": "^0.0.3-beta.42"
|
|
27
|
+
},
|
|
25
28
|
"peerDependencies": {
|
|
26
|
-
"@faasjs/browser": "*",
|
|
27
|
-
"@faasjs/types": "*",
|
|
28
29
|
"react": "*"
|
|
29
30
|
},
|
|
30
31
|
"devDependencies": {
|