Class BaseResult<V, E>
Source: result.ts
Extended by
Type Parameters
V
V
E
E
Constructors
Constructor
new BaseResult<
V,E>():BaseResult<V,E>
Returns
BaseResult<V, E>
Methods
isOk()
isOk():
this is Success<V, E>
Returns true if this result is a Result.Success.
Returns
this is Success<V, E>
isError()
isError():
this is Failure<V, E>
Returns true if this result is a Result.Failure.
Returns
this is Failure<V, E>
map()
abstractmap<W>(callback: (value:V) =>W):Result<W,E>
Transforms the value of this result using the provided callback if this is a Result.Success. Does nothing if this result is a Result.Failure.
Type Parameters
W
W
Parameters
callback
(value: V) => W
Returns
Result<W, E>
mapError()
abstractmapError<F>(callback: (error:E) =>F):Result<V,F>
Transforms the error of this result using the provided callback if this is a Result.Failure. Does nothing if this result is a Result.Success.
Type Parameters
F
F
Parameters
callback
(error: E) => F
Returns
Result<V, F>
next()
abstractnext<W,F>(callback: (value:V) =>Result<W,F>):Result<W,E|F>
Chains a new Result-returning operation to this result if this is a Result.Success. Does nothing if this result is a Result.Failure.
Type Parameters
W
W
F
F
Parameters
callback
(value: V) => Result<W, F>
Returns
Result<W, E | F>
orElse()
abstractorElse<W,F>(callback: (error:E) =>Result<W,F>):Result<V|W,E|F>
Provides a recovery path for this result if this is a Result.Failure by returning a new Result. Does nothing if this result is a Result.Success.
Type Parameters
W
W
F
F
Parameters
callback
(error: E) => Result<W, F>
Returns
Result<V | W, E | F>
unwrapOr()
abstractunwrapOr<W>(defaultValue:W):V|W
Returns the Result.Success value of this instance or the provided default value if this is a Result.Failure.
Type Parameters
W
W
Parameters
defaultValue
W
Returns
V | W
match()
abstractmatch<A,B>(ok: (value:V) =>A,error: (error:E) =>B):A|B
Executes the ok callback if this is a Result.Success, or the error callback if this is a Result.Failure, returning the result.
Type Parameters
A
A
B
B
Parameters
ok
(value: V) => A
error
(error: E) => B
Returns
A | B
ifOk()
ifOk(
callback: (value:V) =>void):this
Executes a callback for side effects if this result is a Result.Success.
Parameters
callback
(value: V) => void
Returns
this
ifError()
ifError(
callback: (error:E) =>void):this
Executes a callback for side effects if this result is a Result.Failure.
Parameters
callback
(error: E) => void
Returns
this
filter()
Call Signature
abstractfilter<U,F>(predicate: (value:V) =>value is U,createError: (value:V) =>F):Result<U,E|F>
Validates the value of this result against a predicate. Converts to Result.Failure if the predicate returns false. Does nothing if this result is already a Result.Failure.
Type Parameters
U
U
F
F
Parameters
predicate
(value: V) => value is U
createError
(value: V) => F
Returns
Result<U, E | F>
Call Signature
abstractfilter<F>(predicate: (value:V) =>boolean,createError: (value:V) =>F):Result<V,E|F>
Validates the value of this result against a predicate. Converts to Result.Failure if the predicate returns false. Does nothing if this result is already a Result.Failure.
Type Parameters
F
F
Parameters
predicate
(value: V) => boolean
createError
(value: V) => F
Returns
Result<V, E | F>