Success
Defined in: src/util/Try.ts:31
The computation returned a value.
Type Parameters
Section titled “Type Parameters”T = unknown
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Success<
T>(value):Success<T>
Defined in: src/util/Try.ts:33
Parameters
Section titled “Parameters”T
Returns
Section titled “Returns”Success<T>
Properties
Section titled “Properties”
readonly_tag:"Success"
Defined in: src/util/Try.ts:32
readonlyvalue:T
Defined in: src/util/Try.ts:33
Methods
Section titled “Methods”filter()
Section titled “filter()”filter(
pred,makeError?):Try<T>
Defined in: src/util/Try.ts:63
Keep if predicate holds; else Failure with a FilterError.
Parameters
Section titled “Parameters”(value) => boolean
makeError?
Section titled “makeError?”(value) => Error
Returns
Section titled “Returns”Try<T>
flatMap()
Section titled “flatMap()”flatMap<
U>(f):Try<U>
Defined in: src/util/Try.ts:51
Chain to another Try. A thrown mapper becomes Failure.
Type Parameters
Section titled “Type Parameters”U
Parameters
Section titled “Parameters”(value) => Try<U>
Returns
Section titled “Returns”Try<U>
fold()
Section titled “fold()”fold<
U>(_onFailure,onSuccess):U
Defined in: src/util/Try.ts:72
Collapse both cases into one value.
Type Parameters
Section titled “Type Parameters”U
Parameters
Section titled “Parameters”_onFailure
Section titled “_onFailure”(err) => U
onSuccess
Section titled “onSuccess”(value) => U
Returns
Section titled “Returns”U
forEach()
Section titled “forEach()”forEach(
f):void
Defined in: src/util/Try.ts:77
Run a side-effect on the value.
Parameters
Section titled “Parameters”(value) => void
Returns
Section titled “Returns”void
get():
T
Defined in: src/util/Try.ts:80
Convert to a “classic” value — the inner value.
Returns
Section titled “Returns”T
getOrElse()
Section titled “getOrElse()”getOrElse<
U>(_fallback):T
Defined in: src/util/Try.ts:39
Always Success; fallback ignored.
Type Parameters
Section titled “Type Parameters”U
Parameters
Section titled “Parameters”_fallback
Section titled “_fallback”U | ((err) => U)
Returns
Section titled “Returns”T
isFailure()
Section titled “isFailure()”isFailure():
this is Failure
Defined in: src/util/Try.ts:36
Returns
Section titled “Returns”this is Failure
isSuccess()
Section titled “isSuccess()”isSuccess():
this is Success<T>
Defined in: src/util/Try.ts:35
Returns
Section titled “Returns”this is Success<T>
map<
U>(f):Try<U>
Defined in: src/util/Try.ts:45
Map the inner value. A thrown mapper turns this into a Failure.
Type Parameters
Section titled “Type Parameters”U
Parameters
Section titled “Parameters”(value) => U
Returns
Section titled “Returns”Try<U>
orElse()
Section titled “orElse()”orElse<
U>(_alt):Try<T>
Defined in: src/util/Try.ts:42
Always Success; alternative ignored.
Type Parameters
Section titled “Type Parameters”U
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Try<T>
recover()
Section titled “recover()”recover<
U>(_f):Try<T|U>
Defined in: src/util/Try.ts:57
Always Success — no recovery runs.
Type Parameters
Section titled “Type Parameters”U
Parameters
Section titled “Parameters”(err) => U | null
Returns
Section titled “Returns”Try<T | U>
recoverWith()
Section titled “recoverWith()”recoverWith<
U>(_f):Try<T|U>
Defined in: src/util/Try.ts:60
Always Success — no recovery runs.
Type Parameters
Section titled “Type Parameters”U
Parameters
Section titled “Parameters”(err) => Try<U>
Returns
Section titled “Returns”Try<T | U>
toError()
Section titled “toError()”toError():
Error|null
Defined in: src/util/Try.ts:86
Fresh copy of the error, or null.
Returns
Section titled “Returns”Error | null
toNullable()
Section titled “toNullable()”toNullable():
T|null
Defined in: src/util/Try.ts:83
Convert to an Option-like shape (null on Failure).
Returns
Section titled “Returns”T | null