Class Success<V, E>

Source: result.ts

Represents the result of a successful operation.

Extends

• BaseResult<V, E>

Type Parameters

V

V

E

E

Constructors

Constructor

new Success<V, E>(value: V): Success<V, E>

Parameters

value

V

Returns

Success<V, E>

Overrides

BaseResult.constructor

Properties

value

readonly value: V

Methods

isError()

isError(): this is Failure<V, E>

Returns true if this result is a Result.Failure.

Returns

this is Failure<V, E>

Inherited from

BaseResult.isError

---

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

Inherited from

BaseResult.ifOk

---

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

Inherited from

BaseResult.ifError

---

isOk()

isOk(): this is Success<V, E>

Returns true if this result is a Result.Success.

Returns

this is Success<V, E>

Overrides

BaseResult.isOk

---

map()

map<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>

Overrides

BaseResult.map

---

mapError()

mapError<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>

Overrides

BaseResult.mapError

---

next()

next<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>

Overrides

BaseResult.next

---

orElse()

orElse<W, F>(_callback: (error: E) => Result<W, F>): Result<V, E>

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, E>

Overrides

BaseResult.orElse

---

unwrapOr()

unwrapOr<W>(_defaultValue: W): V

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

Overrides

BaseResult.unwrapOr

---

match()

match<A, B>(ok: (value: V) => A, _error: (error: E) => B): A

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

Overrides

BaseResult.match

---

filter()

Call Signature

filter<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>

Overrides

BaseResult.filter

Call Signature

filter<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>

Overrides

BaseResult.filter