Class Resultt<T>

Base class for runtime result. This class may express the context for a runtime and its result.
Highly inspired by Kotlin Result/runCatching.

see: usage ... test/appliation/result-test.ts

Type Parameters

T

Type parameter for main value.

Hierarchy

Resultt

Index

Constructors

constructor

Properties

_value

Constructors

constructor

new Resultt<T>(): Resultt<T>
new Resultt<T>(value: T): Resultt<T>

- Defined in result.ts:35
Type Parameters
- T
Returns Resultt<T>
- Defined in result.ts:36
Type Parameters
- T
Parameters
- value: T
Returns Resultt<T>

Properties

Private Readonly _value

_value: Option<T>

Successed data of this object

Methods

andLastly

andLastly(consumer: (() => void)): Resultt<T>

- Defined in result.ts:237
Return Resultt instance with doing consumer.

Parameters
- consumer: (() => void)
  - - (): void
    - Returns void
Returns Resultt<T>

filter

filter(predicate: ((t: T) => boolean)): Resultt<T>

- Defined in result.ts:201
Return [Failure] if the argument predicate is evaluated as false. Internally the method filter throws runtime Error ValueNotFoundException if the predicate is false.

Parameters
- predicate: ((t: T) => boolean)
  - - (t: T): boolean
    - Parameters
      - t: T
      Returns boolean
Returns Resultt<T>

filterNotNull

filterNotNull(): Resultt<T>

- Defined in result.ts:222
Return [Failure] if a value of this Resultt instance is null;

Returns Resultt<T>

fold

fold<R>(onSuccess: ((value?: T) => R), onFailure: ((earg?: Error) => R)): R

- Defined in result.ts:107
Map the value of this result to another instance typed R. If this function cannot return another instance, throw Error.

Type Parameters
- R
Parameters
- onSuccess: ((value?: T) => R)
  
  higher kinded function for succesing
  - - (value?: T): R
    - Parameters
      - Optional value: T
      Returns R
- onFailure: ((earg?: Error) => R)
  
  higher kinded function for failing
  - - (earg?: Error): R
    - Parameters
      - Optional earg: Error
      Returns R
Returns R

Private getFailure

getFailure<T>(message: string): Failure<T>

- Defined in result.ts:324
Get Failure instance initialized with ValueNotFoundException .

Type Parameters
- T
Parameters
- message: string
Returns Failure<T>

getOrDefault

getOrDefault(elseValue: T): T

- Defined in result.ts:263
Get the value of this result or default value in argument

Parameters
- elseValue: T
Returns T

getOrElse

getOrElse<R>(onFailure: ((earg?: Error) => R)): R

- Defined in result.ts:276
Get the value of type R by applying action. Shorthand for the method fold.

Type Parameters
- R
Parameters
- onFailure: ((earg?: Error) => R)
  
  the action on failure
  - - (earg?: Error): R
    - Parameters
      - Optional earg: Error
      Returns R
Returns R

getOrNull

getOrNull(): T

- Defined in result.ts:292
Get the encapsulated value of this class instance if success.

Returns T

getOrThrow

getOrThrow(e?: Error): T

- Defined in result.ts:248
Get a value of this result or throw error if not.

Parameters
- Optional e: Error
  
  Some Error if want. No parameter passed throw default Error.
Returns T

isFailure

isFailure(): boolean

- Defined in result.ts:58
Return true if the result was failed.

Returns boolean

isSuccess

isSuccess(): boolean

- Defined in result.ts:66
Return true if the result was successed.

Returns boolean

map

map<R>(transform: ((arg?: T) => R)): Resultt<R>

- Defined in result.ts:129
Map the result to another result, transforming by the argument.

Type Parameters
- R
Parameters
- transform: ((arg?: T) => R)
  
  callback function for mapping another Result.
  - - (arg?: T): R
    - Parameters
      - Optional arg: T
      Returns R
Returns Resultt<R>

mapCatching

mapCatching<R>(transform: ((arg?: T) => R)): Resultt<R>

- Defined in result.ts:149
Map the result to another result, transforming by the argument. mapCatching handle errors on executing the argument transform.

Type Parameters
- R
Parameters
- transform: ((arg?: T) => R)
  
  callback function for mapping another Result.
  - - (arg?: T): R
    - Parameters
      - Optional arg: T
      Returns R
Returns Resultt<R>

onFailure

onFailure(consumer?: ((it?: Error) => void)): Resultt<T>

- Defined in result.ts:75
Set action on failure.

Parameters
- Optional consumer: ((it?: Error) => void)
  
  action on failure.
  - - (it?: Error): void
    - Parameters
      - Optional it: Error
      Returns void
Returns Resultt<T>

onSuccess

onSuccess(consumer: ((arg: T) => void)): Resultt<T>

- Defined in result.ts:92
Set an additional action on successing

Parameters
- consumer: ((arg: T) => void)
  - - (arg: T): void
    - Parameters
      - arg: T
      Returns void
Returns Resultt<T>

recover

recover<R>(transform: ((arg?: Error) => R)): Resultt<R>

- Defined in result.ts:166
Type Parameters
- R
Parameters
- transform: ((arg?: Error) => R)
  
  callback function for mapping another Result.
  - - (arg?: Error): R
    - Parameters
      - Optional arg: Error
      Returns R
Returns Resultt<R>

recoverCatching

recoverCatching<R>(transform: ((arg?: Error) => R)): Resultt<R>

- Defined in result.ts:182
Type Parameters
- R
Parameters
- transform: ((arg?: Error) => R)
  
  callback function for mapping another Result.
  - - (arg?: Error): R
    - Parameters
      - Optional arg: Error
      Returns R
Returns Resultt<R>

Private throwOnFailure

throwOnFailure(): void

- Defined in result.ts:313
Returns void

toString

toString(): string

- Defined in result.ts:306
Return the string expression of this class instance.

Returns string

Static failure

failure(error: Error): Failure<Error>

- Defined in result.ts:50
Create Failure instance manually

Parameters
- error: Error
  
  error
Returns Failure<Error>
Failure

Static runCatching

runCatching<T>(supplier: (() => T)): Resultt<T>

- Defined in result.ts:336
Wrapping actions and return Result instance. Force the first type parameter type of Error when the action result catch Error.

Type Parameters
- T
Parameters
- supplier: (() => T)
  
  function to be called
  - - (): T
    - Returns T
Returns Resultt<T>
The result of execution in argument supplier.

Generated using TypeDoc