Interface: IResult<T, E>
result/src.IResult
Type parameters
| Name | Description |
|---|---|
T | - |
E | - |
Methods
[iterator]
▸ [iterator](): Generator<T, any, unknown>
Returns
Generator<T, any, unknown>
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:808
and
▸ and<U>(result): Result<U, E>
Type parameters
| Name |
|---|
U |
Parameters
| Name | Type | Description |
|---|---|---|
result | Result<U, E> |
Returns
Result<U, E>
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:559
andThen
▸ andThen<U>(cb): Result<U, E>
Type parameters
| Name |
|---|
U |
Parameters
| Name | Type | Description |
|---|---|---|
cb | (value: T) => Result<U, E> |
Returns
Result<U, E>
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:580
contains
▸ contains(value): boolean
Parameters
| Name | Type | Description |
|---|---|---|
value | T |
Returns
boolean
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:661
containsErr
▸ containsErr(error): boolean
Parameters
| Name | Type | Description |
|---|---|---|
error | E |
Returns
boolean
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:685
eq
▸ eq(other): boolean
Parameters
| Name | Type | Description |
|---|---|---|
other | Result<T, E> |
Returns
boolean
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:750
err
▸ err(): Option<E>
Returns
Option<E>
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:139
expect
▸ expect(message): T
Parameters
| Name | Type | Description |
|---|---|---|
message | string |
Returns
T
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:419
expectErr
▸ expectErr(message): E
Parameters
| Name | Type | Description |
|---|---|---|
message | string |
Returns
E
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:444
flatten
▸ flatten<IT>(this): Result<IT, E>
Type parameters
| Name |
|---|
IT |
Parameters
| Name | Type |
|---|---|
this | Result<Result<IT, E>, E> |
Returns
Result<IT, E>
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:724
inspect
▸ inspect(cb): IResult<T, E>
Parameters
| Name | Type | Description |
|---|---|---|
cb | (value: T) => void |
Returns
IResult<T, E>
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:308
inspectAsync
▸ inspectAsync(cb): Promise<IResult<T, E>>
Parameters
| Name | Type | Description |
|---|---|---|
cb | (value: T) => Awaitable<void> |
Returns
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:328
inspectErr
▸ inspectErr(cb): IResult<T, E>
Parameters
| Name | Type | Description |
|---|---|---|
cb | (error: E) => void |
Returns
IResult<T, E>
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:348
inspectErrAsync
▸ inspectErrAsync(cb): Promise<IResult<T, E>>
Parameters
| Name | Type | Description |
|---|---|---|
cb | (error: E) => Awaitable<void> |
Returns
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:368
intoOkOrErr
▸ intoOkOrErr(): T | E
Returns
T | E
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:742
isErr
▸ isErr(): this is Err<E>
Returns
this is Err<E>
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:75
isErrAnd
▸ isErrAnd<R>(cb): this is Err<E> & R
Type parameters
| Name | Type |
|---|---|
R | extends boolean |
Parameters
| Name | Type | Description |
|---|---|---|
cb | (error: E) => R |
Returns
this is Err<E> & R
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:99
isOk
▸ isOk(): this is Ok<T>
Returns
this is Ok<T>
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:34
isOkAnd
▸ isOkAnd<R>(cb): this is Ok<T> & R
Type parameters
| Name | Type |
|---|---|
R | extends boolean |
Parameters
| Name | Type |
|---|---|
cb | (value: T) => R |
Returns
this is Ok<T> & R
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:57
iter
▸ iter(): Generator<T, any, unknown>
Returns
Generator<T, any, unknown>
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:394
map
▸ map<U>(cb): Result<U, E>
Type parameters
| Name |
|---|
U |
Parameters
| Name | Type | Description |
|---|---|---|
cb | (value: T) => U |
Returns
Result<U, E>
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:159
mapErr
▸ mapErr<F>(cb): Result<T, F>
Type parameters
| Name |
|---|
F |
Parameters
| Name | Type | Description |
|---|---|---|
cb | (error: E) => F |
Returns
Result<T, F>
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:258
mapErrInto
▸ mapErrInto<IT, IE>(cb): Result<T | IT, IE>
Type parameters
| Name |
|---|
IT |
IE |
Parameters
| Name | Type | Description |
|---|---|---|
cb | (error: E) => Result<IT, IE> |
Returns
Result<T | IT, IE>
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:288
mapInto
▸ mapInto<IT, IE>(cb): Result<IT, E | IE>
Type parameters
| Name |
|---|
IT |
IE |
Parameters
| Name | Type | Description |
|---|---|---|
cb | (value: T) => Result<IT, IE> |
Returns
Result<IT, E | IE>
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:190
mapOr
▸ mapOr<U>(defaultValue, cb): U
Type parameters
| Name |
|---|
U |
Parameters
| Name | Type | Description |
|---|---|---|
defaultValue | U | |
cb | (value: T) => U |
Returns
U
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:213
mapOrElse
▸ mapOrElse<U>(op, cb): U
Type parameters
| Name |
|---|
U |
Parameters
| Name | Type | Description |
|---|---|---|
op | (error: E) => U | |
cb | (value: T) => U |
Returns
U
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:236
match
▸ match<OkValue, ErrValue>(branches): OkValue | ErrValue
Type parameters
| Name |
|---|
OkValue |
ErrValue |
Parameters
| Name | Type | Description |
|---|---|---|
branches | Object | |
branches.err | (error: E) => ErrValue | - |
branches.ok | (value: T) => OkValue | - |
Returns
OkValue | ErrValue
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:781
ne
▸ ne(other): boolean
Parameters
| Name | Type | Description |
|---|---|---|
other | Result<T, E> |
Returns
boolean
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:758
ok
▸ ok(): Option<T>
Returns
Option<T>
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:119
or
▸ or<F>(result): Result<T, F>
Type parameters
| Name |
|---|
F |
Parameters
| Name | Type | Description |
|---|---|---|
result | Result<T, F> |
Returns
Result<T, F>
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:616
orElse
▸ orElse<F>(cb): Result<T, F>
Type parameters
| Name |
|---|
F |
Parameters
| Name | Type | Description |
|---|---|---|
cb | (error: E) => Result<T, F> |
Returns
Result<T, F>
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:637
transpose
▸ transpose<IT>(this): Option<Result<IT, E>>
Type parameters
| Name |
|---|
IT |
Parameters
| Name | Type |
|---|---|
this | Result<Option<IT>, E> |
Returns
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:701
unwrap
▸ unwrap(): T
Returns
T
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:470
unwrapErr
▸ unwrapErr(): E
Returns
E
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:494
unwrapOr
▸ unwrapOr<V>(defaultValue): T | V
Type parameters
| Name |
|---|
V |
Parameters
| Name | Type | Description |
|---|---|---|
defaultValue | V |
Returns
T | V
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:516
unwrapOrElse
▸ unwrapOrElse<V>(op): T | V
Type parameters
| Name |
|---|
V |
Parameters
| Name | Type | Description |
|---|---|---|
op | (error: E) => V |
Returns
T | V
Defined in
projects/utilities/packages/result/src/lib/Result/IResult.ts:532