randex 0.25.0 → 0.28.0

package/README.md

@@ -17,12 +17,13 @@ npm i randex
 Strings:
 
 - [random](#random)
+- [word](#word)
+- [sentence](#sentence)
 - [fileName](#filename)
 - [username](#username)
 - [email](#email)
 - [singleName](#singlename)
 - [fullName](#fullname)
-- [word](#word)
 
 Numbers:
 - [number](#number)
@@ -118,6 +119,84 @@ Options:
 |range|`string`| Range or custom chars |
 |length|[RandexLength](#randexlength) | Length of chars |
 
+## word
+
+Randoms a simple word.
+
+```ts
+import Randex from "randex";
+
+// default
+Randex.word();
+// kpmld
+
+// with length 5 chars
+Randex.word({ length: 5 });
+// or short:
+Randex.word(5);
+// imphs
+
+// with 2 min and 5 max chars
+Randex.word({ length: [2, 5] });
+// or short:
+Randex.word([2, 5]);
+// kslg
+
+// name from french alphabet
+Randex.word({ alphabet: "french" });
+// or short:
+Randex.word("french");
+// dbïœ
+
+// name from french alphabet with length
+Randex.word({ alphabet: "french", length: 10 });
+// or short:
+Randex.word("french", 10);
+// rsîrjhjôôw
+```
+
+Options:
+| Name | Type| Description|
+| ------------------------ | ---- |------------ |
+|length|[RandexLength](#randexlength) | Length of chars. Default: [2,10] |
+|alphabet|[RandexAlphabet](#randexalphabet) | Defined alphabet. Default: `english` |
+
+## sentence
+
+Randoms a sentence.
+
+```ts
+import Randex from "randex";
+
+// default word range is from 3 to 15
+Randex.sentence();
+// Gpgowb te vdancy poluwsd sswl aqxq.
+
+// with length 5 chars
+Randex.sentence({ wordRange: 5 });
+// or:
+Randex.sentence(5);
+// Xja wyfbhnhtl ptn shemiukme poyyjtr.
+
+// with word range
+Randex.sentence({ wordRange: [3, 6] });
+// or:
+Randex.sentence([3, 6]);
+// Vg nfobxcwg tmhfu hiqonw.
+
+// name from french alphabet
+Randex.sentence({ alphabet: "french" });
+// or:
+Randex.sentence("french");
+// Êid æeâoô déèbfûûæ aôç udôûsèqpa ygyïœùuè oê rmânacgwnc kuàq qêœççzœx iolîœsqàu aùàrpëhuâh rèèfhmæ klltu.
+```
+
+Options:
+| Name | Type| Description|
+| ------------------------ | ---- |------------ |
+|length|[RandexLength](#randexlength) | Length of chars. Default: [2,10] |
+|alphabet|[RandexAlphabet](#randexalphabet) | Defined alphabet. Default: `english` |
+
 ## fileName
 
 Randoms file name.
@@ -302,50 +381,6 @@ Options:
 |alphabet|[RandexAlphabet](#randexalphabet) | Defined alphabet. Default: `english` |
 
 
-
-## word
-
-Randoms a simple word.
-
-```ts
-import Randex from "randex";
-
-// default
-Randex.word();
-// kpmld
-
-// with length 5 chars
-Randex.word({ length: 5 });
-// or short:
-Randex.word(5);
-// imphs
-
-// with 2 min and 5 max chars
-Randex.word({ length: [2, 5] });
-// or short:
-Randex.word([2, 5]);
-// kslg
-
-// name from french alphabet
-Randex.word({ alphabet: "french" });
-// or short:
-Randex.word("french");
-// dbïœ
-
-// name from french alphabet with length
-Randex.word({ alphabet: "french", length: 10 });
-// or short:
-Randex.word("french", 10);
-// rsîrjhjôôw
-```
-
-Options:
-| Name | Type| Description|
-| ------------------------ | ---- |------------ |
-|length|[RandexLength](#randexlength) | Length of chars. Default: [2,10] |
-|alphabet|[RandexAlphabet](#randexalphabet) | Defined alphabet. Default: `english` |
-
-
 ## number
 
 Generates random number from a range of numbers.

package/lib/basic/const.d.ts

@@ -0,0 +1,3 @@
+import { RandexRange } from "../interfaces";
+export declare const DEFAULT_WORD_RANGE: RandexRange;
+export declare const DEFAULT_SENTENCE_RANGE: RandexRange;

package/lib/basic/const.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_SENTENCE_RANGE = exports.DEFAULT_WORD_RANGE = void 0;
+exports.DEFAULT_WORD_RANGE = [2, 10];
+exports.DEFAULT_SENTENCE_RANGE = [3, 15];

package/lib/basic/set.d.ts

@@ -1,15 +1,17 @@
-import { RandexSet, RandexLength } from "../interfaces";
+import { RandexSet, RandexRange } from "../interfaces";
 export declare class RandexSetUtil {
-    static readonly defaultFileNameLength: RandexLength;
-    static readonly defaultExtensionLength: RandexLength;
+    static readonly defaultFileNameLength: RandexRange;
+    static readonly defaultExtensionLength: RandexRange;
     static readonly fileNameExtraChars = "";
-    static readonly defaultEmailPrefixLength: RandexLength;
-    static readonly defaultHightDomainEmailLength: RandexLength;
-    static readonly defaultLowDomainEmailLength: RandexLength;
+    static readonly defaultEmailPrefixLength: RandexRange;
+    static readonly defaultHightDomainEmailLength: RandexRange;
+    static readonly defaultLowDomainEmailLength: RandexRange;
     private static toSingleRange;
     private static toAlphabetCase;
     private static toAlphabetRange;
     static toRange(set: RandexSet): string;
-    static getLength(reservedChars: number, length: RandexLength | undefined, defaultLength: RandexLength): RandexLength;
-    static randomNumber(length: number): number;
+    static getLength(reservedChars: number, length: RandexRange | undefined, defaultLength: RandexRange): RandexRange;
+    static randomSingleNumber(length: number): number;
+    static randomRangeNumber(min: number, max: number): number;
+    static many<TItem>(count: RandexRange, callback: () => TItem): TItem[];
 }

package/lib/basic/set.js

@@ -94,9 +94,22 @@ var RandexSetUtil = /** @class */ (function () {
         }
         return result;
     };
-    RandexSetUtil.randomNumber = function (length) {
+    RandexSetUtil.randomSingleNumber = function (length) {
         return Math.floor(Math.random() * length);
     };
+    RandexSetUtil.randomRangeNumber = function (min, max) {
+        var minN = Math.min(min, max);
+        var maxN = Math.max(min, max);
+        return RandexSetUtil.randomSingleNumber(maxN - minN + 1) + minN;
+    };
+    RandexSetUtil.many = function (count, callback) {
+        var result = [];
+        var length = Array.isArray(count) ? RandexSetUtil.randomRangeNumber(count[0], count[1]) : count;
+        for (var i = 0; i < length; i++) {
+            result.push(callback());
+        }
+        return result;
+    };
     RandexSetUtil.defaultFileNameLength = [3, 10];
     RandexSetUtil.defaultExtensionLength = [2, 5];
     RandexSetUtil.fileNameExtraChars = ""; //"-_.";

package/lib/basic/type.d.ts

@@ -1,11 +1,11 @@
-import { RandexCase, RandexAlphabet, RandexItemSet, RandexContentArrayOptions, RandexSet, RandexSingleSet, RandexLength } from "../interfaces";
+import { RandexCase, RandexAlphabet, RandexItemSet, RandexContentArrayOptions, RandexSet, RandexSingleSet, RandexRange } from "../interfaces";
 export declare class RandexTypeParser {
     private static inRange;
     private static inLiteral;
     static inCase(value: string): value is RandexCase;
     static inAlphabet(value: any): value is RandexAlphabet;
     static inSet(value: string): value is RandexSingleSet;
-    static isLength(value: any): value is RandexLength;
+    static isLength(value: any): value is RandexRange;
     static isSetSingle(value: any): value is RandexItemSet;
     static isSet(value: any): value is RandexSet;
     static isPartArray(value: any): value is RandexContentArrayOptions;

package/lib/custom/bool.d.ts

@@ -0,0 +1 @@
+export declare function randexBool(): boolean;

package/lib/custom/bool.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.randexBool = void 0;
+function randexBool() {
+    return Math.random() < 0.5;
+}
+exports.randexBool = randexBool;

package/lib/custom/email.d.ts

@@ -1,13 +1,4 @@
-import { RandexLength } from "../interfaces";
-interface BasicEmailOptions {
-    prefixLength?: RandexLength;
-}
-interface DomainLengthEmailOptions {
-    hightDomainLength?: RandexLength;
-    lowDomainLength?: RandexLength;
-}
-interface DomainEmailOptions {
-    domain?: string;
-}
-export type RandexEmailOptions = BasicEmailOptions & (DomainLengthEmailOptions | DomainEmailOptions);
-export {};
+import { RandexEmailOptions, RandexRange } from "../interfaces";
+export declare function randexEmail(options?: RandexEmailOptions): string;
+export declare function randexEmail(prefixLength: RandexRange, lowDomainLength?: RandexRange, hightDomainLength?: RandexRange): string;
+export declare function randexEmail(domain: string): string;

package/lib/custom/email.js

@@ -1,2 +1,43 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.randexEmail = void 0;
+var set_1 = require("../basic/set");
+var type_1 = require("../basic/type");
+var random_1 = require("./random");
+function randexEmail(p1, p2, p3) {
+    var prefixLength = set_1.RandexSetUtil.defaultEmailPrefixLength;
+    var hightDomainLength = set_1.RandexSetUtil.defaultHightDomainEmailLength;
+    var lowDomainLength = set_1.RandexSetUtil.defaultLowDomainEmailLength;
+    var domain = "";
+    if (type_1.RandexTypeParser.isLength(p1)) {
+        prefixLength = p1;
+        if (type_1.RandexTypeParser.isLength(p2)) {
+            lowDomainLength = p2;
+        }
+        if (type_1.RandexTypeParser.isLength(p3)) {
+            hightDomainLength = p3;
+        }
+    }
+    else if (typeof p1 === "string") {
+        domain = p1;
+    }
+    else if (typeof p1 === "object") {
+        if (p1.prefixLength) {
+            prefixLength = p1.prefixLength;
+        }
+        if (p1.hightDomainLength) {
+            hightDomainLength = p1.hightDomainLength;
+        }
+        if (p1.lowDomainLength) {
+            lowDomainLength = p1.lowDomainLength;
+        }
+        if (p1.domain) {
+            domain = p1.domain;
+        }
+    }
+    if (!domain) {
+        domain = (0, random_1.randexRandom)([["english", "l"], lowDomainLength]) + "." + (0, random_1.randexRandom)([["english", "l"], hightDomainLength]);
+    }
+    return (0, random_1.randexRandom)([[["english", "l"], "number"], prefixLength]) + "@" + domain;
+}
+exports.randexEmail = randexEmail;

package/lib/custom/filenameX.d.ts

@@ -0,0 +1,5 @@
+import { RandexFileNameOptions, RandexRange } from "../interfaces";
+export declare function randexFileName(options?: RandexFileNameOptions): string;
+export declare function randexFileName(fileNameLength: RandexRange, extensionLength?: RandexRange): string;
+export declare function randexFileName(fileNameLength: RandexRange, extension: string): string;
+export declare function randexFileName(extension: string): string;

package/lib/custom/filenameX.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.randexFileName = void 0;
+var set_1 = require("../basic/set");
+var type_1 = require("../basic/type");
+var random_1 = require("./random");
+function randexFileName(p1, p2) {
+    var fileNameLength = set_1.RandexSetUtil.defaultFileNameLength;
+    var extensionLength = set_1.RandexSetUtil.defaultExtensionLength;
+    var extension = "";
+    if (type_1.RandexTypeParser.isLength(p1)) {
+        fileNameLength = p1;
+        if (type_1.RandexTypeParser.isLength(p2)) {
+            extensionLength = p2;
+        }
+        else if (typeof p2 === "string") {
+            extension = p2;
+        }
+    }
+    else if (typeof p1 === "string") {
+        extension = p1;
+    }
+    else if (typeof p1 === "object") {
+        if (p1.fileNameLength) {
+            fileNameLength = p1.fileNameLength;
+        }
+        if (p1.extensionLength) {
+            extensionLength = p1.extensionLength;
+        }
+        if (p1.extension) {
+            extension = p1.extension;
+        }
+    }
+    fileNameLength = set_1.RandexSetUtil.getLength(1, fileNameLength, fileNameLength);
+    if (!extension) {
+        extension = (0, random_1.randexRandom)([["english", "l"], extensionLength]);
+    }
+    return ((0, random_1.randexRandom)([["english", "number"], set_1.RandexSetUtil.fileNameExtraChars, fileNameLength]) +
+        (0, random_1.randexRandom)(["english", "number"]) +
+        "." +
+        (extension ? extension.replace(/^\./, "") : (0, random_1.randexRandom)([["english", "l"], extensionLength])));
+}
+exports.randexFileName = randexFileName;

package/lib/custom/fullnameX.d.ts

@@ -0,0 +1,6 @@
+import { RandexAlphabet, RandexFullNameOptions, RandexRange } from "../interfaces";
+export declare function randexFullName(options?: RandexFullNameOptions): string;
+export declare function randexFullName(length: RandexRange): string;
+export declare function randexFullName(alphabet?: RandexAlphabet): string;
+export declare function randexFullName(alphabet: RandexAlphabet, length: RandexRange): string;
+export declare function randexFullName(alphabet: RandexAlphabet, firstLength: RandexRange, secondLength: RandexRange): string;

package/lib/custom/fullnameX.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.randexFullName = void 0;
+var type_1 = require("../basic/type");
+var singleName_1 = require("./singleName");
+function randexFullName(p1, p2, p3) {
+    var firstLength = 0;
+    var secondLength = 0;
+    var alphabet = "english";
+    if (type_1.RandexTypeParser.isLength(p1)) {
+        firstLength = secondLength = p1;
+    }
+    else if (type_1.RandexTypeParser.inAlphabet(p1)) {
+        alphabet = p1;
+        if (type_1.RandexTypeParser.isLength(p2)) {
+            firstLength = secondLength = p2;
+        }
+        if (type_1.RandexTypeParser.isLength(p3)) {
+            secondLength = p3;
+        }
+    }
+    else if (typeof p1 === "object") {
+        if (p1.alphabet) {
+            alphabet = p1.alphabet;
+        }
+        if (p1.firstLength) {
+            firstLength = p1.firstLength;
+        }
+        if (p1.secondLength) {
+            secondLength = p1.secondLength;
+        }
+    }
+    return (0, singleName_1.randexSingleName)({ length: firstLength, alphabet: alphabet }) + " " + (0, singleName_1.randexSingleName)({ length: secondLength, alphabet: alphabet });
+}
+exports.randexFullName = randexFullName;

package/lib/custom/index.d.ts

@@ -1,50 +1,41 @@
-import { RandexAlphabet, RandexContentOptions, RandexLength } from "../interfaces";
-import { RandexEmailOptions } from "./email";
-import { RandexFileNameOptions } from "./filename";
-import { RandexWordOptions } from "./word";
-import { RandomNumberOptions } from "./number";
-import { RandexUsernameOptions } from "./username";
-import { RandexFullNameOptions } from "./fullname";
-export * from "./email";
-export * from "./filename";
-export * from "./word";
-export * from "./username";
-export * from "./fullname";
-export * from "./number";
+import { RandexRange } from "../interfaces";
+import { randexBool } from "./bool";
+import { randexEmail } from "./email";
+import { randexFileName } from "./filenameX";
+import { randexFullName } from "./fullnameX";
+import { randexNumber } from "./number";
+import { randexRandom } from "./random";
+import { randexSentence } from "./sentence";
+import { randexSingleName } from "./singleName";
+import { randexUsername } from "./username";
+import { randexWord } from "./word";
 export declare class Randex {
-    private static randomString;
-    private static toContent;
-    private static toRangeOptions;
-    static random(...options: RandexContentOptions[]): string;
+    static random: typeof randexRandom;
     static arrayItem<T>(array: T[]): T;
     static arrayItem<T>(array: T[], defaultValue: T): T;
     static array<T>(array: T[], count: number): T[];
-    static bool(): boolean;
-    static email(options?: RandexEmailOptions): string;
-    static email(prefixLength: RandexLength, lowDomainLength?: RandexLength, hightDomainLength?: RandexLength): string;
-    static email(domain: string): string;
-    static fileName(options?: RandexFileNameOptions): string;
-    static fileName(fileNameLength: RandexLength, extensionLength?: RandexLength): string;
-    static fileName(fileNameLength: RandexLength, extension: string): string;
-    static fileName(extension: string): string;
-    static fullName(options?: RandexFullNameOptions): string;
-    static fullName(length: RandexLength): string;
-    static fullName(alphabet?: RandexAlphabet): string;
-    static fullName(alphabet: RandexAlphabet, length: RandexLength): string;
-    static fullName(alphabet: RandexAlphabet, firstLength: RandexLength, secondLength: RandexLength): string;
-    static singleName(options?: RandexWordOptions): string;
-    static singleName(length: RandexLength): string;
-    static singleName(alphabet?: RandexAlphabet): string;
-    static singleName(alphabet: RandexAlphabet, length: RandexLength): string;
-    static word(options?: RandexWordOptions): string;
-    static word(length: RandexLength): string;
-    static word(alphabet?: RandexAlphabet): string;
-    static word(alphabet: RandexAlphabet, length: RandexLength): string;
-    static numberArray(length: RandexLength, count: number): number[];
-    private static getNumberBase;
-    private static getNumberValue;
-    private static innerRandomNumber;
-    static number(length: RandexLength, options?: RandomNumberOptions): number;
-    static number(from: number, to: number, options?: RandomNumberOptions): number;
-    static username(options?: RandexUsernameOptions | RandexLength): string;
+    static bool: typeof randexBool;
+    static email: typeof randexEmail;
+    static fileName: typeof randexFileName;
+    static fullName: typeof randexFullName;
+    static singleName: typeof randexSingleName;
+    static numberArray(length: RandexRange, count: number): number[];
+    static number: typeof randexNumber;
+    static username: typeof randexUsername;
+    static word: typeof randexWord;
+    static sentence: typeof randexSentence;
+    static many(count: RandexRange): {
+        word: {
+            (options?: import("../interfaces").RandexWordOptions | undefined): string[];
+            (length: RandexRange): string[];
+            (alphabet?: import("../interfaces").RandexAlphabet | undefined): string[];
+            (alphabet: import("../interfaces").RandexAlphabet, length: RandexRange): string[];
+        };
+        sentence: {
+            (options?: import("../interfaces").RandexSentenceOptions | undefined): string[];
+            (length: RandexRange): string[];
+            (alphabet?: import("../interfaces").RandexAlphabet | undefined): string[];
+            (alphabet: import("../interfaces").RandexAlphabet, length: RandexRange): string[];
+        };
+    };
 }