@faasjs/react 0.0.2-beta.394 → 0.0.2-beta.397

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 +59 -24
  2. package/dist/index.d.ts +1 -0
  3. package/dist/index.js +1 -0
  4. package/package.json +3 -3
package/README.md CHANGED
@@ -18,10 +18,13 @@ React plugin for FaasJS.
18
18
  - [Response](classes/Response.md)
19
19
  - [ResponseError](classes/ResponseError.md)
20
20
 
21
- ### Type aliases
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)
@@ -34,7 +37,25 @@ React plugin for FaasJS.
34
37
  - [getClient](#getclient)
35
38
  - [useFaas](#usefaas)
36
39
 
37
- ## Type aliases
40
+ ## Type Aliases
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
+ ___
38
59
 
39
60
  ### FaasDataInjection
40
61
 
@@ -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,15 +131,17 @@ ___
98
131
 
99
132
  | Name | Type |
100
133
  | :------ | :------ |
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`\>\> |
101
136
  | `FaasDataWrapper` | <PathOrData\>(`props`: [`FaasDataWrapperProps`](#faasdatawrapperprops)<`PathOrData`\>) => `Element` |
102
- | `faas` | <PathOrData\>(`action`: `string` \| `PathOrData`, `params`: `FaasParams`<`PathOrData`\>) => `Promise`<[`Response`](classes/Response.md)<`FaasData`<`PathOrData`\>\>\> |
103
- | `useFaas` | <PathOrData\>(`action`: `string` \| `PathOrData`, `defaultParams`: `FaasParams`<`PathOrData`\>) => [`FaasDataInjection`](#faasdatainjection)<`FaasData`<`PathOrData`\>\> |
104
137
 
105
138
  ___
106
139
 
107
140
  ### Options
108
141
 
109
- Ƭ **Options**: `RequestInit` & { `headers?`: { `[key: string]`: `string`; } ; `beforeRequest?`: (`__namedParameters`: { `action`: `string` ; `options`: [`Options`](#options) ; `params`: `Record`<`string`, `any`\> }) => `void` \| `Promise`<`void`\> }
142
+ Ƭ **Options**: `RequestInit` & { `beforeRequest?`: (`{
143
+ action, params, options
144
+ }`: { `action`: `string` ; `options`: [`Options`](#options) ; `params`: `Record`<`string`, `any`\> }) => `Promise`<`void`\> \| `void` ; `headers?`: { `[key: string]`: `string`; } }
110
145
 
111
146
  ___
112
147
 
@@ -130,7 +165,7 @@ A data wrapper for react components
130
165
 
131
166
  | Name | Type |
132
167
  | :------ | :------ |
133
- | `PathOrData` | extends `FaasAction` |
168
+ | `PathOrData` | extends `Record`<`string`, `any`\> |
134
169
 
135
170
  #### Parameters
136
171
 
@@ -167,8 +202,8 @@ Before use faas, you should initialize a FaasReactClient.
167
202
  | :------ | :------ |
168
203
  | `__namedParameters` | `Object` |
169
204
  | `__namedParameters.domain` | `string` |
170
- | `__namedParameters.options?` | [`Options`](#options) |
171
205
  | `__namedParameters.onError?` | (`action`: `string`, `params`: `Record`<`string`, `any`\>) => (`res`: [`ResponseError`](classes/ResponseError.md)) => `Promise`<`void`\> |
206
+ | `__namedParameters.options?` | [`Options`](#options) |
172
207
 
173
208
  #### Returns
174
209
 
@@ -184,7 +219,7 @@ ___
184
219
 
185
220
  ### faas
186
221
 
187
- ▸ **faas**<`PathOrData`\>(`action`, `params`): `Promise`<[`Response`](classes/Response.md)<`FaasData`<`PathOrData`\>\>\>
222
+ ▸ **faas**<`PathOrData`\>(`action`, `params`): `Promise`<[`Response`](classes/Response.md)<[`FaasData`](#faasdata)<`PathOrData`\>\>\>
188
223
 
189
224
  Request faas server
190
225
 
@@ -192,18 +227,18 @@ Request faas server
192
227
 
193
228
  | Name | Type |
194
229
  | :------ | :------ |
195
- | `PathOrData` | extends `FaasAction` |
230
+ | `PathOrData` | extends `Record`<`string`, `any`\> |
196
231
 
197
232
  #### Parameters
198
233
 
199
234
  | Name | Type | Description |
200
235
  | :------ | :------ | :------ |
201
- | `action` | `string` \| `PathOrData` | action name |
202
- | `params` | `FaasParams`<`PathOrData`\> | action params |
236
+ | `action` | `string` \| `PathOrData` | {string} action name |
237
+ | `params` | [`FaasParams`](#faasparams)<`PathOrData`\> | {object} action params |
203
238
 
204
239
  #### Returns
205
240
 
206
- `Promise`<[`Response`](classes/Response.md)<`FaasData`<`PathOrData`\>\>\>
241
+ `Promise`<[`Response`](classes/Response.md)<[`FaasData`](#faasdata)<`PathOrData`\>\>\>
207
242
 
208
243
  ```ts
209
244
  faas<{ title: string }>('post/get', { id: 1 }).then(res => {
@@ -223,7 +258,7 @@ Get FaasReactClient instance
223
258
 
224
259
  | Name | Type | Description |
225
260
  | :------ | :------ | :------ |
226
- | `domain?` | `string` | empty string for default domain |
261
+ | `domain?` | `string` | {string} empty string for default domain |
227
262
 
228
263
  #### Returns
229
264
 
@@ -239,7 +274,7 @@ ___
239
274
 
240
275
  ### useFaas
241
276
 
242
- ▸ **useFaas**<`PathOrData`\>(`action`, `defaultParams`): [`FaasDataInjection`](#faasdatainjection)<`FaasData`<`PathOrData`\>\>
277
+ ▸ **useFaas**<`PathOrData`\>(`action`, `defaultParams`): [`FaasDataInjection`](#faasdatainjection)<[`FaasData`](#faasdata)<`PathOrData`\>\>
243
278
 
244
279
  Request faas server with React hook
245
280
 
@@ -247,18 +282,18 @@ Request faas server with React hook
247
282
 
248
283
  | Name | Type |
249
284
  | :------ | :------ |
250
- | `PathOrData` | extends `FaasAction` |
285
+ | `PathOrData` | extends `Record`<`string`, `any`\> |
251
286
 
252
287
  #### Parameters
253
288
 
254
289
  | Name | Type | Description |
255
290
  | :------ | :------ | :------ |
256
- | `action` | `string` \| `PathOrData` | action name |
257
- | `defaultParams` | `FaasParams`<`PathOrData`\> | initial action params |
291
+ | `action` | `string` \| `PathOrData` | {string} action name |
292
+ | `defaultParams` | [`FaasParams`](#faasparams)<`PathOrData`\> | {object} initial action params |
258
293
 
259
294
  #### Returns
260
295
 
261
- [`FaasDataInjection`](#faasdatainjection)<`FaasData`<`PathOrData`\>\>
296
+ [`FaasDataInjection`](#faasdatainjection)<[`FaasData`](#faasdata)<`PathOrData`\>\>
262
297
 
263
298
  ```ts
264
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.js CHANGED
@@ -1,3 +1,4 @@
1
+ "use strict";
1
2
  var __defProp = Object.defineProperty;
2
3
  var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
3
4
  var __getOwnPropNames = Object.getOwnPropertyNames;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@faasjs/react",
3
- "version": "0.0.2-beta.394",
3
+ "version": "0.0.2-beta.397",
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.394",
27
- "@faasjs/types": "^0.0.2-beta.394",
26
+ "@faasjs/browser": "^0.0.2-beta.397",
27
+ "@faasjs/types": "^0.0.2-beta.397",
28
28
  "react": "*"
29
29
  },
30
30
  "devDependencies": {