Class: Result<T, E>

Type parameters

Type parameter	Value
T	-
E extends Error	Error

Constructors

new Result()

private new Result<T, E>(success: boolean, value?: T, error?: E): Result<T, E>

Parameters

Parameter	Type
success	boolean
value?	T
error?	E

Returns

Result<T, E>

Source

projects/shapeshift/src/lib/Result.ts:6

Properties

error?

optional readonly error: E

Source

projects/shapeshift/src/lib/Result.ts:4

---

success

readonly success: boolean

Source

projects/shapeshift/src/lib/Result.ts:2

---

value?

optional readonly value: T

Source

projects/shapeshift/src/lib/Result.ts:3

Methods

isErr()

isErr(): this is Object

Returns

this is Object

Source

projects/shapeshift/src/lib/Result.ts:19

---

isOk()

isOk(): this is Object

Returns

this is Object

Source

projects/shapeshift/src/lib/Result.ts:15

---

unwrap()

unwrap(): T

Returns

T

Source

projects/shapeshift/src/lib/Result.ts:23

---

err()

static err<T, E>(error: E): Result<T, E>

Type parameters

Type parameter	Value
T	-
E extends Error	Error

Parameters

Parameter	Type
error	E

Returns

Result<T, E>

Source

projects/shapeshift/src/lib/Result.ts:32

---

ok()

static ok<T, E>(value: T): Result<T, E>

Type parameters

Type parameter	Value
T	-
E extends Error	Error

Parameters

Parameter	Type
value	T

Returns

Result<T, E>

Source

projects/shapeshift/src/lib/Result.ts:28