@kottetall/random 0.0.3 → 0.0.5

package/lib/constants/name.constant.d.ts

@@ -0,0 +1,10 @@
+export declare const gender: {
+    readonly MALE: "male";
+    readonly FEMALE: "female";
+    readonly UNISEX: "unisex";
+};
+export declare const firstNameNeutral: readonly ["Alex", "Ari", "Ash", "Avery", "Bo", "Cai", "Kai", "Casey", "Chris", "Dani", "Eli", "Emi", "Jay", "Jesse", "Jordan", "Lee", "Lian", "Luca", "Luka", "Max", "Mika", "Mica", "Quinn", "Ren", "Rio", "Robin", "Sam", "Sky", "Sora", "Tao", "Taylor", "Toni", "Yuri", "Zion"];
+export declare const firstNameMale: readonly ["Adam", "Adrian", "Ahmed", "Ahmad", "Alan", "Alejandro", "André", "Antonio", "Arjun", "Ben", "Carlos", "Daniel", "David", "Diego", "Ethan", "Felix", "Gabriel", "Hassan", "Hugo", "Ibrahim", "Ivan", "Jack", "James", "Jason", "John", "Joseph", "Julian", "Kevin", "Leo", "Lucas", "Luis", "Marco", "Mark", "Martin", "Mateo", "Michael", "Mohammed", "Muhammad", "Nico", "Noah", "Oliver", "Omar", "Oscar", "Paul", "Rafael", "Samir", "Sebastian", "Simon", "Thomas", "Victor", "William", "Yusuf", "Youssef", "Zayn"];
+export declare const firstNameFemale: readonly ["Aisha", "Ayesha", "Alice", "Amelia", "Ana", "Anna", "Aya", "Bea", "Carla", "Clara", "Diana", "Elena", "Ella", "Emma", "Eva", "Fatima", "Hana", "Hanna", "Isabella", "Jade", "Julia", "Khadija", "Lara", "Leila", "Layla", "Lina", "Lucia", "Maria", "Maya", "Mina", "Nadia", "Naomi", "Nina", "Olivia", "Rania", "Rosa", "Sara", "Sarah", "Sofia", "Sophia", "Tara", "Yara", "Zara"];
+export declare const lastname: readonly ["Ali", "Ahmed", "Anderson", "Brown", "Chen", "Garcia", "Hassan", "Ivanov", "Khan", "Kim", "Lee", "Li", "Lopez", "Martin", "Mohamed", "Nguyen", "Patel", "Rodriguez", "Singh", "Smith", "Wang", "Zhang", "Andersson", "Anderson", "Baker", "Bianchi", "Black", "Blanco", "Clark", "Costa", "Dubois", "Evans", "Fischer", "Fisher", "Fontana", "Gonzalez", "Hansen", "Johansson", "Jones", "Kowalski", "Larsen", "Müller", "Muller", "Novak", "Petrov", "Rossi", "Schmidt", "Schmidt", "Silva", "Taylor", "Walker", "White"];
+//# sourceMappingURL=name.constant.d.ts.map

package/lib/constants/name.constant.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"name.constant.d.ts","sourceRoot":"","sources":["../../src/constants/name.constant.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,MAAM;;;;CAIT,CAAC;AAEX,eAAO,MAAM,gBAAgB,qRAmCnB,CAAC;AAEX,eAAO,MAAM,aAAa,qgBAuDhB,CAAC;AAEX,eAAO,MAAM,eAAe,iYA4ClB,CAAC;AAEX,eAAO,MAAM,QAAQ,sgBAqDX,CAAC"}

package/lib/constants/name.constant.js

