ts-data-forge/src/functional/ternary-result/impl/ternary-result-err.mts

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

import { ErrTypeTagName } from './tag.mjs';

/**
 * Creates a `TernaryResult.Err` containing the provided error value.
 *
 * @example
 *
 * ```ts
 * const failure = TernaryResult.err(new Error('missing data'));
 *
 * assert.strictEqual(failure.$$tag, 'ts-data-forge::Result.err');
 *
 * assert.isTrue(TernaryResult.isErr(failure));
 * ```
 */
export const err = <const E,>(value: E): TernaryErr<E> => ({
  $$tag: ErrTypeTagName,
  value,
});