randomcryp 1.0.4 → 1.0.6

package/README.md

@@ -1,6 +1,6 @@
 # randomcryp
 
-A cryptographically secure, feature rich, zero dependency, lightweight and browser friendly random number generator library. Only ~3KB in size.
+A cryptographically secure, feature rich, zero dependency, lightweight and browser friendly random number generator library. Only ~4KB in size.
 Uses [Crypto.getRandomValues()](https://developer.mozilla.org/en-US/docs/Web/API/Crypto/getRandomValues) to get its randomness.
 The spelling is random-creep in case you are wondering.
 
@@ -57,4 +57,5 @@ rangeInt(1, 10); // 7
 | **`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`                |
 | **`ifloat(): number`**                           | Generates a random number between `-1` (inclusive) and `1` (inclusive). Uses `safeInt()` and thus not recommended.                                                                                        | `ifloat()` → `-0.6076475248861822`               |
 
-License, BSD-3-Clause
+© 2025, Md. Touhidur Rahman
+License: BSD-3-Clause.

package/dist/index.d.ts

@@ -1,129 +1,32 @@
-declare module "lib/uSafeInt" {
-    /**
-     * Generates a random integer
-     * between 0 (inclusive) and {@link Number.MAX_SAFE_INTEGER} (inclusive)
-     * with 53 bits precission.
-     **/
-    export const uSafeInt: () => number;
-}
-declare module "lib/bool" {
-    /**
-     * Generates a boolean value randomly.
-     * true and false are equally likely.
-     **/
-    export const bool: () => boolean;
-}
-declare module "lib/boolean" {
-    export { bool as boolean } from "lib/bool";
-}
-declare module "lib/float" {
-    /**
-     * Generates a random number between 0 (inclusive) and 1 (exclusive).
-     * with 53 bits precission.
-     **/
-    export const float: () => number;
-}
-declare module "lib/choice" {
-    /**
-     * Randomly choose an element from an array-like object.
-     * @returns undefined if the array is empty.
-     * @returns a random element from the array if at least one element is present.
-     * @example choice([1, 2, 3]) // 2
-     */
-    export const choice: <E>(choices: ArrayLike<E>) => E | undefined;
-}
-declare module "lib/safeInt" {
-    /**
-     * Generates a random integer
-     * between {@link Number.MIN_SAFE_INTEGER} (inclusive) and {@link Number.MAX_SAFE_INTEGER} (inclusive).
-     * +0 and -0 can both appear, and technically 54 bit in precision but not recommended for general usage.
-     *
-     * Use {@link uSafeInt} for instead.
-     **/
-    export const safeInt: () => number;
-}
-declare module "lib/ifloat" {
-    /**
-     * Generates a random number between -1 (inclusive) and 1 (inclusive).
-     * Uses {@link safeInt} and thus not recommended for general usage also.
-     *
-     * Should be somewhat better for calculating PI.
-     **/
-    export const ifloat: () => number;
-}
-declare module "lib/percentage" {
-    /**
-     * 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.
-     **/
-    export const percentage: (input: number) => boolean;
-}
-declare module "lib/pick" {
-    export { choice as pick } from "lib/choice";
-}
-declare module "lib/rangeInt" {
-    /**
-     * Generates a random number integer
-     * between given `min` (inclusive) and `max` (inclusive).
-     * Throws if `min` > `max`.
-     *
-     * @example rangeInt(1, 100) // 35
-     */
-    export const rangeInt: (min: number, max: number) => number;
-}
-declare module "lib/randInt" {
-    export { rangeInt as randInt } from "lib/rangeInt";
-}
-declare module "lib/random" {
-    export { float as random } from "lib/float";
-}
-declare module "lib/range" {
-    /**
-     * Generates a random number (not integer)
-     * between given `min` (inclusive) and `max` (exclusive).
-     * Throws if `min` > `max`.
-     *
-     * @example range(1, 10) // 2.4802525465053487
-     */
-    export const range: (min: number, max: number) => number;
-}
-declare module "lib/shuffle" {
-    /**
-     * Randomly shuffles the elements of an array ***in place***. The original array is modified.
-     */
-    export const shuffle: <E>(array: Array<E>) => Array<E>;
-}
-declare module "index" {
-    import { bool } from "lib/bool";
-    import { boolean } from "lib/boolean";
-    import { choice } from "lib/choice";
-    import { float } from "lib/float";
-    import { ifloat } from "lib/ifloat";
-    import { percentage } from "lib/percentage";
-    import { pick } from "lib/pick";
-    import { randInt } from "lib/randInt";
-    import { random } from "lib/random";
-    import { range } from "lib/range";
-    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, ifloat, percentage, pick, randInt, random, range, rangeInt, safeInt, shuffle, uSafeInt, };
-    const _default: {
-        bool: () => boolean;
-        boolean: () => boolean;
-        choice: <E>(choices: ArrayLike<E>) => E | undefined;
-        float: () => number;
-        ifloat: () => number;
-        percentage: (input: number) => boolean;
-        pick: <E>(choices: ArrayLike<E>) => E | undefined;
-        randInt: (min: number, max: number) => number;
-        random: () => number;
-        range: (min: number, max: number) => number;
-        rangeInt: (min: number, max: number) => number;
-        safeInt: () => number;
-        shuffle: <E>(array: Array<E>) => Array<E>;
-        uSafeInt: () => number;
-    };
-    export default _default;
-}
+import { bool } from "./lib/bool";
+import { boolean } from "./lib/boolean";
+import { choice } from "./lib/choice";
+import { float } from "./lib/float";
+import { ifloat } from "./lib/ifloat";
+import { percentage } from "./lib/percentage";
+import { pick } from "./lib/pick";
+import { randInt } from "./lib/randInt";
+import { random } from "./lib/random";
+import { range } from "./lib/range";
+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, ifloat, percentage, pick, randInt, random, range, rangeInt, safeInt, shuffle, uSafeInt, };
+declare const _default: {
+    bool: () => boolean;
+    boolean: () => boolean;
+    choice: <E>(choices: ArrayLike<E>) => E | undefined;
+    float: () => number;
+    ifloat: () => number;
+    percentage: (input: number) => boolean;
+    pick: <E>(choices: ArrayLike<E>) => E | undefined;
+    randInt: (min: number, max: number) => number;
+    random: () => number;
+    range: (min: number, max: number) => number;
+    rangeInt: (min: number, max: number) => number;
+    safeInt: () => number;
+    shuffle: <E>(array: Array<E>) => Array<E>;
+    uSafeInt: () => number;
+};
+export default _default;

