@faasjs/react 0.0.2-beta.396 → 0.0.2-beta.399

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.
Files changed (4) hide show
  1. package/README.md +50 -17
  2. package/dist/index.d.ts +1 -0
  3. package/dist/index.mjs +0 -2
  4. package/package.json +3 -3
package/README.md CHANGED
@@ -20,8 +20,11 @@ React plugin for FaasJS.
20
20
 
21
21
  ### Type Aliases
22
22
 
23
+ - [FaasAction](#faasaction)
24
+ - [FaasData](#faasdata)
23
25
  - [FaasDataInjection](#faasdatainjection)
24
26
  - [FaasDataWrapperProps](#faasdatawrapperprops)
27
+ - [FaasParams](#faasparams)
25
28
  - [FaasReactClientInstance](#faasreactclientinstance)
26
29
  - [Options](#options)
27
30
  - [ResponseHeaders](#responseheaders)
@@ -36,6 +39,24 @@ React plugin for FaasJS.
36
39
 
37
40
  ## Type Aliases
38
41
 
42
+ ### FaasAction
43
+
44
+ Ƭ **FaasAction**: `FaasActionPaths` \| `Record`<`string`, `any`\>
45
+
46
+ ___
47
+
48
+ ### FaasData
49
+
50
+ Ƭ **FaasData**<`T`\>: `T` extends `FaasActionPaths` ? `FaasActions`[`T`][``"Data"``] : `T`
51
+
52
+ #### Type parameters
53
+
54
+ | Name | Type |
55
+ | :------ | :------ |
56
+ | `T` | `any` |
57
+
58
+ ___
59
+
39
60
  ### FaasDataInjection
40
61
 
41
62
  Ƭ **FaasDataInjection**<`Data`\>: `Object`
@@ -74,19 +95,31 @@ ___
74
95
 
75
96
  | Name | Type |
76
97
  | :------ | :------ |
77
- | `PathOrData` | extends `FaasAction` |
98
+ | `PathOrData` | extends [`FaasAction`](#faasaction) |
78
99
 
79
100
  #### Type declaration
80
101
 
81
102
  | Name | Type | Description |
82
103
  | :------ | :------ | :------ |
83
104
  | `action` | `string` | - |
84
- | `data?` | `FaasData`<`PathOrData`\> | use custom data, should work with setData |
105
+ | `data?` | [`FaasData`](#faasdata)<`PathOrData`\> | use custom data, should work with setData |
85
106
  | `fallback?` | `JSX.Element` \| ``false`` | - |
86
- | `params?` | `FaasParams`<`PathOrData`\> | - |
87
- | `setData?` | `React.Dispatch`<`React.SetStateAction`<`FaasData`<`PathOrData`\>\>\> | use custom setData, should work with data |
88
- | `onDataChange?` | (`args`: [`FaasDataInjection`](#faasdatainjection)<`FaasData`<`PathOrData`\>\>) => `void` | - |
89
- | `render?` | (`args`: [`FaasDataInjection`](#faasdatainjection)<`FaasData`<`PathOrData`\>\>) => `Element` \| `Element`[] | - |
107
+ | `params?` | [`FaasParams`](#faasparams)<`PathOrData`\> | - |
108
+ | `setData?` | `React.Dispatch`<`React.SetStateAction`<[`FaasData`](#faasdata)<`PathOrData`\>\>\> | use custom setData, should work with data |
109
+ | `onDataChange?` | (`args`: [`FaasDataInjection`](#faasdatainjection)<[`FaasData`](#faasdata)<`PathOrData`\>\>) => `void` | - |
110
+ | `render?` | (`args`: [`FaasDataInjection`](#faasdatainjection)<[`FaasData`](#faasdata)<`PathOrData`\>\>) => `Element` \| `Element`[] | - |
111
+
112
+ ___
113
+
114
+ ### FaasParams
115
+
116
+ Ƭ **FaasParams**<`T`\>: `T` extends `FaasActionPaths` ? `FaasActions`[`T`][``"Params"``] : `any`
117
+
118
+ #### Type parameters
119
+
120
+ | Name | Type |
121
+ | :------ | :------ |
122
+ | `T` | `any` |
90
123
 
91
124
  ___
92
125
 
@@ -98,8 +131,8 @@ ___
98
131
 
99
132
  | Name | Type |
100
133
  | :------ | :------ |
101
- | `faas` | <PathOrData\>(`action`: `string` \| `PathOrData`, `params`: `FaasParams`<`PathOrData`\>) => `Promise`<[`Response`](classes/Response.md)<`FaasData`<`PathOrData`\>\>\> |
102
- | `useFaas` | <PathOrData\>(`action`: `string` \| `PathOrData`, `defaultParams`: `FaasParams`<`PathOrData`\>) => [`FaasDataInjection`](#faasdatainjection)<`FaasData`<`PathOrData`\>\> |
134
+ | `faas` | <PathOrData\>(`action`: `string` \| `PathOrData`, `params`: [`FaasParams`](#faasparams)<`PathOrData`\>) => `Promise`<[`Response`](classes/Response.md)<[`FaasData`](#faasdata)<`PathOrData`\>\>\> |
135
+ | `useFaas` | <PathOrData\>(`action`: `string` \| `PathOrData`, `defaultParams`: [`FaasParams`](#faasparams)<`PathOrData`\>) => [`FaasDataInjection`](#faasdatainjection)<[`FaasData`](#faasdata)<`PathOrData`\>\> |
103
136
  | `FaasDataWrapper` | <PathOrData\>(`props`: [`FaasDataWrapperProps`](#faasdatawrapperprops)<`PathOrData`\>) => `Element` |
104
137
 
105
138
  ___
@@ -132,7 +165,7 @@ A data wrapper for react components
132
165
 
133
166
  | Name | Type |
134
167
  | :------ | :------ |
135
- | `PathOrData` | extends `FaasAction` |
168
+ | `PathOrData` | extends `Record`<`string`, `any`\> |
136
169
 
137
170
  #### Parameters
138
171
 
@@ -186,7 +219,7 @@ ___
186
219
 
187
220
  ### faas
188
221
 
189
- ▸ **faas**<`PathOrData`\>(`action`, `params`): `Promise`<[`Response`](classes/Response.md)<`FaasData`<`PathOrData`\>\>\>
222
+ ▸ **faas**<`PathOrData`\>(`action`, `params`): `Promise`<[`Response`](classes/Response.md)<[`FaasData`](#faasdata)<`PathOrData`\>\>\>
190
223
 
191
224
  Request faas server
192
225
 
@@ -194,18 +227,18 @@ Request faas server
194
227
 
195
228
  | Name | Type |
196
229
  | :------ | :------ |
197
- | `PathOrData` | extends `FaasAction` |
230
+ | `PathOrData` | extends `Record`<`string`, `any`\> |
198
231
 
199
232
  #### Parameters
200
233
 
201
234
  | Name | Type | Description |
202
235
  | :------ | :------ | :------ |
203
236
  | `action` | `string` \| `PathOrData` | {string} action name |
204
- | `params` | `FaasParams`<`PathOrData`\> | {object} action params |
237
+ | `params` | [`FaasParams`](#faasparams)<`PathOrData`\> | {object} action params |
205
238
 
206
239
  #### Returns
207
240
 
208
- `Promise`<[`Response`](classes/Response.md)<`FaasData`<`PathOrData`\>\>\>
241
+ `Promise`<[`Response`](classes/Response.md)<[`FaasData`](#faasdata)<`PathOrData`\>\>\>
209
242
 
210
243
  ```ts
211
244
  faas<{ title: string }>('post/get', { id: 1 }).then(res => {
@@ -241,7 +274,7 @@ ___
241
274
 
242
275
  ### useFaas
243
276
 
244
- ▸ **useFaas**<`PathOrData`\>(`action`, `defaultParams`): [`FaasDataInjection`](#faasdatainjection)<`FaasData`<`PathOrData`\>\>
277
+ ▸ **useFaas**<`PathOrData`\>(`action`, `defaultParams`): [`FaasDataInjection`](#faasdatainjection)<[`FaasData`](#faasdata)<`PathOrData`\>\>
245
278
 
246
279
  Request faas server with React hook
247
280
 
@@ -249,18 +282,18 @@ Request faas server with React hook
249
282
 
250
283
  | Name | Type |
251
284
  | :------ | :------ |
252
- | `PathOrData` | extends `FaasAction` |
285
+ | `PathOrData` | extends `Record`<`string`, `any`\> |
253
286
 
254
287
  #### Parameters
255
288
 
256
289
  | Name | Type | Description |
257
290
  | :------ | :------ | :------ |
258
291
  | `action` | `string` \| `PathOrData` | {string} action name |
259
- | `defaultParams` | `FaasParams`<`PathOrData`\> | {object} initial action params |
292
+ | `defaultParams` | [`FaasParams`](#faasparams)<`PathOrData`\> | {object} initial action params |
260
293
 
261
294
  #### Returns
262
295
 
263
- [`FaasDataInjection`](#faasdatainjection)<`FaasData`<`PathOrData`\>\>
296
+ [`FaasDataInjection`](#faasdatainjection)<[`FaasData`](#faasdata)<`PathOrData`\>\>
264
297
 
265
298
  ```ts
266
299
  function Post ({ id }) {
package/dist/index.d.ts CHANGED
@@ -1,6 +1,7 @@
1
1
  import { Response, Options, ResponseError } from '@faasjs/browser';
2
2
  export { FaasBrowserClient, Options, Response, ResponseError, ResponseHeaders } from '@faasjs/browser';
3
3
  import { FaasAction, FaasData, FaasParams } from '@faasjs/types';
4
+ export { FaasAction, FaasData, FaasParams } from '@faasjs/types';
4
5
 
5
6
  /**
6
7
  * Injects FaasData props.
package/dist/index.mjs CHANGED
@@ -1,5 +1,3 @@
1
- "use strict";
2
-
3
1
  // src/index.tsx
4
2
  import {
5
3
  FaasBrowserClient
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@faasjs/react",
3
- "version": "0.0.2-beta.396",
3
+ "version": "0.0.2-beta.399",
4
4
  "license": "MIT",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -23,8 +23,8 @@
23
23
  "dist"
24
24
  ],
25
25
  "peerDependencies": {
26
- "@faasjs/browser": "^0.0.2-beta.396",
27
- "@faasjs/types": "^0.0.2-beta.396",
26
+ "@faasjs/browser": "^0.0.2-beta.399",
27
+ "@faasjs/types": "^0.0.2-beta.399",
28
28
  "react": "*"
29
29
  },
30
30
  "devDependencies": {