Skip to content

Commit 6908296

Browse files
committed
update docs
1 parent 05261fd commit 6908296

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

docs/rx-react/index.ts.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Added in v1.0.0
1414

1515
- [context](#context)
1616
- [RegistryContext](#registrycontext)
17+
- [RegistryProvider](#registryprovider)
18+
- [scheduleTask](#scheduletask)
1719
- [hooks](#hooks)
1820
- [useRx](#userx)
1921
- [useRxInitialValues](#userxinitialvalues)
@@ -48,6 +50,32 @@ export declare const RegistryContext: React.Context<Registry.Registry>
4850
4951
Added in v1.0.0
5052
53+
## RegistryProvider
54+
55+
**Signature**
56+
57+
```ts
58+
export declare const RegistryProvider: (options: {
59+
readonly children?: React.ReactNode | undefined
60+
readonly initialValues?: Iterable<readonly [Rx.Rx<any>, any]> | undefined
61+
readonly scheduleTask?: ((f: () => void) => void) | undefined
62+
readonly timeoutResolution?: number | undefined
63+
readonly defaultIdleTTL?: number | undefined
64+
}) => React.FunctionComponentElement<React.ProviderProps<Registry.Registry>>
65+
```
66+
67+
Added in v1.0.0
68+
69+
## scheduleTask
70+
71+
**Signature**
72+
73+
```ts
74+
export declare function scheduleTask(f: () => void): void
75+
```
76+
77+
Added in v1.0.0
78+
5179
# hooks
5280

5381
## useRx

0 commit comments

Comments
 (0)