Hooks overview
Added in v1.0.0
Table of contents
hooks
useRx
Signature
export declare const useRx: <R, W>(
rx: Rx.Writable<R, W>
) => readonly [value: R, setOrUpdate: (_: W | ((_: R) => W)) => void]
Added in v1.0.0
useRxInitialValues
Signature
export declare const useRxInitialValues: (initialValues: Iterable<readonly [Rx.Rx<any>, any]>) => void
Added in v1.0.0
useRxMount
Signature
export declare const useRxMount: <A>(rx: Rx.Rx<A>) => void
Added in v1.0.0
useRxRef
Signature
export declare const useRxRef: <A>(ref: RxRef.ReadonlyRef<A>) => A
Added in v1.0.0
useRxRefProp
Signature
export declare const useRxRefProp: <A, K extends keyof A>(ref: RxRef.RxRef<A>, prop: K) => RxRef.RxRef<A[K]>
Added in v1.0.0
useRxRefPropValue
Signature
export declare const useRxRefPropValue: <A, K extends keyof A>(ref: RxRef.RxRef<A>, prop: K) => A[K]
Added in v1.0.0
useRxRefresh
Signature
export declare const useRxRefresh: <A>(rx: Rx.Rx<A>) => () => void
Added in v1.0.0
useRxSet
Signature
export declare const useRxSet: <R, W>(rx: Rx.Writable<R, W>) => (_: W | ((_: R) => W)) => void
Added in v1.0.0
useRxSetPromise
Signature
export declare const useRxSetPromise: <E, A, W>(
rx: Rx.Writable<Result.Result<A, E>, W>
) => (_: W, options?: { readonly signal?: AbortSignal | undefined } | undefined) => Promise<Exit.Exit<A, E>>
Added in v1.0.0
useRxSubscribe
Signature
export declare const useRxSubscribe: <A>(
rx: Rx.Rx<A>,
f: (_: A) => void,
options?: { readonly immediate?: boolean }
) => void
Added in v1.0.0
useRxSuspense
Signature
export declare const useRxSuspense: <A, E>(
rx: Rx.Rx<Result.Result<A, E>>,
options?: { readonly suspendOnWaiting?: boolean }
) => Result.Success<A, E> | Result.Failure<A, E>
Added in v1.0.0
useRxSuspenseSuccess
Signature
export declare const useRxSuspenseSuccess: <A, E>(
rx: Rx.Rx<Result.Result<A, E>>,
options?: { readonly suspendOnWaiting?: boolean }
) => Result.Success<A, E>
Added in v1.0.0
useRxValue
Signature
export declare const useRxValue: { <A>(rx: Rx.Rx<A>): A; <A, B>(rx: Rx.Rx<A>, f: (_: A) => B): B }
Added in v1.0.0