yummies 7.11.0 → 7.13.0

package/random.js

@@ -1,25 +1,99 @@
-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;
 };
-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 * ---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"}