Interface: Ok<T, E>
Defined in: result.ts:12
A successful result containing a value.
Type Parameters
| Type Parameter |
|---|
T |
E |
Properties
success
ts
readonly success: true;Defined in: result.ts:13
value
ts
readonly value: T;Defined in: result.ts:14
Methods
andThen()
ts
andThen<U>(fn): Result<U, E>;Defined in: result.ts:19
Type Parameters
| Type Parameter |
|---|
U |
Parameters
| Parameter | Type |
|---|---|
fn | (value) => Result<U, E> |
Returns
Result<U, E>
isErr()
ts
isErr(): this is Err<T, E>;Defined in: result.ts:16
Returns
this is Err<T, E>
isOk()
ts
isOk(): this is Ok<T, E>;Defined in: result.ts:15
Returns
this is Ok<T, E>
map()
ts
map<U>(fn): Result<U, E>;Defined in: result.ts:17
Type Parameters
| Type Parameter |
|---|
U |
Parameters
| Parameter | Type |
|---|---|
fn | (value) => U |
Returns
Result<U, E>
mapErr()
ts
mapErr<F>(fn): Result<T, F>;Defined in: result.ts:18
Type Parameters
| Type Parameter |
|---|
F |
Parameters
| Parameter | Type |
|---|---|
fn | (error) => F |
Returns
Result<T, F>
match()
ts
match<U>(matcher): U;Defined in: result.ts:23
Type Parameters
| Type Parameter |
|---|
U |
Parameters
| Parameter | Type |
|---|---|
matcher | { err: (error) => U; ok: (value) => U; } |
matcher.err | (error) => U |
matcher.ok | (value) => U |
Returns
U
unwrap()
ts
unwrap(): T;Defined in: result.ts:20
Returns
T
unwrapOr()
ts
unwrapOr(defaultValue): T;Defined in: result.ts:21
Parameters
| Parameter | Type |
|---|---|
defaultValue | T |
Returns
T
unwrapOrElse()
ts
unwrapOrElse(fn): T;Defined in: result.ts:22
Parameters
| Parameter | Type |
|---|---|
fn | (error) => T |
Returns
T