@@ -0,0 +1,199 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.lastname = exports.firstNameFemale = exports.firstNameMale = exports.firstNameNeutral = exports.gender = void 0;
+exports.gender = {
+    MALE: "male",
+    FEMALE: "female",
+    UNISEX: "unisex",
+};
+exports.firstNameNeutral = [
+    "Alex",
+    "Ari",
+    "Ash",
+    "Avery",
+    "Bo",
+    "Cai",
+    "Kai",
+    "Casey",
+    "Chris",
+    "Dani",
+    "Eli",
+    "Emi",
+    "Jay",
+    "Jesse",
+    "Jordan",
+    "Lee",
+    "Lian",
+    "Luca",
+    "Luka",
+    "Max",
+    "Mika",
+    "Mica",
+    "Quinn",
+    "Ren",
+    "Rio",
+    "Robin",
+    "Sam",
+    "Sky",
+    "Sora",
+    "Tao",
+    "Taylor",
+    "Toni",
+    "Yuri",
+    "Zion",
+];
+exports.firstNameMale = [
+    "Adam",
+    "Adrian",
+    "Ahmed",
+    "Ahmad",
+    "Alan",
+    "Alejandro",
+    "André",
+    "Antonio",
+    "Arjun",
+    "Ben",
+    "Carlos",
+    "Daniel",
+    "David",
+    "Diego",
+    "Ethan",
+    "Felix",
+    "Gabriel",
+    "Hassan",
+    "Hugo",
+    "Ibrahim",
+    "Ivan",
+    "Jack",
+    "James",
+    "Jason",
+    "John",
+    "Joseph",
+    "Julian",
+    "Kevin",
+    "Leo",
+    "Lucas",
+    "Luis",
+    "Marco",
+    "Mark",
+    "Martin",
+    "Mateo",
+    "Michael",
+    "Mohammed",
+    "Muhammad",
+    "Nico",
+    "Noah",
+    "Oliver",
+    "Omar",
+    "Oscar",
+    "Paul",
+    "Rafael",
+    "Samir",
+    "Sebastian",
+    "Simon",
+    "Thomas",
+    "Victor",
+    "William",
+    "Yusuf",
+    "Youssef",
+    "Zayn",
+];
+exports.firstNameFemale = [
+    "Aisha",
+    "Ayesha",
+    "Alice",
+    "Amelia",
+    "Ana",
+    "Anna",
+    "Aya",
+    "Bea",
+    "Carla",
+    "Clara",
+    "Diana",
+    "Elena",
+    "Ella",
+    "Emma",
+    "Eva",
+    "Fatima",
+    "Hana",
+    "Hanna",
+    "Isabella",
+    "Jade",
+    "Julia",
+    "Khadija",
+    "Lara",
+    "Leila",
+    "Layla",
+    "Lina",
+    "Lucia",
+    "Maria",
+    "Maya",
+    "Mina",
+    "Nadia",
+    "Naomi",
+    "Nina",
+    "Olivia",
+    "Rania",
+    "Rosa",
+    "Sara",
+    "Sarah",
+    "Sofia",
+    "Sophia",
+    "Tara",
+    "Yara",
+    "Zara",
+];
+exports.lastname = [
+    "Ali",
+    "Ahmed",
+    "Anderson",
+    "Brown",
+    "Chen",
+    "Garcia",
+    "Hassan",
+    "Ivanov",
+    "Khan",
+    "Kim",
+    "Lee",
+    "Li",
+    "Lopez",
+    "Martin",
+    "Mohamed",
+    "Nguyen",
+    "Patel",
+    "Rodriguez",
+    "Singh",
+    "Smith",
+    "Wang",
+    "Zhang",
+    "Andersson",
+    "Anderson",
+    "Baker",
+    "Bianchi",
+    "Black",
+    "Blanco",
+    "Clark",
+    "Costa",
+    "Dubois",
+    "Evans",
+    "Fischer",
+    "Fisher",
+    "Fontana",
+    "Gonzalez",
+    "Hansen",
+    "Johansson",
+    "Jones",
+    "Kowalski",
+    "Larsen",
+    "Müller",
+    "Muller",
+    "Novak",
+    "Petrov",
+    "Rossi",
+    "Schmidt",
+    "Schmidt",
+    "Silva",
+    "Taylor",
+    "Walker",
+    "White",
+];

package/lib/index.d.ts

@@ -1,5 +1,6 @@
 import { Casing } from "./types/random.type";
 import { ObjectValues } from "./types/utils.type";
