routier-collection

---

routier-collection / core/src / PluginEventResult

Class: PluginEventResult

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

Extends

• BaseResult

Constructors

Constructor

new PluginEventResult(): PluginEventResult

Returns

PluginEventResult

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

---

success()

Call Signature

static success<T>(id, data): PluginEventResultType<T>

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

Type Parameters

T

T

Parameters

id

string

data

T

Returns

PluginEventResultType<T>

Call Signature

static success<T>(id): PluginEventResultType<never>

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

Type Parameters

T

T

Parameters

id

string

Returns

PluginEventResultType<never>

---

error()

static error<T>(id, error): PluginEventResultType<T>

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

Type Parameters

T

T

Parameters

id

string

error

any

Returns

PluginEventResultType<T>

---

partial()

static partial<T>(id, data, error): PluginEventPartialResultType<T>

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

Type Parameters

T

T

Parameters

id

string

data

T

error

any

Returns

PluginEventPartialResultType<T>

---

assertSuccess()

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

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

Type Parameters

T

T

Parameters

result

PluginEventResultType<T>

Returns

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

Overrides

BaseResult.assertSuccess