Skip to content

isResultOk

Returns true for successful Result tuple

260 bytes

Usage

Check if a value is both a Result tuple and an Ok result.

import * as
import _
_
from 'radashi'
declare const
const value: unknown
value
: unknown
if (
import _
_
.
isResultOk<unknown>(value: unknown): value is _.Ok<unknown>
export isResultOk

Returns true if the value is an Ok result.

@seehttps://radashi.js.org/reference/typed/isResultOk

@example

isResultOk([undefined, "hello"]) // true
isResultOk([new Error(), undefined]) // false

@version12.2.0

isResultOk
(
const value: unknown
value
)) {
const value: _.Ok<unknown>
value
// <-- now an Ok<unknown> type
const value: _.Ok<unknown>
value
[1] // <-- This is the resulting value!
}

Also see the related isResult and isResultErr functions.