yummies 7.11.0 → 7.13.0

package/parser.d.ts

@@ -91,6 +91,23 @@ interface StringParserSettings<TFallback = string> {
  */
 declare const string: <TFallback = string>(input: Maybe<unknown>, settings?: Maybe<StringParserSettings<TFallback>>) => string | TFallback;
 
+/**
+ * ---header-docs-section---
+ * # yummies/parser
+ *
+ * ## Description
+ *
+ * Parsers for user-entered **numbers, percents, and strings** with tolerant input and typed
+ * results. Use when normalizing form values, query params, or CSV-like text before validation
+ * schemas run, without duplicating regex and `parseFloat` edge cases in every feature module.
+ *
+ * ## Usage
+ *
+ * ```ts
+ * import { parser } from "yummies/parser";
+ * ```
+ */
+
 type _exports_NumberParserSettings<TFallback = number> = NumberParserSettings<TFallback>;
 type _exports_StringParserSettings<TFallback = string> = StringParserSettings<TFallback>;
 declare const _exports_number: typeof number;

package/parser.js

@@ -1,69 +1,116 @@
-import { format } from "yummies/format";
+import { n as __exportAll } from "./chunk-YKewjYmz.js";
 import { typeGuard } from "yummies/type-guard";
-const number = (input, userSettings) => {
-  const settings = {
-    ...number.defaultSettings,
-    ...userSettings
-  };
-  const fallback = "fallback" in settings ? settings.fallback : 0;
-  let result;
-  if (typeGuard.isNumber(input)) {
-    result = input;
-  } else if (typeGuard.isString(input)) {
-    const formattedInput = format.skipSpaces(input).replace(",", ".");
-    if (formattedInput === "") {
-      result = fallback;
-    } else {
-      result = Number(formattedInput);
-    }
-  } else {
-    result = fallback;
-  }
-  if (typeGuard.isNumber(result)) {
-    if (settings?.clamped != null) {
-      result = Math.max(
-        settings.clamped[0] ?? -Infinity,
-        Math.min(result, settings.clamped[1] ?? Infinity)
-      );
-    }
-    if (settings?.ceil != null) {
-      result = Math.ceil(result);
-    }
-    if (settings?.floor != null) {
-      result = Math.floor(result);
-    }
-    if (settings?.digits != null) {
-      result = +result.toFixed(settings.digits);
-    }
-    return result;
-  } else {
-    return fallback;
-  }
+import { format } from "yummies/format";
+//#region src/parser/number.ts
+/**
+* Parses a number from raw input and optionally clamps, rounds or limits
+* fractional digits.
+*
+* Strings are normalized by removing spaces and replacing `,` with `.` before
+* parsing. Invalid inputs return the configured fallback.
+*
+* @template TFallback Fallback value type returned when parsing fails.
+* @param input Raw value to parse.
+* @param userSettings Parser settings merged with `number.defaultSettings`.
+* @returns Parsed number or fallback value.
+*
+* @example
+* ```ts
+* number('1 234,5'); // 1234.5
+* ```
+*
+* @example
+* ```ts
+* number('bad', { fallback: 0 }); // 0
+* ```
+*/
+var number = (input, userSettings) => {
+	const settings = {
+		...number.defaultSettings,
+		...userSettings
+	};
+	const fallback = "fallback" in settings ? settings.fallback : 0;
+	let result;
+	if (typeGuard.isNumber(input)) result = input;
+	else if (typeGuard.isString(input)) {
+		const formattedInput = format.skipSpaces(input).replace(",", ".");
+		if (formattedInput === "") result = fallback;
+		else result = Number(formattedInput);
+	} else result = fallback;
+	if (typeGuard.isNumber(result)) {
+		if (settings?.clamped != null) result = Math.max(settings.clamped[0] ?? -Infinity, Math.min(result, settings.clamped[1] ?? Infinity));
+		if (settings?.ceil != null) result = Math.ceil(result);
+		if (settings?.floor != null) result = Math.floor(result);
+		if (settings?.digits != null) result = +result.toFixed(settings.digits);
+		return result;
+	} else return fallback;
 };
 number.defaultSettings = {};
-const percent = (value, maxValue, settings) => {
-  return number(Number(value) / Number(maxValue) * 100, settings);
-};
-const string = (input, settings) => {
-  const fallback = settings && "fallback" in settings ? settings.fallback : "";
-  if (input == null) {
-    return fallback;
-  }
-  if (typeGuard.isObject(input)) {
-    if (settings?.prettyJson) {
-      return JSON.stringify(input, null, 2);
-    }
-    return JSON.stringify(input);
-  }
-  return String(input);
+//#endregion
+//#region src/parser/percent.ts
+/**
+* Converts a value into a percentage of `maxValue` and parses the result with
+* the shared numeric parser.
+*
+* @template TFallback Fallback value type returned when parsing fails.
+* @param value Current value.
+* @param maxValue Maximum value representing `100%`.
+* @param settings Numeric parser settings for the computed percentage.
+* @returns Parsed percentage or fallback value.
+*
+* @example
+* ```ts
+* percent(25, 200); // 12.5
+* ```
+*
+* @example
+* ```ts
+* percent('bad', 100, { fallback: 0 }); // 0
+* ```
+*/
+var percent = (value, maxValue, settings) => {
+	return number(Number(value) / Number(maxValue) * 100, settings);
 };
-const _exports = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
-  __proto__: null,
-  number,
-  percent,
-  string
-}, Symbol.toStringTag, { value: "Module" }));
-export {
-  _exports as parser
+//#endregion
+//#region src/parser/string.ts
+/**
+* Converts arbitrary input into a string representation.
+*
+* Objects are serialized with `JSON.stringify`, optionally pretty-printed, and
+* nullish values resolve to the configured fallback.
+*
+* @template TFallback Fallback value type returned for nullish input.
+* @param input Raw value to stringify.
+* @param settings String conversion settings.
+* @returns Stringified input or fallback value.
+*
+* @example
+* ```ts
+* string(123); // '123'
+* ```
+*
+* @example
+* ```ts
+* string({ id: 1 }, { prettyJson: true });
+* ```
+*/
+var string = (input, settings) => {
+	const fallback = settings && "fallback" in settings ? settings.fallback : "";
+	if (input == null) return fallback;
+	if (typeGuard.isObject(input)) {
+		if (settings?.prettyJson) return JSON.stringify(input, null, 2);
+		return JSON.stringify(input);
+	}
+	return String(input);
 };
-//# sourceMappingURL=parser.js.map
+//#endregion
+//#region src/parser/_exports.ts
+var _exports_exports = /* @__PURE__ */ __exportAll({
+	number: () => number,
+	percent: () => percent,
+	string: () => string
+});
+//#endregion
+export { _exports_exports as parser };
+
+//# sourceMappingURL=parser.js.map

package/parser.js.map

@@ -1 +1 @@
-{"version":3,"file":"parser.js","sources":["../src/parser/number.ts","../src/parser/percent.ts","../src/parser/string.ts"],"sourcesContent":["import { format } from 'yummies/format';\nimport { typeGuard } from 'yummies/type-guard';\nimport type { Maybe } from 'yummies/types';\n\nexport interface NumberParserSettings<TFallback = number> {\n  digits?: number;\n  fallback?: TFallback;\n  /**\n   * Round to upper boundary\n   * 5.1 -> 6\n   */\n  ceil?: boolean;\n  /**\n   * Round to bottom boundary\n   * 5.9 -> 5\n   */\n  floor?: boolean;\n  clamped?: [min?: Maybe<number>, max?: Maybe<number>];\n}\n\n/**\n * Parses a number from raw input and optionally clamps, rounds or limits\n * fractional digits.\n *\n * Strings are normalized by removing spaces and replacing `,` with `.` before\n * parsing. Invalid inputs return the configured fallback.\n *\n * @template TFallback Fallback value type returned when parsing fails.\n * @param input Raw value to parse.\n * @param userSettings Parser settings merged with `number.defaultSettings`.\n * @returns Parsed number or fallback value.\n *\n * @example\n * ```ts\n * number('1 234,5'); // 1234.5\n * ```\n *\n * @example\n * ```ts\n * number('bad', { fallback: 0 }); // 0\n * ```\n */\nexport const number = <TFallback = number>(\n  input: Maybe<unknown>,\n  userSettings?: Maybe<NumberParserSettings<TFallback>>,\n): number | TFallback => {\n  const settings = {\n    ...number.defaultSettings,\n    ...userSettings,\n  };\n\n  const fallback = (\n    'fallback' in settings ? settings.fallback : 0\n  ) as TFallback;\n\n  let result: number;\n\n  if (typeGuard.isNumber(input)) {\n    result = input;\n  } else if (typeGuard.isString(input)) {\n    const formattedInput = format.skipSpaces(input).replace(',', '.');\n    if (formattedInput === '') {\n      result = fallback as any;\n    } else {\n      result = Number(formattedInput);\n    }\n  } else {\n    result = fallback as any;\n  }\n\n  if (typeGuard.isNumber(result)) {\n    if (settings?.clamped != null) {\n      result = Math.max(\n        settings.clamped[0] ?? -Infinity,\n        Math.min(result, settings.clamped[1] ?? Infinity),\n      );\n    }\n\n    if (settings?.ceil != null) {\n      result = Math.ceil(result);\n    }\n\n    if (settings?.floor != null) {\n      result = Math.floor(result);\n    }\n\n    if (settings?.digits != null) {\n      result = +result.toFixed(settings.digits);\n    }\n\n    return result;\n  } else {\n    return fallback;\n  }\n};\n\nnumber.defaultSettings = {} as NumberParserSettings;\n","import type { Maybe } from 'yummies/types';\n\nimport { type NumberParserSettings, number } from './number.js';\n\n/**\n * Converts a value into a percentage of `maxValue` and parses the result with\n * the shared numeric parser.\n *\n * @template TFallback Fallback value type returned when parsing fails.\n * @param value Current value.\n * @param maxValue Maximum value representing `100%`.\n * @param settings Numeric parser settings for the computed percentage.\n * @returns Parsed percentage or fallback value.\n *\n * @example\n * ```ts\n * percent(25, 200); // 12.5\n * ```\n *\n * @example\n * ```ts\n * percent('bad', 100, { fallback: 0 }); // 0\n * ```\n */\nexport const percent = <TFallback = number>(\n  value: Maybe<string | number>,\n  maxValue?: Maybe<string | number>,\n  settings?: Maybe<NumberParserSettings<TFallback>>,\n) => {\n  return number<TFallback>((Number(value) / Number(maxValue)) * 100, settings);\n};\n","import { typeGuard } from 'yummies/type-guard';\nimport type { Maybe } from 'yummies/types';\n\nexport interface StringParserSettings<TFallback = string> {\n  fallback?: TFallback;\n  prettyJson?: boolean;\n}\n\n/**\n * Converts arbitrary input into a string representation.\n *\n * Objects are serialized with `JSON.stringify`, optionally pretty-printed, and\n * nullish values resolve to the configured fallback.\n *\n * @template TFallback Fallback value type returned for nullish input.\n * @param input Raw value to stringify.\n * @param settings String conversion settings.\n * @returns Stringified input or fallback value.\n *\n * @example\n * ```ts\n * string(123); // '123'\n * ```\n *\n * @example\n * ```ts\n * string({ id: 1 }, { prettyJson: true });\n * ```\n */\nexport const string = <TFallback = string>(\n  input: Maybe<unknown>,\n  settings?: Maybe<StringParserSettings<TFallback>>,\n): string | TFallback => {\n  const fallback =\n    settings && 'fallback' in settings ? (settings.fallback as TFallback) : '';\n\n  if (input == null) {\n    return fallback;\n  }\n\n  if (typeGuard.isObject(input)) {\n    if (settings?.prettyJson) {\n      return JSON.stringify(input, null, 2);\n    }\n\n    return JSON.stringify(input);\n  }\n\n  return String(input);\n};\n"],"names":[],"mappings":";;AA0CO,MAAM,SAAS,CACpB,OACA,iBACuB;AACvB,QAAM,WAAW;AAAA,IACf,GAAG,OAAO;AAAA,IACV,GAAG;AAAA,EAAA;AAGL,QAAM,WACJ,cAAc,WAAW,SAAS,WAAW;AAG/C,MAAI;AAEJ,MAAI,UAAU,SAAS,KAAK,GAAG;AAC7B,aAAS;AAAA,EACX,WAAW,UAAU,SAAS,KAAK,GAAG;AACpC,UAAM,iBAAiB,OAAO,WAAW,KAAK,EAAE,QAAQ,KAAK,GAAG;AAChE,QAAI,mBAAmB,IAAI;AACzB,eAAS;AAAA,IACX,OAAO;AACL,eAAS,OAAO,cAAc;AAAA,IAChC;AAAA,EACF,OAAO;AACL,aAAS;AAAA,EACX;AAEA,MAAI,UAAU,SAAS,MAAM,GAAG;AAC9B,QAAI,UAAU,WAAW,MAAM;AAC7B,eAAS,KAAK;AAAA,QACZ,SAAS,QAAQ,CAAC,KAAK;AAAA,QACvB,KAAK,IAAI,QAAQ,SAAS,QAAQ,CAAC,KAAK,QAAQ;AAAA,MAAA;AAAA,IAEpD;AAEA,QAAI,UAAU,QAAQ,MAAM;AAC1B,eAAS,KAAK,KAAK,MAAM;AAAA,IAC3B;AAEA,QAAI,UAAU,SAAS,MAAM;AAC3B,eAAS,KAAK,MAAM,MAAM;AAAA,IAC5B;AAEA,QAAI,UAAU,UAAU,MAAM;AAC5B,eAAS,CAAC,OAAO,QAAQ,SAAS,MAAM;AAAA,IAC1C;AAEA,WAAO;AAAA,EACT,OAAO;AACL,WAAO;AAAA,EACT;AACF;AAEA,OAAO,kBAAkB,CAAA;ACxElB,MAAM,UAAU,CACrB,OACA,UACA,aACG;AACH,SAAO,OAAmB,OAAO,KAAK,IAAI,OAAO,QAAQ,IAAK,KAAK,QAAQ;AAC7E;ACDO,MAAM,SAAS,CACpB,OACA,aACuB;AACvB,QAAM,WACJ,YAAY,cAAc,WAAY,SAAS,WAAyB;AAE1E,MAAI,SAAS,MAAM;AACjB,WAAO;AAAA,EACT;AAEA,MAAI,UAAU,SAAS,KAAK,GAAG;AAC7B,QAAI,UAAU,YAAY;AACxB,aAAO,KAAK,UAAU,OAAO,MAAM,CAAC;AAAA,IACtC;AAEA,WAAO,KAAK,UAAU,KAAK;AAAA,EAC7B;AAEA,SAAO,OAAO,KAAK;AACrB;;;;;;;"}
+{"version":3,"file":"parser.js","names":[],"sources":["../src/parser/number.ts","../src/parser/percent.ts","../src/parser/string.ts","../src/parser/_exports.ts"],"sourcesContent":["import { format } from 'yummies/format';\nimport { typeGuard } from 'yummies/type-guard';\nimport type { Maybe } from 'yummies/types';\n\nexport interface NumberParserSettings<TFallback = number> {\n  digits?: number;\n  fallback?: TFallback;\n  /**\n   * Round to upper boundary\n   * 5.1 -> 6\n   */\n  ceil?: boolean;\n  /**\n   * Round to bottom boundary\n   * 5.9 -> 5\n   */\n  floor?: boolean;\n  clamped?: [min?: Maybe<number>, max?: Maybe<number>];\n}\n\n/**\n * Parses a number from raw input and optionally clamps, rounds or limits\n * fractional digits.\n *\n * Strings are normalized by removing spaces and replacing `,` with `.` before\n * parsing. Invalid inputs return the configured fallback.\n *\n * @template TFallback Fallback value type returned when parsing fails.\n * @param input Raw value to parse.\n * @param userSettings Parser settings merged with `number.defaultSettings`.\n * @returns Parsed number or fallback value.\n *\n * @example\n * ```ts\n * number('1 234,5'); // 1234.5\n * ```\n *\n * @example\n * ```ts\n * number('bad', { fallback: 0 }); // 0\n * ```\n */\nexport const number = <TFallback = number>(\n  input: Maybe<unknown>,\n  userSettings?: Maybe<NumberParserSettings<TFallback>>,\n): number | TFallback => {\n  const settings = {\n    ...number.defaultSettings,\n    ...userSettings,\n  };\n\n  const fallback = (\n    'fallback' in settings ? settings.fallback : 0\n  ) as TFallback;\n\n  let result: number;\n\n  if (typeGuard.isNumber(input)) {\n    result = input;\n  } else if (typeGuard.isString(input)) {\n    const formattedInput = format.skipSpaces(input).replace(',', '.');\n    if (formattedInput === '') {\n      result = fallback as any;\n    } else {\n      result = Number(formattedInput);\n    }\n  } else {\n    result = fallback as any;\n  }\n\n  if (typeGuard.isNumber(result)) {\n    if (settings?.clamped != null) {\n      result = Math.max(\n        settings.clamped[0] ?? -Infinity,\n        Math.min(result, settings.clamped[1] ?? Infinity),\n      );\n    }\n\n    if (settings?.ceil != null) {\n      result = Math.ceil(result);\n    }\n\n    if (settings?.floor != null) {\n      result = Math.floor(result);\n    }\n\n    if (settings?.digits != null) {\n      result = +result.toFixed(settings.digits);\n    }\n\n    return result;\n  } else {\n    return fallback;\n  }\n};\n\nnumber.defaultSettings = {} as NumberParserSettings;\n","import type { Maybe } from 'yummies/types';\n\nimport { type NumberParserSettings, number } from './number.js';\n\n/**\n * Converts a value into a percentage of `maxValue` and parses the result with\n * the shared numeric parser.\n *\n * @template TFallback Fallback value type returned when parsing fails.\n * @param value Current value.\n * @param maxValue Maximum value representing `100%`.\n * @param settings Numeric parser settings for the computed percentage.\n * @returns Parsed percentage or fallback value.\n *\n * @example\n * ```ts\n * percent(25, 200); // 12.5\n * ```\n *\n * @example\n * ```ts\n * percent('bad', 100, { fallback: 0 }); // 0\n * ```\n */\nexport const percent = <TFallback = number>(\n  value: Maybe<string | number>,\n  maxValue?: Maybe<string | number>,\n  settings?: Maybe<NumberParserSettings<TFallback>>,\n) => {\n  return number<TFallback>((Number(value) / Number(maxValue)) * 100, settings);\n};\n","import { typeGuard } from 'yummies/type-guard';\nimport type { Maybe } from 'yummies/types';\n\nexport interface StringParserSettings<TFallback = string> {\n  fallback?: TFallback;\n  prettyJson?: boolean;\n}\n\n/**\n * Converts arbitrary input into a string representation.\n *\n * Objects are serialized with `JSON.stringify`, optionally pretty-printed, and\n * nullish values resolve to the configured fallback.\n *\n * @template TFallback Fallback value type returned for nullish input.\n * @param input Raw value to stringify.\n * @param settings String conversion settings.\n * @returns Stringified input or fallback value.\n *\n * @example\n * ```ts\n * string(123); // '123'\n * ```\n *\n * @example\n * ```ts\n * string({ id: 1 }, { prettyJson: true });\n * ```\n */\nexport const string = <TFallback = string>(\n  input: Maybe<unknown>,\n  settings?: Maybe<StringParserSettings<TFallback>>,\n): string | TFallback => {\n  const fallback =\n    settings && 'fallback' in settings ? (settings.fallback as TFallback) : '';\n\n  if (input == null) {\n    return fallback;\n  }\n\n  if (typeGuard.isObject(input)) {\n    if (settings?.prettyJson) {\n      return JSON.stringify(input, null, 2);\n    }\n\n    return JSON.stringify(input);\n  }\n\n  return String(input);\n};\n","/**\n * ---header-docs-section---\n * # yummies/parser\n *\n * ## Description\n *\n * Parsers for user-entered **numbers, percents, and strings** with tolerant input and typed\n * results. Use when normalizing form values, query params, or CSV-like text before validation\n * schemas run, without duplicating regex and `parseFloat` edge cases in every feature module.\n *\n * ## Usage\n *\n * ```ts\n * import { parser } from \"yummies/parser\";\n * ```\n */\n\nexport * from './number.js';\nexport * from './percent.js';\nexport * from './string.js';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AA0CA,IAAa,UACX,OACA,iBACuB;CACvB,MAAM,WAAW;EACf,GAAG,OAAO;EACV,GAAG;EACJ;CAED,MAAM,WACJ,cAAc,WAAW,SAAS,WAAW;CAG/C,IAAI;AAEJ,KAAI,UAAU,SAAS,MAAM,CAC3B,UAAS;UACA,UAAU,SAAS,MAAM,EAAE;EACpC,MAAM,iBAAiB,OAAO,WAAW,MAAM,CAAC,QAAQ,KAAK,IAAI;AACjE,MAAI,mBAAmB,GACrB,UAAS;MAET,UAAS,OAAO,eAAe;OAGjC,UAAS;AAGX,KAAI,UAAU,SAAS,OAAO,EAAE;AAC9B,MAAI,UAAU,WAAW,KACvB,UAAS,KAAK,IACZ,SAAS,QAAQ,MAAM,WACvB,KAAK,IAAI,QAAQ,SAAS,QAAQ,MAAM,SAAS,CAClD;AAGH,MAAI,UAAU,QAAQ,KACpB,UAAS,KAAK,KAAK,OAAO;AAG5B,MAAI,UAAU,SAAS,KACrB,UAAS,KAAK,MAAM,OAAO;AAG7B,MAAI,UAAU,UAAU,KACtB,UAAS,CAAC,OAAO,QAAQ,SAAS,OAAO;AAG3C,SAAO;OAEP,QAAO;;AAIX,OAAO,kBAAkB,EAAE;;;;;;;;;;;;;;;;;;;;;;;ACxE3B,IAAa,WACX,OACA,UACA,aACG;AACH,QAAO,OAAmB,OAAO,MAAM,GAAG,OAAO,SAAS,GAAI,KAAK,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;ACA9E,IAAa,UACX,OACA,aACuB;CACvB,MAAM,WACJ,YAAY,cAAc,WAAY,SAAS,WAAyB;AAE1E,KAAI,SAAS,KACX,QAAO;AAGT,KAAI,UAAU,SAAS,MAAM,EAAE;AAC7B,MAAI,UAAU,WACZ,QAAO,KAAK,UAAU,OAAO,MAAM,EAAE;AAGvC,SAAO,KAAK,UAAU,MAAM;;AAG9B,QAAO,OAAO,MAAM"}

package/price.cjs

@@ -1,21 +1,27 @@
-"use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const formatPrice = (price, locale, currency, { withoutSymbol, customSymbol, ...options } = {}) => {
-  const priceFormatter = new Intl.NumberFormat(locale, {
-    style: "currency",
-    currency,
-    minimumFractionDigits: 0,
-    currencyDisplay: "narrowSymbol",
-    ...options
-  });
-  const zeroPrice = priceFormatter.format(0);
-  const currencySymbol = zeroPrice.replace("0", "");
-  const rawPrice = priceFormatter.format(price);
-  const priceWithoutCurrency = rawPrice.replace(currencySymbol, "");
-  if (withoutSymbol) {
-    return priceWithoutCurrency;
-  }
-  return `${priceWithoutCurrency} ${customSymbol ?? (currency === "RUB" ? "р" : currencySymbol)}`.replace(/\s{2,}/, " ");
+//#region src/price.ts
+/**
+* Formats a numeric price using locale and currency options.
+*
+* @example
+* ```ts
+* formatPrice(1990, 'ru-RU', 'RUB');
+* ```
+*/
+var formatPrice = (price, locale, currency, { withoutSymbol, customSymbol, ...options } = {}) => {
+	const priceFormatter = new Intl.NumberFormat(locale, {
+		style: "currency",
+		currency,
+		minimumFractionDigits: 0,
+		currencyDisplay: "narrowSymbol",
+		...options
+	});
+	const currencySymbol = priceFormatter.format(0).replace("0", "");
+	const priceWithoutCurrency = priceFormatter.format(price).replace(currencySymbol, "");
+	if (withoutSymbol) return priceWithoutCurrency;
+	return `${priceWithoutCurrency} ${customSymbol ?? (currency === "RUB" ? "р" : currencySymbol)}`.replace(/\s{2,}/, " ");
 };
+//#endregion
 exports.formatPrice = formatPrice;
-//# sourceMappingURL=price.cjs.map
+
+//# sourceMappingURL=price.cjs.map

package/price.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"price.cjs","sources":["../src/price.ts"],"sourcesContent":["export interface PriceFormatOptions\n  extends Partial<Omit<Intl.NumberFormatOptions, 'currency'>> {\n  withoutSymbol?: boolean;\n  customSymbol?: string;\n}\n\nexport const formatPrice = (\n  price: number,\n  locale: string,\n  currency?: string,\n  { withoutSymbol, customSymbol, ...options }: PriceFormatOptions = {},\n) => {\n  const priceFormatter = new Intl.NumberFormat(locale, {\n    style: 'currency',\n    currency,\n    minimumFractionDigits: 0,\n    currencyDisplay: 'narrowSymbol',\n    ...options,\n  });\n\n  const zeroPrice = priceFormatter.format(0);\n  const currencySymbol = zeroPrice.replace('0', '');\n  const rawPrice = priceFormatter.format(price);\n  const priceWithoutCurrency = rawPrice.replace(currencySymbol, '');\n\n  if (withoutSymbol) {\n    return priceWithoutCurrency;\n  }\n\n  return `${priceWithoutCurrency} ${\n    customSymbol ?? (currency === 'RUB' ? 'р' : currencySymbol)\n  }`.replace(/\\s{2,}/, ' ');\n};\n"],"names":[],"mappings":";;AAMO,MAAM,cAAc,CACzB,OACA,QACA,UACA,EAAE,eAAe,cAAc,GAAG,QAAA,IAAgC,OAC/D;AACH,QAAM,iBAAiB,IAAI,KAAK,aAAa,QAAQ;AAAA,IACnD,OAAO;AAAA,IACP;AAAA,IACA,uBAAuB;AAAA,IACvB,iBAAiB;AAAA,IACjB,GAAG;AAAA,EAAA,CACJ;AAED,QAAM,YAAY,eAAe,OAAO,CAAC;AACzC,QAAM,iBAAiB,UAAU,QAAQ,KAAK,EAAE;AAChD,QAAM,WAAW,eAAe,OAAO,KAAK;AAC5C,QAAM,uBAAuB,SAAS,QAAQ,gBAAgB,EAAE;AAEhE,MAAI,eAAe;AACjB,WAAO;AAAA,EACT;AAEA,SAAO,GAAG,oBAAoB,IAC5B,iBAAiB,aAAa,QAAQ,MAAM,eAC9C,GAAG,QAAQ,UAAU,GAAG;AAC1B;;"}
+{"version":3,"file":"price.cjs","names":[],"sources":["../src/price.ts"],"sourcesContent":["/**\n * ---header-docs-section---\n * # yummies/price\n *\n * ## Description\n *\n * Locale-aware **money formatting** via `Intl.NumberFormat`, with optional symbol hiding and\n * custom currency symbols for legacy UI. It wraps browser i18n APIs so storefronts and dashboards\n * share one implementation for RUB/EUR/USD-style output without pulling a heavy formatting library.\n *\n * ## Usage\n *\n * ```ts\n * import { formatPrice } from \"yummies/price\";\n * ```\n */\n\nexport interface PriceFormatOptions\n  extends Partial<Omit<Intl.NumberFormatOptions, 'currency'>> {\n  withoutSymbol?: boolean;\n  customSymbol?: string;\n}\n\n/**\n * Formats a numeric price using locale and currency options.\n *\n * @example\n * ```ts\n * formatPrice(1990, 'ru-RU', 'RUB');\n * ```\n */\nexport const formatPrice = (\n  price: number,\n  locale: string,\n  currency?: string,\n  { withoutSymbol, customSymbol, ...options }: PriceFormatOptions = {},\n) => {\n  const priceFormatter = new Intl.NumberFormat(locale, {\n    style: 'currency',\n    currency,\n    minimumFractionDigits: 0,\n    currencyDisplay: 'narrowSymbol',\n    ...options,\n  });\n\n  const zeroPrice = priceFormatter.format(0);\n  const currencySymbol = zeroPrice.replace('0', '');\n  const rawPrice = priceFormatter.format(price);\n  const priceWithoutCurrency = rawPrice.replace(currencySymbol, '');\n\n  if (withoutSymbol) {\n    return priceWithoutCurrency;\n  }\n\n  return `${priceWithoutCurrency} ${\n    customSymbol ?? (currency === 'RUB' ? 'р' : currencySymbol)\n  }`.replace(/\\s{2,}/, ' ');\n};\n"],"mappings":";;;;;;;;;;AA+BA,IAAa,eACX,OACA,QACA,UACA,EAAE,eAAe,cAAc,GAAG,YAAgC,EAAE,KACjE;CACH,MAAM,iBAAiB,IAAI,KAAK,aAAa,QAAQ;EACnD,OAAO;EACP;EACA,uBAAuB;EACvB,iBAAiB;EACjB,GAAG;EACJ,CAAC;CAGF,MAAM,iBADY,eAAe,OAAO,EAAE,CACT,QAAQ,KAAK,GAAG;CAEjD,MAAM,uBADW,eAAe,OAAO,MAAM,CACP,QAAQ,gBAAgB,GAAG;AAEjE,KAAI,cACF,QAAO;AAGT,QAAO,GAAG,qBAAqB,GAC7B,iBAAiB,aAAa,QAAQ,MAAM,kBAC3C,QAAQ,UAAU,IAAI"}

package/price.d.ts

@@ -1,7 +1,31 @@
+/**
+ * ---header-docs-section---
+ * # yummies/price
+ *
+ * ## Description
+ *
+ * Locale-aware **money formatting** via `Intl.NumberFormat`, with optional symbol hiding and
+ * custom currency symbols for legacy UI. It wraps browser i18n APIs so storefronts and dashboards
+ * share one implementation for RUB/EUR/USD-style output without pulling a heavy formatting library.
+ *
+ * ## Usage
+ *
+ * ```ts
+ * import { formatPrice } from "yummies/price";
+ * ```
+ */
 interface PriceFormatOptions extends Partial<Omit<Intl.NumberFormatOptions, 'currency'>> {
     withoutSymbol?: boolean;
     customSymbol?: string;
 }
+/**
+ * Formats a numeric price using locale and currency options.
+ *
+ * @example
+ * ```ts
+ * formatPrice(1990, 'ru-RU', 'RUB');
+ * ```
+ */
 declare const formatPrice: (price: number, locale: string, currency?: string, { withoutSymbol, customSymbol, ...options }?: PriceFormatOptions) => string;
 
 export { formatPrice };

package/price.js

@@ -1,21 +1,26 @@
-const formatPrice = (price, locale, currency, { withoutSymbol, customSymbol, ...options } = {}) => {
-  const priceFormatter = new Intl.NumberFormat(locale, {
-    style: "currency",
-    currency,
-    minimumFractionDigits: 0,
-    currencyDisplay: "narrowSymbol",
-    ...options
-  });
-  const zeroPrice = priceFormatter.format(0);
-  const currencySymbol = zeroPrice.replace("0", "");
-  const rawPrice = priceFormatter.format(price);
-  const priceWithoutCurrency = rawPrice.replace(currencySymbol, "");
-  if (withoutSymbol) {
-    return priceWithoutCurrency;
-  }
-  return `${priceWithoutCurrency} ${customSymbol ?? (currency === "RUB" ? "р" : currencySymbol)}`.replace(/\s{2,}/, " ");
+//#region src/price.ts
+/**
+* Formats a numeric price using locale and currency options.
+*
+* @example
+* ```ts
+* formatPrice(1990, 'ru-RU', 'RUB');
+* ```
+*/
+var formatPrice = (price, locale, currency, { withoutSymbol, customSymbol, ...options } = {}) => {
+	const priceFormatter = new Intl.NumberFormat(locale, {
+		style: "currency",
+		currency,
+		minimumFractionDigits: 0,
+		currencyDisplay: "narrowSymbol",
+		...options
+	});
+	const currencySymbol = priceFormatter.format(0).replace("0", "");
+	const priceWithoutCurrency = priceFormatter.format(price).replace(currencySymbol, "");
+	if (withoutSymbol) return priceWithoutCurrency;
+	return `${priceWithoutCurrency} ${customSymbol ?? (currency === "RUB" ? "р" : currencySymbol)}`.replace(/\s{2,}/, " ");
 };
-export {
-  formatPrice
-};
-//# sourceMappingURL=price.js.map
+//#endregion
+export { formatPrice };
+
+//# sourceMappingURL=price.js.map

package/price.js.map

@@ -1 +1 @@
-{"version":3,"file":"price.js","sources":["../src/price.ts"],"sourcesContent":["export interface PriceFormatOptions\n  extends Partial<Omit<Intl.NumberFormatOptions, 'currency'>> {\n  withoutSymbol?: boolean;\n  customSymbol?: string;\n}\n\nexport const formatPrice = (\n  price: number,\n  locale: string,\n  currency?: string,\n  { withoutSymbol, customSymbol, ...options }: PriceFormatOptions = {},\n) => {\n  const priceFormatter = new Intl.NumberFormat(locale, {\n    style: 'currency',\n    currency,\n    minimumFractionDigits: 0,\n    currencyDisplay: 'narrowSymbol',\n    ...options,\n  });\n\n  const zeroPrice = priceFormatter.format(0);\n  const currencySymbol = zeroPrice.replace('0', '');\n  const rawPrice = priceFormatter.format(price);\n  const priceWithoutCurrency = rawPrice.replace(currencySymbol, '');\n\n  if (withoutSymbol) {\n    return priceWithoutCurrency;\n  }\n\n  return `${priceWithoutCurrency} ${\n    customSymbol ?? (currency === 'RUB' ? 'р' : currencySymbol)\n  }`.replace(/\\s{2,}/, ' ');\n};\n"],"names":[],"mappings":"AAMO,MAAM,cAAc,CACzB,OACA,QACA,UACA,EAAE,eAAe,cAAc,GAAG,QAAA,IAAgC,OAC/D;AACH,QAAM,iBAAiB,IAAI,KAAK,aAAa,QAAQ;AAAA,IACnD,OAAO;AAAA,IACP;AAAA,IACA,uBAAuB;AAAA,IACvB,iBAAiB;AAAA,IACjB,GAAG;AAAA,EAAA,CACJ;AAED,QAAM,YAAY,eAAe,OAAO,CAAC;AACzC,QAAM,iBAAiB,UAAU,QAAQ,KAAK,EAAE;AAChD,QAAM,WAAW,eAAe,OAAO,KAAK;AAC5C,QAAM,uBAAuB,SAAS,QAAQ,gBAAgB,EAAE;AAEhE,MAAI,eAAe;AACjB,WAAO;AAAA,EACT;AAEA,SAAO,GAAG,oBAAoB,IAC5B,iBAAiB,aAAa,QAAQ,MAAM,eAC9C,GAAG,QAAQ,UAAU,GAAG;AAC1B;"}
+{"version":3,"file":"price.js","names":[],"sources":["../src/price.ts"],"sourcesContent":["/**\n * ---header-docs-section---\n * # yummies/price\n *\n * ## Description\n *\n * Locale-aware **money formatting** via `Intl.NumberFormat`, with optional symbol hiding and\n * custom currency symbols for legacy UI. It wraps browser i18n APIs so storefronts and dashboards\n * share one implementation for RUB/EUR/USD-style output without pulling a heavy formatting library.\n *\n * ## Usage\n *\n * ```ts\n * import { formatPrice } from \"yummies/price\";\n * ```\n */\n\nexport interface PriceFormatOptions\n  extends Partial<Omit<Intl.NumberFormatOptions, 'currency'>> {\n  withoutSymbol?: boolean;\n  customSymbol?: string;\n}\n\n/**\n * Formats a numeric price using locale and currency options.\n *\n * @example\n * ```ts\n * formatPrice(1990, 'ru-RU', 'RUB');\n * ```\n */\nexport const formatPrice = (\n  price: number,\n  locale: string,\n  currency?: string,\n  { withoutSymbol, customSymbol, ...options }: PriceFormatOptions = {},\n) => {\n  const priceFormatter = new Intl.NumberFormat(locale, {\n    style: 'currency',\n    currency,\n    minimumFractionDigits: 0,\n    currencyDisplay: 'narrowSymbol',\n    ...options,\n  });\n\n  const zeroPrice = priceFormatter.format(0);\n  const currencySymbol = zeroPrice.replace('0', '');\n  const rawPrice = priceFormatter.format(price);\n  const priceWithoutCurrency = rawPrice.replace(currencySymbol, '');\n\n  if (withoutSymbol) {\n    return priceWithoutCurrency;\n  }\n\n  return `${priceWithoutCurrency} ${\n    customSymbol ?? (currency === 'RUB' ? 'р' : currencySymbol)\n  }`.replace(/\\s{2,}/, ' ');\n};\n"],"mappings":";;;;;;;;;AA+BA,IAAa,eACX,OACA,QACA,UACA,EAAE,eAAe,cAAc,GAAG,YAAgC,EAAE,KACjE;CACH,MAAM,iBAAiB,IAAI,KAAK,aAAa,QAAQ;EACnD,OAAO;EACP;EACA,uBAAuB;EACvB,iBAAiB;EACjB,GAAG;EACJ,CAAC;CAGF,MAAM,iBADY,eAAe,OAAO,EAAE,CACT,QAAQ,KAAK,GAAG;CAEjD,MAAM,uBADW,eAAe,OAAO,MAAM,CACP,QAAQ,gBAAgB,GAAG;AAEjE,KAAI,cACF,QAAO;AAGT,QAAO,GAAG,qBAAqB,GAC7B,iBAAiB,aAAa,QAAQ,MAAM,kBAC3C,QAAQ,UAAU,IAAI"}

package/random.cjs

@@ -1,19 +1,100 @@
-"use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const getRandomFloat = (min = 0, max = 1) => Math.random() * (max - min) + min;
-const getRandomInt = (min = 0, max = 1) => min === max ? min : Math.round(getRandomFloat(min, max));
-const getRandomChoice = (arr) => arr[getRandomInt(0, arr.length - 1)];
-const getRandomSizeArray = (min = 0, max = 10) => Array.from({ length: getRandomInt(min, max) }).fill(null);
-const getRandomBool = () => getRandomInt(0, 1) === 1;
-const getMajorRandomBool = () => {
-  return getRandomInt(0, 10) <= 6;
+//#region src/random.ts
+/**
+* ---header-docs-section---
+* # yummies/random
+*
+* ## Description
+*
+* Small RNG helpers for UI demos, games, and sampling: floats, integers, and random choices from
+* arrays. They wrap `Math.random` (not cryptographically secure) so prefer platform `crypto` when
+* generating secrets, tokens, or lottery outcomes.
+*
+* ## Usage
+*
+* ```ts
+* import { getRandomInt, getRandomChoice } from "yummies/random";
+* ```
+*/
+/**
+* Returns a random floating-point number between `min` and `max`.
+*
+* @example
+* ```ts
+* const value = getRandomFloat(1, 10);
+* ```
+*/
+var getRandomFloat = (min = 0, max = 1) => Math.random() * (max - min) + min;
+/**
+* Returns a random integer between `min` and `max`.
+*
+* @example
+* ```ts
+* const value = getRandomInt(1, 10);
+* ```
+*/
+var getRandomInt = (min = 0, max = 1) => min === max ? min : Math.round(getRandomFloat(min, max));
+/**
+* Picks a random element from the provided array.
+*
+* @example
+* ```ts
+* const fruit = getRandomChoice(['apple', 'banana', 'orange']);
+* ```
+*/
+var getRandomChoice = (arr) => arr[getRandomInt(0, arr.length - 1)];
+/**
+* Creates an array filled with `null` values using a random length.
+*
+* @example
+* ```ts
+* const items = getRandomSizeArray(2, 5);
+* ```
+*/
+var getRandomSizeArray = (min = 0, max = 10) => Array.from({ length: getRandomInt(min, max) }).fill(null);
+/**
+* Returns a uniformly random boolean.
+*
+* @example
+* ```ts
+* const value = getRandomBool();
+* ```
+*/
+var getRandomBool = () => getRandomInt(0, 1) === 1;
+/**
+* Returns `true` more often than `false`.
+*
+* @example
+* ```ts
+* const value = getMajorRandomBool();
+* ```
+*/
+var getMajorRandomBool = () => {
+	return getRandomInt(0, 10) <= 6;
 };
-const getMinorRandomBool = () => {
-  return !getMajorRandomBool();
+/**
+* Returns `true` less often than `false`.
+*
+* @example
+* ```ts
+* const value = getMinorRandomBool();
+* ```
+*/
+var getMinorRandomBool = () => {
+	return !getMajorRandomBool();
 };
-const getFrequencyValue = (frequency) => {
-  return Math.random() < frequency;
+/**
+* Returns `true` with the provided probability from `0` to `1`.
+*
+* @example
+* ```ts
+* const shouldRun = getFrequencyValue(0.25);
+* ```
+*/
+var getFrequencyValue = (frequency) => {
+	return Math.random() < frequency;
 };
+//#endregion
 exports.getFrequencyValue = getFrequencyValue;
 exports.getMajorRandomBool = getMajorRandomBool;
 exports.getMinorRandomBool = getMinorRandomBool;
@@ -22,4 +103,5 @@ exports.getRandomChoice = getRandomChoice;
 exports.getRandomFloat = getRandomFloat;
 exports.getRandomInt = getRandomInt;
 exports.getRandomSizeArray = getRandomSizeArray;
-//# sourceMappingURL=random.cjs.map
+
+//# sourceMappingURL=random.cjs.map

package/random.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"random.cjs","sources":["../src/random.ts"],"sourcesContent":["export const getRandomFloat = <T extends number = number>(\n  min = 0,\n  max = 1,\n): T => (Math.random() * (max - min) + min) as T;\n\nexport const getRandomInt = <T extends number = number>(min = 0, max = 1): T =>\n  min === max ? (min as T) : (Math.round(getRandomFloat(min, max)) as T);\n\nexport const getRandomChoice = <T>(arr: T[]): T =>\n  arr[getRandomInt(0, arr.length - 1)];\n\nexport const getRandomSizeArray = (min = 0, max = 10) =>\n  Array.from({ length: getRandomInt(min, max) }).fill(null);\n\nexport const getRandomBool = () => getRandomInt(0, 1) === 1;\n\nexport const getMajorRandomBool = () => {\n  return getRandomInt(0, 10) <= 6;\n};\n\nexport const getMinorRandomBool = () => {\n  return !getMajorRandomBool();\n};\n\nexport const getFrequencyValue = (frequency: number) => {\n  return Math.random() < frequency;\n};\n"],"names":[],"mappings":";;AAAO,MAAM,iBAAiB,CAC5B,MAAM,GACN,MAAM,MACC,KAAK,OAAA,KAAY,MAAM,OAAO;AAEhC,MAAM,eAAe,CAA4B,MAAM,GAAG,MAAM,MACrE,QAAQ,MAAO,MAAa,KAAK,MAAM,eAAe,KAAK,GAAG,CAAC;AAE1D,MAAM,kBAAkB,CAAI,QACjC,IAAI,aAAa,GAAG,IAAI,SAAS,CAAC,CAAC;AAE9B,MAAM,qBAAqB,CAAC,MAAM,GAAG,MAAM,OAChD,MAAM,KAAK,EAAE,QAAQ,aAAa,KAAK,GAAG,GAAG,EAAE,KAAK,IAAI;AAEnD,MAAM,gBAAgB,MAAM,aAAa,GAAG,CAAC,MAAM;AAEnD,MAAM,qBAAqB,MAAM;AACtC,SAAO,aAAa,GAAG,EAAE,KAAK;AAChC;AAEO,MAAM,qBAAqB,MAAM;AACtC,SAAO,CAAC,mBAAA;AACV;AAEO,MAAM,oBAAoB,CAAC,cAAsB;AACtD,SAAO,KAAK,WAAW;AACzB;;;;;;;;;"}
+{"version":3,"file":"random.cjs","names":[],"sources":["../src/random.ts"],"sourcesContent":["/**\n * ---header-docs-section---\n * # yummies/random\n *\n * ## Description\n *\n * Small RNG helpers for UI demos, games, and sampling: floats, integers, and random choices from\n * arrays. They wrap `Math.random` (not cryptographically secure) so prefer platform `crypto` when\n * generating secrets, tokens, or lottery outcomes.\n *\n * ## Usage\n *\n * ```ts\n * import { getRandomInt, getRandomChoice } from \"yummies/random\";\n * ```\n */\n\n/**\n * Returns a random floating-point number between `min` and `max`.\n *\n * @example\n * ```ts\n * const value = getRandomFloat(1, 10);\n * ```\n */\nexport const getRandomFloat = <T extends number = number>(\n  min = 0,\n  max = 1,\n): T => (Math.random() * (max - min) + min) as T;\n\n/**\n * Returns a random integer between `min` and `max`.\n *\n * @example\n * ```ts\n * const value = getRandomInt(1, 10);\n * ```\n */\nexport const getRandomInt = <T extends number = number>(min = 0, max = 1): T =>\n  min === max ? (min as T) : (Math.round(getRandomFloat(min, max)) as T);\n\n/**\n * Picks a random element from the provided array.\n *\n * @example\n * ```ts\n * const fruit = getRandomChoice(['apple', 'banana', 'orange']);\n * ```\n */\nexport const getRandomChoice = <T>(arr: T[]): T =>\n  arr[getRandomInt(0, arr.length - 1)];\n\n/**\n * Creates an array filled with `null` values using a random length.\n *\n * @example\n * ```ts\n * const items = getRandomSizeArray(2, 5);\n * ```\n */\nexport const getRandomSizeArray = (min = 0, max = 10) =>\n  Array.from({ length: getRandomInt(min, max) }).fill(null);\n\n/**\n * Returns a uniformly random boolean.\n *\n * @example\n * ```ts\n * const value = getRandomBool();\n * ```\n */\nexport const getRandomBool = () => getRandomInt(0, 1) === 1;\n\n/**\n * Returns `true` more often than `false`.\n *\n * @example\n * ```ts\n * const value = getMajorRandomBool();\n * ```\n */\nexport const getMajorRandomBool = () => {\n  return getRandomInt(0, 10) <= 6;\n};\n\n/**\n * Returns `true` less often than `false`.\n *\n * @example\n * ```ts\n * const value = getMinorRandomBool();\n * ```\n */\nexport const getMinorRandomBool = () => {\n  return !getMajorRandomBool();\n};\n\n/**\n * Returns `true` with the provided probability from `0` to `1`.\n *\n * @example\n * ```ts\n * const shouldRun = getFrequencyValue(0.25);\n * ```\n */\nexport const getFrequencyValue = (frequency: number) => {\n  return Math.random() < frequency;\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,IAAa,kBACX,MAAM,GACN,MAAM,MACC,KAAK,QAAQ,IAAI,MAAM,OAAO;;;;;;;;;AAUvC,IAAa,gBAA2C,MAAM,GAAG,MAAM,MACrE,QAAQ,MAAO,MAAa,KAAK,MAAM,eAAe,KAAK,IAAI,CAAC;;;;;;;;;AAUlE,IAAa,mBAAsB,QACjC,IAAI,aAAa,GAAG,IAAI,SAAS,EAAE;;;;;;;;;AAUrC,IAAa,sBAAsB,MAAM,GAAG,MAAM,OAChD,MAAM,KAAK,EAAE,QAAQ,aAAa,KAAK,IAAI,EAAE,CAAC,CAAC,KAAK,KAAK;;;;;;;;;AAU3D,IAAa,sBAAsB,aAAa,GAAG,EAAE,KAAK;;;;;;;;;AAU1D,IAAa,2BAA2B;AACtC,QAAO,aAAa,GAAG,GAAG,IAAI;;;;;;;;;;AAWhC,IAAa,2BAA2B;AACtC,QAAO,CAAC,oBAAoB;;;;;;;;;;AAW9B,IAAa,qBAAqB,cAAsB;AACtD,QAAO,KAAK,QAAQ,GAAG"}

package/random.d.ts

@@ -1,10 +1,90 @@
+/**
+ * ---header-docs-section---
+ * # yummies/random
+ *
+ * ## Description
+ *
+ * Small RNG helpers for UI demos, games, and sampling: floats, integers, and random choices from
+ * arrays. They wrap `Math.random` (not cryptographically secure) so prefer platform `crypto` when
+ * generating secrets, tokens, or lottery outcomes.
+ *
+ * ## Usage
+ *
+ * ```ts
+ * import { getRandomInt, getRandomChoice } from "yummies/random";
+ * ```
+ */
+/**
+ * Returns a random floating-point number between `min` and `max`.
+ *
+ * @example
+ * ```ts
+ * const value = getRandomFloat(1, 10);
+ * ```
+ */
 declare const getRandomFloat: <T extends number = number>(min?: number, max?: number) => T;
+/**
+ * Returns a random integer between `min` and `max`.
+ *
+ * @example
+ * ```ts
+ * const value = getRandomInt(1, 10);
+ * ```
+ */
 declare const getRandomInt: <T extends number = number>(min?: number, max?: number) => T;
+/**
+ * Picks a random element from the provided array.
+ *
+ * @example
+ * ```ts
+ * const fruit = getRandomChoice(['apple', 'banana', 'orange']);
+ * ```
+ */
 declare const getRandomChoice: <T>(arr: T[]) => T;
+/**
+ * Creates an array filled with `null` values using a random length.
+ *
+ * @example
+ * ```ts
+ * const items = getRandomSizeArray(2, 5);
+ * ```
+ */
 declare const getRandomSizeArray: (min?: number, max?: number) => unknown[];
+/**
+ * Returns a uniformly random boolean.
+ *
+ * @example
+ * ```ts
+ * const value = getRandomBool();
+ * ```
+ */
 declare const getRandomBool: () => boolean;
+/**
+ * Returns `true` more often than `false`.
+ *
+ * @example
+ * ```ts
+ * const value = getMajorRandomBool();
+ * ```
+ */
 declare const getMajorRandomBool: () => boolean;
+/**
+ * Returns `true` less often than `false`.
+ *
+ * @example
+ * ```ts
+ * const value = getMinorRandomBool();
+ * ```
+ */
 declare const getMinorRandomBool: () => boolean;
+/**
+ * Returns `true` with the provided probability from `0` to `1`.
+ *
+ * @example
+ * ```ts
+ * const shouldRun = getFrequencyValue(0.25);
+ * ```
+ */
 declare const getFrequencyValue: (frequency: number) => boolean;
 
 export { getFrequencyValue, getMajorRandomBool, getMinorRandomBool, getRandomBool, getRandomChoice, getRandomFloat, getRandomInt, getRandomSizeArray };