package/dist/lib/bool.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Generates a boolean value randomly.
+ * true and false are equally likely.
+ **/
+export declare const bool: () => boolean;

package/dist/lib/boolean.d.ts

@@ -0,0 +1 @@
+export { bool as boolean } from "./bool";

package/dist/lib/choice.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Randomly choose an element from an array-like object.
+ * @returns undefined if the array is empty.
+ * @returns a random element from the array if at least one element is present.
+ * @example choice([1, 2, 3]) // 2
+ */
+export declare const choice: <E>(choices: ArrayLike<E>) => E | undefined;

package/dist/lib/float.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Generates a random number between 0 (inclusive) and 1 (exclusive).
+ * with 53 bits precission.
+ **/
+export declare const float: () => number;

package/dist/lib/ifloat.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Generates a random number between -1 (inclusive) and 1 (inclusive).
+ * Uses {@link safeInt} and thus not recommended for general usage also.
+ *
+ * Should be somewhat better for calculating PI.
+ **/
+export declare const ifloat: () => number;

package/dist/lib/percentage.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 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.
+ **/
+export declare const percentage: (input: number) => boolean;

package/dist/lib/pick.d.ts

@@ -0,0 +1 @@
+export { choice as pick } from "./choice";

package/dist/lib/randInt.d.ts

@@ -0,0 +1 @@
+export { rangeInt as randInt } from "./rangeInt";

package/dist/lib/random.d.ts

@@ -0,0 +1 @@
+export { float as random } from "./float";

package/dist/lib/range.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Generates a random number (not integer)
+ * between given `min` (inclusive) and `max` (exclusive).
+ * Throws if `min` > `max`.
+ *
+ * @example range(1, 10) // 2.4802525465053487
+ */
+export declare const range: (min: number, max: number) => number;

package/dist/lib/rangeInt.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Generates a random number integer
+ * between given `min` (inclusive) and `max` (inclusive).
+ * Throws if `min` > `max`.
+ *
+ * @example rangeInt(1, 100) // 35
+ */
+export declare const rangeInt: (min: number, max: number) => number;

package/dist/lib/safeInt.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Generates a random integer
+ * between {@link Number.MIN_SAFE_INTEGER} (inclusive) and {@link Number.MAX_SAFE_INTEGER} (inclusive).
+ * +0 and -0 can both appear, and technically 54 bit in precision but not recommended for general usage.
+ *
+ * Use {@link uSafeInt} for instead.
+ **/
+export declare const safeInt: () => number;

package/dist/lib/shuffle.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Randomly shuffles the elements of an array ***in place***. The original array is modified.
+ */
+export declare const shuffle: <E>(array: Array<E>) => Array<E>;

package/dist/lib/uSafeInt.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Generates a random integer
+ * between 0 (inclusive) and {@link Number.MAX_SAFE_INTEGER} (inclusive)
+ * with 53 bits precission.
+ **/
+export declare const uSafeInt: () => number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "randomcryp",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "license": "BSD-3-Clause",
   "description": "A cryptographically secure, feature rich, zero dependency and browser friendly random number generator library.",
   "author": {
@@ -12,6 +12,7 @@
   "bugs": "https://github.com/touhidurrr/randomcryp/issues",
   "funding": "https://buymeacoffee.com/touhidurrr",
   "main": "dist/index.js",
+  "module": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "format": "prettier --write .",
@@ -21,5 +22,32 @@
     "@types/bun": "^1.2.5",
     "prettier": "^3.5.3",
     "typescript": "^5.8.2"
-  }
+  },
+  "keywords": [
+    "cryptographically-secure",
+    "random-number-generator",
+    "rng",
+    "zero-dependency",
+    "lightweight",
+    "browser-friendly",
+    "typescript",
+    "cross-platform",
+    "secure-random",
+    "web-crypto",
+    "crypto",
+    "javascript-library",
+    "random-utilities",
+    "array-shuffling",
+    "random-boolean",
+    "random-choice",
+    "percentage-generator",
+    "range-generator",
+    "safe-integer",
+    "open-source",
+    "deno",
+    "bun",
+    "nodejs",
+    "crypto-getrandomvalues",
+    "browser"
+  ]
 }