+import { Gender } from "./types/name.type";
 export declare class Random {
     static intBetween(min: number, max: number): number;
     static boolean(): boolean;
@@ -47,5 +48,38 @@ export declare class Random {
      * @returns
      */
     static uuid(): `${string}-${string}-${string}-${string}-${string}`;
+    /**
+     * Has a n% chance of throwing a error
+     * @param probabilityOfError - The probability of a error beeing thrown - i.e 0.2 = 20% chance
+     * @param errorMessage - The errormessage to be used instead of the default one
+     * @param callback - The callback that should be run if there's no error
+     * @returns
+     */
+    static throwError(probabilityOfError: number, errorMessage?: string, callback?: Function): void;
+    /**
+     *
+     * @param minMs - Minimum milliseconds to delay
+     * @param maxMs - Maximum milliseconds to delay
+     * @param value - Optional return value
+     * @returns
+     */
+    static delay<T>(minMs: number, maxMs: number, value?: T): Promise<T | undefined>;
+    /**
+     * Returns a name
+     * @param nameGender - Only male, female or unisex. If omitted, the name could be either one
+     * @returns
+     */
+    static firstName(nameGender?: Gender): string;
+    /**
+     * Gives a surname/last name
+     * @returns
+     */
+    static lastName(): "Lee" | "Taylor" | "Ahmed" | "Hassan" | "Martin" | "Ali" | "Anderson" | "Brown" | "Chen" | "Garcia" | "Ivanov" | "Khan" | "Kim" | "Li" | "Lopez" | "Mohamed" | "Nguyen" | "Patel" | "Rodriguez" | "Singh" | "Smith" | "Wang" | "Zhang" | "Andersson" | "Baker" | "Bianchi" | "Black" | "Blanco" | "Clark" | "Costa" | "Dubois" | "Evans" | "Fischer" | "Fisher" | "Fontana" | "Gonzalez" | "Hansen" | "Johansson" | "Jones" | "Kowalski" | "Larsen" | "Müller" | "Muller" | "Novak" | "Petrov" | "Rossi" | "Schmidt" | "Silva" | "Walker" | "White";
+    /**
+     * Gives a full name - first and last name
+     * @param nameGender
+     * @returns
+     */
+    static fullName(nameGender?: Gender): string;
 }
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAWA,OAAO,EAAiB,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAqB,MAAM,oBAAoB,CAAC;AAErE,qBAAa,MAAM;IACjB,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAY1C,MAAM,CAAC,OAAO;IAId;;;;OAIG;IACH,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,EAAE,MAAM;IAQ3C;;;OAGG;IACH,MAAM,CAAC,UAAU;IAIjB;;;OAGG;IACH,MAAM,CAAC,KAAK;IAIZ;;;OAGG;IACH,MAAM,CAAC,MAAM;IAIb;;;;OAIG;IACH,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,CAAC;IAMnC;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC;IAK/D;;;;OAIG;IACH,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,MAAM;IAYnC;;;OAGG;IACH,MAAM,CAAC,IAAI;CAGZ"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAiB,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAqB,MAAM,oBAAoB,CAAC;AACrE,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAE3C,qBAAa,MAAM;IACjB,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAY1C,MAAM,CAAC,OAAO;IAId;;;;OAIG;IACH,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,EAAE,MAAM;IAQ3C;;;OAGG;IACH,MAAM,CAAC,UAAU;IAIjB;;;OAGG;IACH,MAAM,CAAC,KAAK;IAIZ;;;OAGG;IACH,MAAM,CAAC,MAAM;IAIb;;;;OAIG;IACH,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,CAAC;IAMnC;;;;OAIG;IACH,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC;IAK/D;;;;OAIG;IACH,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,MAAM;IAYnC;;;OAGG;IACH,MAAM,CAAC,IAAI;IAIX;;;;;;OAMG;IACH,MAAM,CAAC,UAAU,CACf,kBAAkB,EAAE,MAAM,EAC1B,YAAY,CAAC,EAAE,MAAM,EACrB,QAAQ,CAAC,EAAE,QAAQ,GAClB,IAAI;IAkBP;;;;;;OAMG;WACU,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC;IAS7D;;;;OAIG;IACH,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,MAAM;IAepC;;;OAGG;IACH,MAAM,CAAC,QAAQ;IAIf;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM;CAGpC"}

package/lib/index.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Random = void 0;
 const chars_constant_1 = require("./constants/chars.constant");
 const random_constant_1 = require("./constants/random.constant");
