Class representing a successful operation whose result can only be a success or a failure.

Extended by

Type Parameters

T

T

The type of the successful result value

E

E extends BWellError = BWellError

The type of the error, must extend BWellError (defaults to BWellError)

Constructors

Constructor

new BWellTransactionResult<T, E>(): BWellTransactionResult<T, E>

Returns

BWellTransactionResult<T, E>

Methods

success()

abstract success(): this is BWellTransactionSuccess<T>

Returns true if Result is BWellTransactionSuccess

Returns

this is BWellTransactionSuccess<T>

failure()

abstract failure(): this is BWellTransactionFailure<T, E>

Returns true if Result is BWellTransactionFailure

Returns

this is BWellTransactionFailure<T, E>

data()

abstract data(): T

If Result is a BWellTransactionSuccess, returns T. Throws E if Result is BWellTransactionFailure

Returns

T

Throws

error()

abstract error(): E

If Result is a BWellTransactionFailure returns E; Throws T if result is BWellTransactionSuccess

Returns

E

Throws

toQueryResult()

abstract toQueryResult(): BWellQueryResult<T, E>

Returns a BWellQueryResult<T, E>

Returns

BWellQueryResult<T, E>

success()

static success<T>(data): BWellTransactionSuccess<T>

Provides a BWellTransactionSuccess with the given data

Type Parameters

T

T

Parameters

data

T

Returns

BWellTransactionSuccess<T>

failure()

static failure<T, E>(error): BWellTransactionFailure<T, E>

Provides a BWellTransactionFailure with the given error

Type Parameters

T

T

E

E extends BWellError

Parameters

error

E

Returns

BWellTransactionFailure<T, E>