randomcryp 2.0.0 → 2.1.0

package/README.md

@@ -9,7 +9,7 @@ The spelling is random-creep in case you are wondering.
 - Lightweight
 - Browser friendly
 - TypeScript definitions
-- Lots of methods and commonn aliases
+- Lots of methods and common aliases
 - Batteries Included (Zero dependencies)
 - Supported in all major JavaScript / TypeScript runtimes (Browser, Node, Deno, Bun etc.)
 
@@ -44,18 +44,19 @@ rangeInt(1, 10); // 7
 | -- | -- | -- |
 | **`bool(): boolean`** | Generates a random boolean (`true` or `false`). | `bool()` → `true` |
 | **`boolean(): boolean`** | Alias for `bool()`. | `boolean()` → `false` |
-| **`percentage(val: number): boolean`** | Generates `true` at given percentage of time. | `percentage(20)` → `false` |
+| **`percentage(p: number): boolean`** | Generates `true` at given percentage of time. | `percentage(20)` → `false` |
+| **`probability(p: number): boolean`** | Generates `true` with a given probability `p` and `false` with probability `1-p`. | `probability(0.8)` → `true` |
 | **`uSafeInt(): number`** | Generates a random integer between `0` (inclusive) and `Number.MAX_SAFE_INTEGER` (inclusive). | `uSafeInt()` → `4946544243668033` |
 | **`float(): number`** | Generates a random number between `0` (inclusive) and `1` (exclusive). | `number()` → `0.190088246732104` |
 | **`random(): number`** | Alias for `float()`. | `random()` → `0.9520779718919631` |
 | **`hex(length: number = 8, prefix: boolean = false): string`** | Generates a random hex string of the specified length (default 8). Optionally prefixes with '0x'. | `hex(16)` → `d1ef0149c7849844` |
 | **`choice(arr: ArrayLike<E>): E`** | Selects a random element from an array. | `choice([1, 2, 3, 4, 5])` → `3` |
 | **`pick(arr: ArrayLike<E>): E`** | Alias for `choice()`. | `pick([1, 2, 3, 4, 5])` → `1` |
-| **`shuffle(input: string): string`**, **`shuffle(input: Array<E>): Array<E>`** | Returns a new array or string after shuffling the given array or string. | `shuffle([1, 2, 3, 4, 5])` → `[ 1, 3, 2, 5, 4 ]` |
+| **`shuffle(input: string): string`**, **`shuffle(input: Array<E>): Array<E>`** | Returns a new array or string after shuffling the given array or string randomly. | `shuffle([1, 2, 3, 4, 5])` → `[ 1, 3, 2, 5, 4 ]` |
 | **`range(min: number, max: number): number`** | Generates a random number (not integer) between given `min` (inclusive) and `max` (exclusive). Throws if `min` > `max`. | `range(1, 5)` → `4.103370176158448` |
 | **`rangeInt(min: number, max: number): number`** | Generates a random number (not integer) between given `min` (inclusive) and `max` (exclusive). Throws if `min` > `max`. | `rangeInt(1, 10)` → `8` |
 | **`randInt(min: number, max: number): number`** | Alias for `rangeInt()`. | `randInt(1, 100)` → `35` |
-| **`safeInt(): number`** | Generates a random integer between `Number.MIN_SAFE_INTEGER` (inclusive) and `Number.MAX_SAFE_INTEGER` (inclusive). +0 and -0 both can be generated. 54 bits precision. Not recommended for genral usage. | `safeInt()` → `-5802548511349229` |
+| **`safeInt(): number`** | Generates a random integer between `Number.MIN_SAFE_INTEGER` (inclusive) and `Number.MAX_SAFE_INTEGER` (inclusive). +0 and -0 both can be generated. 54 bits precision. Not recommended for general usage. | `safeInt()` → `-5802548511349229` |
 | **`ifloat(): number`** | Generates a random number between `-1` (inclusive) and `1` (inclusive). Uses `safeInt()` and thus not recommended. | `ifloat()` → `-0.6076475248861822` |
 
 © 2025, Md. Touhidur Rahman.

