routier-collection

---

routier-collection / core/src / Result

Class: Result

Defined in: core/src/results/Result.ts:32

Extends

• BaseResult

Constructors

Constructor

new Result(): Result

Returns

Result

Inherited from

BaseResult.constructor

Properties

ERROR

static ERROR: "error"

Defined in: core/src/results/Result.ts:4

Inherited from

BaseResult.ERROR

---

SUCCESS

static SUCCESS: "success"

Defined in: core/src/results/Result.ts:5

Inherited from

BaseResult.SUCCESS

---

PARTIAL

static PARTIAL: "partial"

Defined in: core/src/results/Result.ts:6

Inherited from

BaseResult.PARTIAL

Methods

resolve()

static resolve<T>(result, resolve, reject): void

Defined in: core/src/results/Result.ts:8

Type Parameters

T

T

Parameters

result

{ error: any; ok: "error"; }

{ data: T; ok: "success"; }

{ data: T; ok: "partial"; error: any; }

resolve

(data) => void

reject

(error?) => void

Returns

void

Inherited from

BaseResult.resolve

---

assertSuccess()

static assertSuccess<T>(result): asserts result is { ok: "success"; data: T }

Defined in: core/src/results/Result.ts:25

Type Parameters

T

T

Parameters

result

any

Returns

asserts result is { ok: "success"; data: T }

Inherited from

BaseResult.assertSuccess

---

success()

Call Signature

static success<T>(data): ResultType<T>

Defined in: core/src/results/Result.ts:33

Type Parameters

T

T

Parameters

data

T

Returns

ResultType<T>

Call Signature

static success<T>(): ResultType<never>

Defined in: core/src/results/Result.ts:34

Type Parameters

T

T

Returns

ResultType<never>

---

error()

static error<T>(error): ResultType<T>

Defined in: core/src/results/Result.ts:42

Type Parameters

T

T

Parameters

error

any

Returns

ResultType<T>

---

partial()

static partial<T>(data, error): PartialResultType<T>

Defined in: core/src/results/Result.ts:49

Type Parameters

T

T

Parameters

data

T

error

any

Returns

PartialResultType<T>