Class SuccessResult<T>

A class representing a successful result

Type parameters

T = unknown

Hierarchy

SuccessResult

Implements

ResultType<T, undefined>

Index

Constructors

constructor

Properties

_res

Accessors

Methods

unwrap

Constructors

constructor

new SuccessResult<T>(data: T): SuccessResult<T>

Type parameters
- T = unknown
Parameters
- data: T
Returns SuccessResult<T>

Properties

Private _res

_res: T

Accessors

error

get error(): undefined

Implementation of ResultType.error

The error

Returns undefined

failure

get failure(): false

Implementation of ResultType.failure

Always returns false

Returns false

result

get result(): T

Implementation of ResultType.result

The value

Returns T

success

get success(): true

Implementation of ResultType.success

Always returns true

Returns true

Methods

unwrap

unwrap(): [T, undefined]

Implementation of ResultType.unwrap

Returns a tuple with [successValue, undefined]

Returns [T, undefined]

Generated using TypeDoc