hkt-toolbelt/natural-number/decrement.js

Functional and composable type utilities

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.decrement = void 0;
/**
 * Given a natural number, decrement it by 1.
 *
 * @param {number} x - The natural number to decrement.
 *
 * @example
 * ```ts
 * import { NaturalNumber } from "hkt-toolbelt";
 *
 * const result = NaturalNumber.decrement(1)
 * //    ^? 0
 * ```
 */
exports.decrement = ((x) => x === 0 ? 0 : x - 1);