Skip to content

Commit 82ee4bb

Browse files
authored
Merge pull request #95 from swan-io/bloodyowl-patch-1
remove Result.fromPredicate
2 parents 847b5aa + eb4d3a3 commit 82ee4bb

File tree

1 file changed

+0
-17
lines changed

1 file changed

+0
-17
lines changed

docs/docs/result.md

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -335,23 +335,6 @@ result.tapError(console.log).map((x) => x * 2);
335335

336336
## Statics
337337

338-
### Result.fromPredicate(value, predicate, error)
339-
340-
```ts
341-
fromPredicate(value: A, f: (value: A) => boolean, errorIfFalse: E): Result<A, E>
342-
```
343-
344-
Creates an option from a value and a predicate. Will return `Ok(value)` if predicate returns `true`, `Error(errorIfFalse)` if `false`
345-
346-
```ts title="Examples"
347-
Result.fromPredicate(
348-
value,
349-
(value) => value % 2 === 0,
350-
new Error("Odd number"),
351-
);
352-
// Ok<number> if `number` is even, Error<Error> if odd
353-
```
354-
355338
### Result.isResult(value)
356339

357340
```ts

0 commit comments

Comments
 (0)