Skip to content

Commit

Permalink
docs & lint
Browse files Browse the repository at this point in the history
  • Loading branch information
tim-smart committed May 29, 2024
1 parent a057327 commit e25708e
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 1 deletion.
11 changes: 11 additions & 0 deletions docs/rx-react/index.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Added in v1.0.0
- [useRxMount](#userxmount)
- [useRxRef](#userxref)
- [useRxRefProp](#userxrefprop)
- [useRxRefPropValue](#userxrefpropvalue)
- [useRxRefresh](#userxrefresh)
- [useRxSet](#userxset)
- [useRxSetPromise](#userxsetpromise)
Expand Down Expand Up @@ -90,6 +91,16 @@ export declare const useRxRefProp: <A, K extends keyof A>(ref: RxRef.RxRef<A>, p
Added in v1.0.0
## useRxRefPropValue
**Signature**
```ts
export declare const useRxRefPropValue: <A, K extends keyof A>(ref: RxRef.RxRef<A>, prop: K) => A[K]
```
Added in v1.0.0
## useRxRefresh
**Signature**
Expand Down
1 change: 1 addition & 0 deletions docs/rx/Registry.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ export declare const make: (
readonly initialValues?: Iterable<readonly [Rx.Rx<any>, any]> | undefined
readonly scheduleTask?: ((f: () => void) => void) | undefined
readonly timeoutResolution?: number | undefined
readonly defaultIdleTTL?: number | undefined
}
| undefined
) => Registry
Expand Down
14 changes: 14 additions & 0 deletions docs/rx/Result.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Added in v1.0.0

- [accessors](#accessors)
- [cause](#cause)
- [getOrElse](#getorelse)
- [value](#value)
- [combinators](#combinators)
- [map](#map)
Expand Down Expand Up @@ -65,6 +66,19 @@ export declare const cause: <A, E>(self: Result<A, E>) => Option.Option<Cause.Ca
Added in v1.0.0
## getOrElse
**Signature**
```ts
export declare const getOrElse: {
<B>(orElse: LazyArg<B>): <A, E>(self: Result<A, E>) => B | A
<A, E, B>(self: Result<A, E>, orElse: LazyArg<B>): A | B
}
```
Added in v1.0.0
## value
**Signature**
Expand Down
2 changes: 1 addition & 1 deletion packages/rx/src/Result.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import * as Cause from "effect/Cause"
import * as Data from "effect/Data"
import * as Exit from "effect/Exit"
import type { LazyArg, LazyArg } from "effect/Function"
import type { LazyArg } from "effect/Function"
import { dual, identity } from "effect/Function"
import * as Option from "effect/Option"
import { type Pipeable, pipeArguments } from "effect/Pipeable"
Expand Down

0 comments on commit e25708e

Please sign in to comment.