Class Result<T>

An abstraction of the result of an action or command - Use this pattern to return meaningful results from operations that may have otherwise been void.

Type Parameters

T

Index

Constructors

Properties

ErrorMessages Value?

Accessors

Methods

AddError CombineWith

Constructors

constructor

new Result<T>(Value?): Result<T>
Type Parameters
- T
Parameters
- Optional Value: T
Returns Result<T>
- Defined in src/Patterns/Result/Result.ts:15

Properties

ErrorMessages

ErrorMessages: string[] = ...

Messages indicating why the action returning the result was not successful

`Optional` Value

Value?: T

Accessors

IsSuccess

get IsSuccess(): boolean
Indicates whether or not the action returning the result was successful - The lack of errors indicates success. The presence of errors indicates failure.

Returns boolean
- Defined in src/Patterns/Result/Result.ts:11

Methods

AddError

AddError(error): void
Adds an error to ErrorMessages only when that error is not already present in the collection
Parameters
- error: string
Returns void
- Defined in src/Patterns/Result/Result.ts:36

CombineWith

CombineWith(result): Result<T>
Returns a new result containing errors from this result instance as well as the one passed
Parameters
- result: Result<T>
Returns Result<T>
- Defined in src/Patterns/Result/Result.ts:26

Generated using TypeDoc