@faasjs/react 0.0.4-beta.16 → 0.0.4-beta.17
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 +26 -4
- package/dist/index.d.mts +7 -6
- package/dist/index.d.ts +7 -6
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -33,6 +33,7 @@ React plugin for FaasJS.
|
|
|
33
33
|
- [FaasDataWrapperProps](#faasdatawrapperprops)
|
|
34
34
|
- [FaasParams](#faasparams)
|
|
35
35
|
- [FaasReactClientInstance](#faasreactclientinstance)
|
|
36
|
+
- [FaasReactClientOptions](#faasreactclientoptions)
|
|
36
37
|
- [Options](#options)
|
|
37
38
|
- [ResponseHeaders](#responseheaders)
|
|
38
39
|
- [SignalOptions](#signaloptions)
|
|
@@ -165,6 +166,20 @@ ___
|
|
|
165
166
|
|
|
166
167
|
___
|
|
167
168
|
|
|
169
|
+
### FaasReactClientOptions
|
|
170
|
+
|
|
171
|
+
Ƭ **FaasReactClientOptions**: `Object`
|
|
172
|
+
|
|
173
|
+
#### Type declaration
|
|
174
|
+
|
|
175
|
+
| Name | Type |
|
|
176
|
+
| :------ | :------ |
|
|
177
|
+
| `domain` | `string` |
|
|
178
|
+
| `onError?` | (`action`: `string`, `params`: `Record`\<`string`, `any`\>) => (`res`: [`ResponseError`](classes/ResponseError.md)) => `Promise`\<`void`\> |
|
|
179
|
+
| `options?` | [`Options`](#options) |
|
|
180
|
+
|
|
181
|
+
___
|
|
182
|
+
|
|
168
183
|
### Options
|
|
169
184
|
|
|
170
185
|
Ƭ **Options**: `RequestInit` & \{ `beforeRequest?`: (`{
|
|
@@ -264,10 +279,7 @@ Before use faas, you should initialize a FaasReactClient.
|
|
|
264
279
|
|
|
265
280
|
| Name | Type |
|
|
266
281
|
| :------ | :------ |
|
|
267
|
-
| `«destructured»` | `
|
|
268
|
-
| › `domain` | `string` |
|
|
269
|
-
| › `onError?` | (`action`: `string`, `params`: `Record`\<`string`, `any`\>) => (`res`: [`ResponseError`](classes/ResponseError.md)) => `Promise`\<`void`\> |
|
|
270
|
-
| › `options?` | [`Options`](#options) |
|
|
282
|
+
| `«destructured»` | [`FaasReactClientOptions`](#faasreactclientoptions) |
|
|
271
283
|
|
|
272
284
|
#### Returns
|
|
273
285
|
|
|
@@ -359,6 +371,16 @@ Create a [signal](https://preactjs.com/guide/v10/signals) with options
|
|
|
359
371
|
|
|
360
372
|
`Signal`\<`T`\>
|
|
361
373
|
|
|
374
|
+
**`Example`**
|
|
375
|
+
|
|
376
|
+
```ts
|
|
377
|
+
import { signal } from '@faasjs/react'
|
|
378
|
+
|
|
379
|
+
const count = signal(0, { debugName: 'count' })
|
|
380
|
+
|
|
381
|
+
count.value = 1
|
|
382
|
+
```
|
|
383
|
+
|
|
362
384
|
___
|
|
363
385
|
|
|
364
386
|
### useFaas
|
package/dist/index.d.mts
CHANGED
|
@@ -66,6 +66,11 @@ type useFaasOptions<PathOrData extends FaasAction> = {
|
|
|
66
66
|
debounce?: number
|
|
67
67
|
}
|
|
68
68
|
|
|
69
|
+
type FaasReactClientOptions = {
|
|
70
|
+
domain: string;
|
|
71
|
+
options?: Options;
|
|
72
|
+
onError?: (action: string, params: Record<string, any>) => (res: ResponseError) => Promise<void>;
|
|
73
|
+
};
|
|
69
74
|
/**
|
|
70
75
|
* Before use faas, you should initialize a FaasReactClient.
|
|
71
76
|
*
|
|
@@ -79,11 +84,7 @@ type useFaasOptions<PathOrData extends FaasAction> = {
|
|
|
79
84
|
* })
|
|
80
85
|
* ```
|
|
81
86
|
*/
|
|
82
|
-
declare function FaasReactClient({ domain, options, onError, }:
|
|
83
|
-
domain: string;
|
|
84
|
-
options?: Options;
|
|
85
|
-
onError?: (action: string, params: Record<string, any>) => (res: ResponseError) => Promise<void>;
|
|
86
|
-
}): FaasReactClientInstance;
|
|
87
|
+
declare function FaasReactClient({ domain, options, onError, }: FaasReactClientOptions): FaasReactClientInstance;
|
|
87
88
|
/**
|
|
88
89
|
* Get FaasReactClient instance
|
|
89
90
|
* @param domain {string} empty string for default domain
|
|
@@ -184,4 +185,4 @@ type SignalOptions = {
|
|
|
184
185
|
*/
|
|
185
186
|
declare function signal<T = any>(initialValue: any, options?: SignalOptions): _preact_signals_core.Signal<T>;
|
|
186
187
|
|
|
187
|
-
export { ErrorBoundary, ErrorBoundaryProps, ErrorChildrenProps, FaasDataInjection, FaasDataWrapper, FaasDataWrapperProps, FaasReactClient, FaasReactClientInstance, SignalOptions, faas, getClient, signal, useFaas, useFaasOptions };
|
|
188
|
+
export { ErrorBoundary, type ErrorBoundaryProps, type ErrorChildrenProps, type FaasDataInjection, FaasDataWrapper, type FaasDataWrapperProps, FaasReactClient, type FaasReactClientInstance, type FaasReactClientOptions, type SignalOptions, faas, getClient, signal, useFaas, type useFaasOptions };
|
package/dist/index.d.ts
CHANGED
|
@@ -66,6 +66,11 @@ type useFaasOptions<PathOrData extends FaasAction> = {
|
|
|
66
66
|
debounce?: number
|
|
67
67
|
}
|
|
68
68
|
|
|
69
|
+
type FaasReactClientOptions = {
|
|
70
|
+
domain: string;
|
|
71
|
+
options?: Options;
|
|
72
|
+
onError?: (action: string, params: Record<string, any>) => (res: ResponseError) => Promise<void>;
|
|
73
|
+
};
|
|
69
74
|
/**
|
|
70
75
|
* Before use faas, you should initialize a FaasReactClient.
|
|
71
76
|
*
|
|
@@ -79,11 +84,7 @@ type useFaasOptions<PathOrData extends FaasAction> = {
|
|
|
79
84
|
* })
|
|
80
85
|
* ```
|
|
81
86
|
*/
|
|
82
|
-
declare function FaasReactClient({ domain, options, onError, }:
|
|
83
|
-
domain: string;
|
|
84
|
-
options?: Options;
|
|
85
|
-
onError?: (action: string, params: Record<string, any>) => (res: ResponseError) => Promise<void>;
|
|
86
|
-
}): FaasReactClientInstance;
|
|
87
|
+
declare function FaasReactClient({ domain, options, onError, }: FaasReactClientOptions): FaasReactClientInstance;
|
|
87
88
|
/**
|
|
88
89
|
* Get FaasReactClient instance
|
|
89
90
|
* @param domain {string} empty string for default domain
|
|
@@ -184,4 +185,4 @@ type SignalOptions = {
|
|
|
184
185
|
*/
|
|
185
186
|
declare function signal<T = any>(initialValue: any, options?: SignalOptions): _preact_signals_core.Signal<T>;
|
|
186
187
|
|
|
187
|
-
export { ErrorBoundary, ErrorBoundaryProps, ErrorChildrenProps, FaasDataInjection, FaasDataWrapper, FaasDataWrapperProps, FaasReactClient, FaasReactClientInstance, SignalOptions, faas, getClient, signal, useFaas, useFaasOptions };
|
|
188
|
+
export { ErrorBoundary, type ErrorBoundaryProps, type ErrorChildrenProps, type FaasDataInjection, FaasDataWrapper, type FaasDataWrapperProps, FaasReactClient, type FaasReactClientInstance, type FaasReactClientOptions, type SignalOptions, faas, getClient, signal, useFaas, type useFaasOptions };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@faasjs/react",
|
|
3
|
-
"version": "0.0.4-beta.
|
|
3
|
+
"version": "0.0.4-beta.17",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/index.mjs",
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
"dist"
|
|
23
23
|
],
|
|
24
24
|
"dependencies": {
|
|
25
|
-
"@faasjs/browser": "0.0.4-beta.
|
|
25
|
+
"@faasjs/browser": "0.0.4-beta.17"
|
|
26
26
|
},
|
|
27
27
|
"peerDependencies": {
|
|
28
28
|
"react": "*",
|