Class FailureResult<E>

A class representing an error result

Type parameters

E = Error

Hierarchy

FailureResult

Implements

ResultType<undefined, E>

Index

Constructors

constructor

Properties

_res

Accessors

Methods

unwrap

Constructors

constructor

new FailureResult<E>(error: E): FailureResult<E>

Type parameters
- E = Error
Parameters
- error: E
Returns FailureResult<E>

Properties

Private _res

_res: E

Accessors

error

get error(): E

Implementation of ResultType.error

The error

Returns E

failure

get failure(): true

Implementation of ResultType.failure

Always returns true

Returns true

result

get result(): undefined

Implementation of ResultType.result

The value

Returns undefined

success

get success(): false

Implementation of ResultType.success

Always returns false

Returns false

Methods

unwrap

unwrap(): [undefined, E]

Implementation of ResultType.unwrap

Returns a tuple with [undefined, failureValue]

Returns [undefined, E]

Generated using TypeDoc