Function isOk

isOk<T, E>(result: Result<T, E>): result is Ok<T>

Used to check if a result is an Ok.

Type Parameters

T
E

Parameters

result: Result<T, E>

Returns result is Ok<T>

Example

const result: Result<number, string> = ok(1);
const isOkResult: boolean = isOk(result); // true

Example

if (isOk(result)) {
	// We now know that the result is an Ok
 // so we can safely use it
	const value: number = unwrap(result); // 1
}