ts-data-forge/src/functional/result/impl/result-is-ok.mts

[](https://www.npmjs.com/package/ts-data-forge) [](https://www.npmjs.com/package/ts-data-forge) [![License](https://img.shields.

import { OkTypeTagName } from './tag.mjs';
import { type NarrowToOk } from './types.mjs';

/**
 * Type guard for the ok variant.
 *
 * @example
 *
 * ```ts
 * const operation = Result.ok(3);
 *
 * const failure = Result.err('error');
 *
 * if (Result.isOk(operation)) {
 *   const value: number = operation.value;
 *
 *   assert.isTrue(value === 3);
 * }
 *
 * assert.isTrue(Result.isErr(failure));
 * ```
 */
export const isOk = <R extends UnknownResult>(
  result: R,
): result is NarrowToOk<R> => result.$$tag === OkTypeTagName;