yummies 7.11.0 → 7.12.0

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":["export 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":";;;;;;;;;;AAcA,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

@@ -2,6 +2,14 @@ interface PriceFormatOptions extends Partial<Omit<Intl.NumberFormatOptions, 'cur
     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":["export 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":";;;;;;;;;AAcA,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,84 @@
-"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
+/**
+* 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 +87,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 * 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":";;;;;;;;;;AAQA,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,74 @@
+/**
+ * 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 };

package/random.js

@@ -1,25 +1,83 @@
-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
+/**
+* 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;
 };
-export {
-  getFrequencyValue,
-  getMajorRandomBool,
-  getMinorRandomBool,
-  getRandomBool,
-  getRandomChoice,
-  getRandomFloat,
-  getRandomInt,
-  getRandomSizeArray
-};
-//# sourceMappingURL=random.js.map
+//#endregion
+export { getFrequencyValue, getMajorRandomBool, getMinorRandomBool, getRandomBool, getRandomChoice, getRandomFloat, getRandomInt, getRandomSizeArray };
+
+//# sourceMappingURL=random.js.map

package/random.js.map

@@ -1 +1 @@
-{"version":3,"file":"random.js","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.js","names":[],"sources":["../src/random.ts"],"sourcesContent":["/**\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":";;;;;;;;;AAQA,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"}