+const name_constant_1 = require("./constants/name.constant");
 class Random {
     static intBetween(min, max) {
         // From https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/random
@@ -93,5 +94,75 @@ class Random {
     static uuid() {
         return crypto.randomUUID();
     }
+    /**
+     * Has a n% chance of throwing a error
+     * @param probabilityOfError - The probability of a error beeing thrown - i.e 0.2 = 20% chance
+     * @param errorMessage - The errormessage to be used instead of the default one
+     * @param callback - The callback that should be run if there's no error
+     * @returns
+     */
+    static throwError(probabilityOfError, errorMessage, callback) {
+        if (probabilityOfError < 0 || probabilityOfError > 1) {
+            // Trying a warning instead of throwing a error since it would probably
+            // be masked by the actual intent - throwing a error sometimes
+            console.warn("The probability needs to be between 0 and 1");
+            return;
+        }
+        if (Math.random() < probabilityOfError) {
+            errorMessage ??= "This is a randomly triggered error";
+            throw new Error(errorMessage);
+        }
+        if (callback) {
+            callback();
+        }
+    }
+    /**
+     *
+     * @param minMs - Minimum milliseconds to delay
+     * @param maxMs - Maximum milliseconds to delay
+     * @param value - Optional return value
+     * @returns
+     */
+    static async delay(minMs, maxMs, value) {
+        return new Promise((resolve, reject) => {
+            const delayInMs = Random.intBetween(minMs, maxMs);
+            setTimeout(() => {
+                resolve(value);
+            }, delayInMs);
+        });
+    }
+    /**
+     * Returns a name
+     * @param nameGender - Only male, female or unisex. If omitted, the name could be either one
+     * @returns
+     */
+    static firstName(nameGender) {
+        const namePool = [];
+        if (!nameGender || nameGender === name_constant_1.gender.UNISEX) {
+            namePool.push(...name_constant_1.firstNameNeutral);
+        }
+        if (!nameGender || nameGender === name_constant_1.gender.MALE) {
+            namePool.push(...name_constant_1.firstNameMale);
+        }
+        if (!nameGender || nameGender === name_constant_1.gender.FEMALE) {
+            namePool.push(...name_constant_1.firstNameFemale);
+        }
+        return Random.fromArray(namePool);
+    }
+    /**
+     * Gives a surname/last name
+     * @returns
+     */
+    static lastName() {
+        return Random.fromArray([...name_constant_1.lastname]);
+    }
+    /**
+     * Gives a full name - first and last name
+     * @param nameGender
+     * @returns
+     */
+    static fullName(nameGender) {
+        return `${Random.firstName(nameGender)} ${Random.lastName()}`;
+    }
 }
 exports.Random = Random;

package/lib/types/name.type.d.ts

@@ -0,0 +1,3 @@
+import { gender } from "../constants/name.constant";
+export type Gender = (typeof gender)[keyof typeof gender];
+//# sourceMappingURL=name.type.d.ts.map

package/lib/types/name.type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"name.type.d.ts","sourceRoot":"","sources":["../../src/types/name.type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAEpD,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,MAAM,CAAC,CAAC,MAAM,OAAO,MAAM,CAAC,CAAC"}

package/lib/types/name.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kottetall/random",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -14,7 +14,22 @@
     "type": "git",
     "url": "git+https://github.com/kottetall/random.git"
   },
-  "keywords": [],
+  "keywords": [
+    "random",
+    "random-utils",
+    "utility",
+    "utils",
+    "helpers",
+    "javascript",
+    "node",
+    "array",
+    "object",
+    "picker",
+    "random-picker",
+    "random-value",
+    "test data",
+    "mock data"
+  ],
   "author": "",
   "license": "ISC",
   "type": "commonjs",

package/readme.md

@@ -0,0 +1,67 @@
+# Random
+
+A lightweight utility library for generating pseudo-random values in JavaScript based of `Math.random()`.
+
+This package was originally created for personal use in my own projects, but it is published as an open tool that anyone can use. It focuses on simple, practical helpers for working with randomness, such as picking random values from arrays or objects.
+
+## Features
+
+- Get a random value from an array / object
+- Get a random name - first, last, full
+- Get a random letter
+- Get a random truthy/falsy value
+- And more...
+- Simple and minimal API
+- Zero dependencies
+- Designed for everyday use in JavaScript and Node.js projects
+
+## Installation
+
+```bash
+npm install @kottetall/random
+```
+
+## Usage
+
+### Random names
+
+```js
+import { Random } from "@kottetall/random";
+
+console.log(Random.firstName()); // Jack
+console.log(Random.firstName("female")); // Sofia
+console.log(Random.lastName()); // White
+console.log(Random.fullName()); // Jack Hassan
+```
+
+### Random value from an array
+
+```js
+import { Random } from "@kottetall/random";
+
+const items = ["apple", "banana", "orange"];
+const result = Random.fromArray(items);
+
+console.log(result);
+```
+
+### Random value from an object
+
+```js
+import { Random } from "@kottetall/random";
+
+const obj = {
+  a: 1,
+  b: 2,
+  c: 3,
+};
+
+const result = Random.fromObject(obj);
+
+console.log(result);
+```
+
+## Why this package?
+
+Sometimes you just need small, reusable helpers instead of rewriting the same logic in every project.
+This package aims to provide clean and simple functions for common random-related tasks.