shared/result

Interfaces

Err

Defined in: app/src/shared/result.ts:8

A failed Result.

Type Parameters

E

E

Properties

error

readonly error: E

Defined in: app/src/shared/result.ts:10

ok

readonly ok: false

Defined in: app/src/shared/result.ts:9

---

Ok

Defined in: app/src/shared/result.ts:2

A successful Result.

Type Parameters

T

T

Properties

ok

readonly ok: true

Defined in: app/src/shared/result.ts:3

value

readonly value: T

Defined in: app/src/shared/result.ts:4

Type Aliases

Result

Result<T, E> = Ok<T> | Err<E>

Defined in: app/src/shared/result.ts:19

The outcome of an operation that can fail in an expected way.

Expected failures (invalid input, a missing file) are returned as values; exceptions are reserved for programming errors.

Type Parameters

T

T

E

E = Error

Functions

err()

err<E>(error): Err<E>

Defined in: app/src/shared/result.ts:33

Creates a failed result.

Type Parameters

E

E

Parameters

error

E

The reason for the failure.

Returns

Err<E>

---

ok()

ok<T>(value): Ok<T>

Defined in: app/src/shared/result.ts:25

Creates a successful result.

Type Parameters

T

T

Parameters

value

T

The value of the result.

Returns

Ok<T>