Class representing a failed operation whose result can only be a failure and never a success
Class representing a failed operation whose result can only be a failure
and never a success
Extends
BWellTransactionResult<T,E>
Type Parameters
T
T
The type of the successful result value (unused in failure)
E
E extends BWellError = BWellError
The type of the error, must extend BWellError (defaults to BWellError)
Constructors
Constructor
new BWellTransactionFailure<
T,E>(error):BWellTransactionFailure<T,E>
Parameters
error
E
Returns
BWellTransactionFailure<T, E>
Overrides
BWellTransactionResult.constructor
Methods
success()
staticsuccess<T>(data):BWellTransactionSuccess<T>
Provides a BWellTransactionSuccess with the given data
Type Parameters
T
T
Parameters
data
T
Returns
Inherited from
BWellTransactionResult.success
failure()
staticfailure<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>
Inherited from
BWellTransactionResult.failure
data()
data():
never
If Result is a BWellTransactionSuccess, returns T.
Throws E if Result is BWellTransactionFailure
Returns
never
Throws
Overrides
error()
error():
E
If Result is a BWellTransactionFailure returns E;
Throws T if result is BWellTransactionSuccess
Returns
E
Throws
Overrides
success()
success():
this is BWellTransactionSuccess<T>
Returns true if Result is BWellTransactionSuccess
Returns
this is BWellTransactionSuccess<T>
Overrides
BWellTransactionResult.success
failure()
failure():
this is BWellTransactionFailure<T, E>
Returns true if Result is BWellTransactionFailure
Returns
this is BWellTransactionFailure<T, E>
Overrides
BWellTransactionResult.failure
intoFailure()
intoFailure<
T>():BWellTransactionResult<T,E>
Returns a new BWellTransactionFailure cast with <T, E>.
Type Parameters
T
T
Returns
BWellTransactionResult<T, E>
Example
// A BWellTransactionResult<number> could come back from some function.
let result: BWellTransactionResult<number>;
if (result.failure()) {
// but you need to return a BWellTransactionResult<string>.
// Since BWellTransactionFailure does not contain data we can cast the result
// into the type we need like this
return result.intoFailure<string>();
}
toQueryResult()
toQueryResult<
T>():BWellQueryResult<T,E>
Returns a BWellQueryResult<T, E>
Type Parameters
T
T
Returns
BWellQueryResult<T, E>