docs

tim-smart · Aug 6, 2024 · 5782977 · 5782977
1 parent 5157aba
commit 5782977
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 4 deletions.
diff --git a/docs/rx-react/index.ts.md b/docs/rx-react/index.ts.md
@@ -16,6 +16,7 @@ Added in v1.0.0
   - [RegistryContext](#registrycontext)
 - [hooks](#hooks)
   - [useRx](#userx)
+  - [useRxInitialValues](#userxinitialvalues)
   - [useRxMount](#userxmount)
   - [useRxRef](#userxref)
   - [useRxRefProp](#userxrefprop)
@@ -61,6 +62,16 @@ export declare const useRx: <R, W>(
 
 Added in v1.0.0
 
+## useRxInitialValues
+
+**Signature**
+
+```ts
+export declare const useRxInitialValues: (initialValues: Iterable<readonly [Rx.Rx<any>, any]>) => void
+```
+
+Added in v1.0.0
+
 ## useRxMount
 
 **Signature**

diff --git a/docs/rx-vue/index.ts.md b/docs/rx-vue/index.ts.md
@@ -36,7 +36,7 @@ Added in v1.0.0
 **Signature**
 
 ```ts
-export declare const useRx: <R, W>(rx: Rx.Writable<R, W>) => readonly [Readonly<Ref<R>>, (_: W) => void]
+export declare const useRx: <R, W>(rx: Rx.Writable<R, W>) => readonly [Readonly<Ref<R, R>>, (_: W) => void]
 ```
 
 Added in v1.0.0
@@ -46,7 +46,7 @@ Added in v1.0.0
 **Signature**
 
 ```ts
-export declare const useRxRef: <A>(rxRef: RxRef.ReadonlyRef<A>) => Readonly<Ref<A>>
+export declare const useRxRef: <A>(rxRef: RxRef.ReadonlyRef<A>) => Readonly<Ref<A, A>>
 ```
 
 Added in v1.0.0
@@ -66,7 +66,7 @@ Added in v1.0.0
 **Signature**
 
 ```ts
-export declare const useRxValue: <A>(rx: Rx.Rx<A>) => Readonly<Ref<A>>
+export declare const useRxValue: <A>(rx: Rx.Rx<A>) => Readonly<Ref<A, A>>
 ```
 
 Added in v1.0.0

diff --git a/packages/rx/src/Rx.ts b/packages/rx/src/Rx.ts
@@ -1,7 +1,7 @@
-/* eslint-disable @typescript-eslint/no-empty-object-type */
 /**
  * @since 1.0.0
  */
+/* eslint-disable @typescript-eslint/no-empty-object-type */
 import { NoSuchElementException } from "effect/Cause"
 import * as Chunk from "effect/Chunk"
 import * as Duration from "effect/Duration"