package/dist/index.d.ts

@@ -6,6 +6,7 @@ import { hex } from "./lib/hex";
 import { ifloat } from "./lib/ifloat";
 import { percentage } from "./lib/percentage";
 import { pick } from "./lib/pick";
+import { probability } from "./lib/probability";
 import { randInt } from "./lib/randInt";
 import { random } from "./lib/random";
 import { range } from "./lib/range";
@@ -13,7 +14,7 @@ import { rangeInt } from "./lib/rangeInt";
 import { safeInt } from "./lib/safeInt";
 import { shuffle } from "./lib/shuffle";
 import { uSafeInt } from "./lib/uSafeInt";
-export { bool, boolean, choice, float, hex, ifloat, percentage, pick, randInt, random, range, rangeInt, safeInt, shuffle, uSafeInt, };
+export { bool, boolean, choice, float, hex, ifloat, percentage, pick, probability, randInt, random, range, rangeInt, safeInt, shuffle, uSafeInt, };
 declare const _default: {
     bool: () => boolean;
     boolean: () => boolean;
@@ -21,7 +22,8 @@ declare const _default: {
     float: () => number;
     hex: (length?: number, prefix?: boolean) => string;
     ifloat: () => number;
-    percentage: (input: number) => boolean;
+    percentage: (p: number) => boolean;
+    probability: (p: number) => boolean;
     pick: <E>(choices: ArrayLike<E>) => E | undefined;
     randInt: (min: number, max: number) => number;
     random: () => number;

package/dist/index.js

@@ -50,12 +50,20 @@ var safeInt = () => {
 var ifloat = () => safeInt() / Number.MAX_SAFE_INTEGER;
 
 // src/lib/percentage.ts
-var percentage = (input) => {
-  if (input < 0 || input > 100) {
-    throw new RangeError("input value should be between 0 and 100");
+var percentage = (p) => {
+  if (p < 0 || p > 100) {
+    throw new RangeError(`${p} is not in range [0, 100]`);
   }
-  return float() * 100 < input;
+  return float() * 100 < p;
 };
+// src/lib/probability.ts
+var probability = (p) => {
+  if (p < 0 || p > 1) {
+    throw new RangeError(`${p} is not in range [0, 1]`);
+  }
+  return float() < p;
+};
+
 // src/lib/rangeInt.ts
 var rangeInt = (min, max) => {
   if (min > max) {
@@ -92,6 +100,7 @@ var src_default = {
   hex,
   ifloat,
   percentage,
+  probability,
   pick: choice,
   randInt: rangeInt,
   random: float,
@@ -109,6 +118,7 @@ export {
   range,
   float as random,
   rangeInt as randInt,
+  probability,
   choice as pick,
   percentage,
   ifloat,

package/dist/lib/percentage.d.ts

@@ -1,5 +1,6 @@
 /**
- * Generates true with the probability of the percentage value given.
+ * Generates `true` with the probability of the percentage value given.
  * @example percentage(20) // should return true 20% of the time and false 80% of the time.
+ * @throws RangeError if `p` is not range `[0, 100]`.
  **/
-export declare const percentage: (input: number) => boolean;
+export declare const percentage: (p: number) => boolean;

package/dist/lib/probability.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Generates `true` with a given probability `p` and `false` with probability `1-p`.
+ * @throws {RangeError} If `p` is not in range `[0, 1]`.
+ * @example probability(0.8); // returns true 80% of the time and false 20% of the time.
+ */
+export declare const probability: (p: number) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "randomcryp",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "license": "BSD-3-Clause",
   "description": "A cryptographically secure, feature rich, zero dependency and browser friendly random number generator library.",
   "author": {
@@ -20,9 +20,9 @@
     "build": "bun build src/index.ts --outdir dist && tsc -p tsconfig.dts.json"
   },
   "devDependencies": {
-    "@types/bun": "^1.2.8",
+    "@types/bun": "^1.2.9",
     "prettier": "^3.5.3",
-    "typescript": "^5.8.2"
+    "typescript": "^5.8.3"
   },
   "keywords": [
     "cryptographically-secure",