Failure
Defined in: src/util/Try.ts:90
The computation threw.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Failure(
error):Failure
Defined in: src/util/Try.ts:93
The raw thrown value. Usually an Error but could be anything JS allowed throwing.
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”Failure
Properties
Section titled “Properties”
readonly_tag:"Failure"
Defined in: src/util/Try.ts:91
readonlyerror:unknown
Defined in: src/util/Try.ts:93
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get cause():
Error
Defined in: src/util/Try.ts:102
The error coerced to an Error. Kept as an alias for back-compat
with code that used the previous pipeTo-style Failure (which named
the field cause and typed it as Error). Prefer .error in new
code — .cause lies in the sense that we don’t control the thrown
value’s type, only its coercion.
Returns
Section titled “Returns”Error
Methods
Section titled “Methods”filter()
Section titled “filter()”filter(
_pred,_makeError?):Try<never>
Defined in: src/util/Try.ts:137
Failure passes through filter unchanged.
Parameters
Section titled “Parameters”(value) => boolean
_makeError?
Section titled “_makeError?”(value) => Error
Returns
Section titled “Returns”Try<never>
flatMap()
Section titled “flatMap()”flatMap<
U>(_f):Try<U>
Defined in: src/util/Try.ts:120
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:139
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:143
Parameters
Section titled “Parameters”(value) => void
Returns
Section titled “Returns”void
get():
never
Defined in: src/util/Try.ts:146
Throws the stored error (Scala parity).
Returns
Section titled “Returns”never
getOrElse()
Section titled “getOrElse()”getOrElse<
U>(fallback):U
Defined in: src/util/Try.ts:109
Type Parameters
Section titled “Type Parameters”U
Parameters
Section titled “Parameters”fallback
Section titled “fallback”U | ((err) => U)
Returns
Section titled “Returns”U
isFailure()
Section titled “isFailure()”isFailure():
this is Failure
Defined in: src/util/Try.ts:107
Returns
Section titled “Returns”this is Failure
isSuccess()
Section titled “isSuccess()”isSuccess():
this is Success<never>
Defined in: src/util/Try.ts:106
Returns
Section titled “Returns”this is Success<never>
map<
U>(_f):Try<U>
Defined in: src/util/Try.ts:119
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<U>
Defined in: src/util/Try.ts:115
Type Parameters
Section titled “Type Parameters”U
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Try<U>
recover()
Section titled “recover()”recover<
U>(f):Try<U>
Defined in: src/util/Try.ts:123
Apply the recovery fn; returned value is wrapped in Success. null keeps the Failure.
Type Parameters
Section titled “Type Parameters”U
Parameters
Section titled “Parameters”(err) => U | null
Returns
Section titled “Returns”Try<U>
recoverWith()
Section titled “recoverWith()”recoverWith<
U>(f):Try<U>
Defined in: src/util/Try.ts:131
Apply the recovery fn; its Try return value wholesale replaces this Failure.
Type Parameters
Section titled “Type Parameters”U
Parameters
Section titled “Parameters”(err) => Try<U>
Returns
Section titled “Returns”Try<U>
toError()
Section titled “toError()”toError():
Error
Defined in: src/util/Try.ts:153
Returns
Section titled “Returns”Error
toNullable()
Section titled “toNullable()”toNullable():
null
Defined in: src/util/Try.ts:151
Returns
Section titled “Returns”null