randex 0.21.0 → 0.23.0

package/README.md

@@ -17,18 +17,18 @@ npm i randex
 Strings:
 
 - [random](#random)
-- [randomFileName](#randomfilename)
-- [randomUsername](#randomusername)
-- [randomEmail](#randomemail)
-- [randomName](#randomname)
-- [randomFullName](#randomfullname)
+- [fileName](#filename)
+- [username](#username)
+- [email](#email)
+- [singleName](#singlename)
+- [fullName](#fullname)
 
 Numbers:
-- [randomNumber](#randomnumber)
-- [randomNumberArray](#randomnumberarray)
+- [number](#number)
+- [numberArray](#numberarray)
 
 Generic Type:
-- [randomArray](#randomarray)
+- [array](#array)
 
 Deeps:
 
@@ -40,62 +40,62 @@ Deeps:
 Basic function to construct random things.
 
 ```ts
-import { random } from "randex";
+import Randex from "randex";
 
 // 3 english chars
-random({
+Randex.random({
   set: "english",
   length: 3,
 });
 // or short:
-random(["english", 3]);
+Randex.random(["english", 3]);
 // EFd
 
 // 3 lower english chars
-random({
+Randex.random({
   set: ["english", "lower"],
   length: 3,
 });
 // or short:
-random([["english", "lower"], 3]);
+Randex.random([["english", "lower"], 3]);
 // yhl
 
 // min 1 and max 3 english chars
-random({
+Randex.random({
   set: "english",
   length: [1, 3],
 });
 // or short:
-random(["english", [1, 3]]);
+Randex.random(["english", [1, 3]]);
 // eR
 
 // 3 number chars
-random({
+Randex.random({
   set: "number",
   length: 3,
 });
 // or short:
-random(["number", 3]);
+Randex.random(["number", 3]);
 // 643
 
 // 3 chars from custom range
-random({
+Randex.random({
   range: "abc123",
   length: 3,
 });
 // a21
 
 // 3 english or number chars
-random({
+Randex.random({
   set: ["english", "number"],
   length: 3,
 });
 // or short:
-random([["english", "number"], 3]);
+Randex.random([["english", "number"], 3]);
 // x4d
 
 // 4 chars: 2 english and 2 english or number
-random(
+Randex.random(
   {
     set: "english",
     length: 2,
@@ -106,7 +106,7 @@ random(
   }
 );
 // or short:
-random(["english", 2], [["english", "number"], 2]);
+Randex.random(["english", 2], [["english", "number"], 2]);
 // Kb3b
 ```
 
@@ -117,43 +117,43 @@ Options:
 |range|`string`| Range or custom chars |
 |length|[RandexLength](#randexlength) | Length of chars |
 
-## randomFileName
+## fileName
 
 Randoms file name.
 
 ```ts
-import { randomFileName } from "randex";
+import Randex from "randex";
 
 // default
-randomFileName({
+Randex.fileName({
   extension: "txt",
 });
 // td1TX31eOB.txt
 
 // defined extension
-randomFileName({
+Randex.fileName({
   extension: "txt",
 });
 // or short:
-randomFileName("txt");
+Randex.fileName("txt");
 // HkmOjqHC6.txt
 
 // defined file name length and extension length
-randomFileName({
+Randex.fileName({
   fileNameLength: [7, 10],
   extensionLength: 5,
 });
 // or short:
-randomFileName([7, 10], 5);
+Randex.fileName([7, 10], 5);
 // 1SJVkHSBjq.tejuw
 
 // defined file name length and extension
-randomFileName({
+Randex.fileName({
   fileNameLength: 8,
   extension: "xml",
 });
 // or short:
-randomFileName(8, "xml");
+Randex.fileName(8, "xml");
 // JyCsuN5kD.xml
 ```
 
@@ -164,27 +164,27 @@ Options:
 |extensionLength|[RandexLength](#randexlength) | Length of extension (not including file name) chars. Default: [2,5] |
 |extension| `string`| File extension. |
 
-## randomUsername
+## username
 
 Randoms username.
 
 ```ts
-import { randomUsername } from "randex";
+import Randex from "randex";
 
 // default
-randomUsername();
+Randex.username();
 // icvv81d1j
 
 // with length 5 chars
-randomUsername({ length: 5 });
+Randex.username({ length: 5 });
 // or short:
-randomUsername(5);
+Randex.username(5);
 // okmle
 
 // with 2 min and 5 max chars
-randomName({ length: [2, 5] });
+Randex.singleName({ length: [2, 5] });
 // or short:
-randomUsername([2, 5]);
+Randex.username([2, 5]);
 // lkhs
 ```
 
@@ -239,39 +239,39 @@ Options:
 |lowDomainLength|[RandexLength](#randexlength) | Length of low domain part (example: <b>test</b>.com). Default: [4,2] |
 |domain| `string`| Defined domain. |
 
-## randomName
+## singleName
 
 Randoms a name of the person, city, place, restaurant, ect.
 
 ```ts
-import { randomName } from "randex";
+import Randex from "randex";
 
 // default
-randomName();
+Randex.singleName();
 // Ijb
 
 // with length 5 chars
-randomName({ length: 5 });
+Randex.singleName({ length: 5 });
 // or short:
-randomName(5);
+Randex.singleName(5);
 // Okmpj
 
 // with 2 min and 5 max chars
-randomName({ length: [2, 5] });
+Randex.singleName({ length: [2, 5] });
 // or short:
-randomName([2, 5]);
+Randex.singleName([2, 5]);
 // Wslg
 
 // name from french alphabet
-randomName({ alphabet: "french" });
+Randex.singleName({ alphabet: "french" });
 // or short:
-randomName("french");
+Randex.singleName("french");
 // Dbïœ
 
 // name from french alphabet with length
-randomName({ alphabet: "french", length: 10 });
+Randex.singleName({ alphabet: "french", length: 10 });
 // or short:
-randomName("french", 10);
+Randex.singleName("french", 10);
 // Rsîrjhjôôw
 ```
 
@@ -286,10 +286,10 @@ Options:
 Randoms a full name of the person.
 
 ```ts
-import { randomFullName } from "randex";
+import Randex from "randex";
 
 // default
-randomFullName();
+Randex.fullName();
 // Eqaa Bfmotnq
 ```
 
@@ -301,18 +301,18 @@ Options:
 |alphabet|[RandexAlphabet](#randexalphabet) | Defined alphabet. Default: `english` |
 
 
-## randomNumber
+## number
 
 Generates random number from a range of numbers.
 
 ```ts
-import { randomNumber } from "randex";
+import Randex from "randex";
 
 // Generates a number from a range: [0, 3] (includes 0 and 3).
-randomNumber(3);
+Randex.number(3);
 
 // Generates a number from a specified range: [3, 7].
-randomNumber([3, 7]);
+Randex.number([3, 7]);
 ```
 
 Options:
@@ -320,31 +320,31 @@ Options:
 | ------------------------ | ---- |------------ |
 |decimals| `number` | Number of decimal digits |
 
-## randomNumberArray
+## numberArray
 
 Generates random array with values from a range.
 
 ```ts
-import { randomNumberArray } from "randex";
+import Randex from "randex";
 
 // Generates an array (with length equals 2) with unique numbers from a range: [0, 3].
-randomNumberArray(3, 2);
+Randex.numberArray(3, 2);
 
 // Generates an array (with length equals 3) with unique numbers from a range: [3, 7].
-randomNumber([3, 7], 3);
+Randex.numberArray([3, 7], 3);
 ```
 
-## randomArray
+## array
 
 Generates random array with values from defined array.
 
 ```ts
-import { randomArray } from "randex";
+import Randex from "randex";
 
 // Generates an array (with length equals 2) with values picked from defined array as the first parameter.
-randomArray([1, 2, 3, 4], 2);
+Randex.array([1, 2, 3, 4], 2);
 // [2, 4]
-randomArray(["1", "2", "3", "4"], 2);
+Randex.array(["1", "2", "3", "4"], 2);
 // ["1", "3"]
 ```
 
@@ -355,24 +355,24 @@ randomArray(["1", "2", "3", "4"], 2);
 
 There are examples how to create custom function for most common cases:
 
-<b>randomFileName</b>
+<b>Randex.fileName</b>
 
 ```ts
-random([
+Randex.random([
   ["english", "number"],
   [3, 10],
 ]) +
   "." +
-  random([
+  Randex.random([
     ["english", "l"],
     [2, 5],
   ]);
 ```
 
-<b>randomUsername</b>
+<b>Randex.username</b>
 
 ```ts
-random(
+Randex.random(
   ["english", "l"],
   [
     [["english", "l"], "number"],
@@ -381,29 +381,29 @@ random(
 );
 ```
 
-<b>randomEmail</b>
+<b>Randex.email</b>
 
 ```ts
-random([
+Randex.random([
   [["english", "l"], "number"],
   [6, 10],
 ]) +
   "@" +
-  random([
+  Randex.random([
     ["english", "l"],
     [2, 4],
   ]) +
   "." +
-  random([
+  Randex.random([
     ["english", "l"],
     [1, 6],
   ]);
 ```
 
-<b>randomName</b>
+<b>Randex.singleName</b>
 
 ```ts
-random(
+Randex.random(
   ["english", "u"],
   [
     ["english", "l"],
@@ -412,10 +412,10 @@ random(
 );
 ```
 
-<b>randomFullName</b>
+<b>Randex.fullName</b>
 
 ```ts
-random(
+Randex.random(
   ["english", "u"],
   [
     ["english", "l"],
@@ -423,7 +423,7 @@ random(
   ]
 ) +
   " " +
-  random(
+  Randex.random(
     ["english", "u"],
     [
       ["english", "l"],
@@ -445,11 +445,11 @@ Possible types:
 Example:
 
 ```ts
-random({ set: "bit", length: 5 });
-random({ set: "bit", length: [5, 10] });
+Randex.random({ set: "bit", length: 5 });
+Randex.random({ set: "bit", length: [5, 10] });
 // or short:
-random(["bit", 5]);
-random(["bit", [5, 10]]);
+Randex.random(["bit", 5]);
+Randex.random(["bit", [5, 10]]);
 ```
 
 ## RandexSet
@@ -463,13 +463,13 @@ Possible types:
 Example:
 
 ```ts
-random({ set: "bit" });
-random({ set: "spanish" });
-random({ set: ["spanish", "lower"] });
+Randex.random({ set: "bit" });
+Randex.random({ set: "spanish" });
+Randex.random({ set: ["spanish", "lower"] });
 // or short:
-random("bit");
-random("spanish");
-random(["spanish", "l"]);
+Randex.random("bit");
+Randex.random("spanish");
+Randex.random(["spanish", "l"]);
 ```
 
 ## RandexAlphabet
@@ -481,9 +481,9 @@ An alphabet of chars
 Example:
 
 ```ts
-random({ set: "spanish" });
+Randex.random({ set: "spanish" });
 // or short:
-random("spanish");
+Randex.random("spanish");
 ```
 
 ## RandexKit
@@ -495,9 +495,9 @@ A kit of chars
 Example:
 
 ```ts
-random({ set: "hex" });
+Randex.random({ set: "hex" });
 // or short:
-random("hex");
+Randex.random("hex");
 ```
 
 ## RandexCase
@@ -509,7 +509,7 @@ A case of alphabet
 Example:
 
 ```ts
-random({ set: ["spanish", "lower"] });
+Randex.random({ set: ["spanish", "lower"] });
 // or short:
-random(["spanish", "l"]);
+Randex.random(["spanish", "l"]);
 ```

package/lib/custom/email.d.ts

@@ -10,7 +10,4 @@ interface DomainEmailOptions {
     domain?: string;
 }
 export type RandexEmailOptions = BasicEmailOptions & (DomainLengthEmailOptions | DomainEmailOptions);
-export declare function randomEmail(options?: RandexEmailOptions): any;
-export declare function randomEmail(prefixLength: RandexLength, lowDomainLength?: RandexLength, hightDomainLength?: RandexLength): any;
-export declare function randomEmail(domain: string): any;
 export {};

package/lib/custom/email.js

@@ -1,43 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.randomEmail = void 0;
-var basic_1 = require("../basic");
-var set_1 = require("../basic/set");
-var type_1 = require("../basic/type");
-function randomEmail(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, basic_1.random)([["english", "l"], lowDomainLength]) + "." + (0, basic_1.random)([["english", "l"], hightDomainLength]);
-    }
-    return (0, basic_1.random)([[["english", "l"], "number"], prefixLength]) + "@" + domain;
-}
-exports.randomEmail = randomEmail;

package/lib/custom/filename.d.ts

@@ -9,8 +9,4 @@ interface ExtensionFileNameOptions {
     extension?: string;
 }
 export type RandexFileNameOptions = BasicFileNameOptions & (ExtensionFileNameOptions | ExtensionLengthFileNameOptions);
-export declare function randomFileName(options?: RandexFileNameOptions): any;
-export declare function randomFileName(fileNameLength: RandexLength, extensionLength?: RandexLength): any;
-export declare function randomFileName(fileNameLength: RandexLength, extension: string): any;
-export declare function randomFileName(extension: string): any;
 export {};

package/lib/custom/filename.js

@@ -1,43 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.randomFileName = void 0;
-var basic_1 = require("../basic");
-var set_1 = require("../basic/set");
-var type_1 = require("../basic/type");
-function randomFileName(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, basic_1.random)([["english", "l"], extensionLength]);
-    }
-    return ((0, basic_1.random)([["english", "number"], set_1.RandexSetUtil.fileNameExtraChars, fileNameLength]) +
-        (0, basic_1.random)(["english", "number"]) +
-        "." +
-        (extension ? extension.replace(/^\./, "") : (0, basic_1.random)([["english", "l"], extensionLength])));
-}
-exports.randomFileName = randomFileName;

package/lib/custom/fullname.d.ts

@@ -4,8 +4,3 @@ export interface RandexFullNameOptions {
     firstLength?: RandexLength;
     secondLength?: RandexLength;
 }
-export declare function randomFullName(options?: RandexFullNameOptions): any;
-export declare function randomFullName(length: RandexLength): any;
-export declare function randomFullName(alphabet?: RandexAlphabet): any;
-export declare function randomFullName(alphabet: RandexAlphabet, length: RandexLength): any;
-export declare function randomFullName(alphabet: RandexAlphabet, firstLength: RandexLength, secondLength: RandexLength): any;

package/lib/custom/fullname.js

@@ -1,35 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.randomFullName = void 0;
-var type_1 = require("../basic/type");
-var name_1 = require("./name");
-function randomFullName(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, name_1.randomName)({ length: firstLength, alphabet: alphabet }) + " " + (0, name_1.randomName)({ length: secondLength, alphabet: alphabet });
-}
-exports.randomFullName = randomFullName;

package/lib/custom/index.d.ts

@@ -1,10 +1,46 @@
+import { RandexAlphabet, RandexContentOptions, RandexLength } from "../interfaces";
+import { RandexEmailOptions } from "./email";
+import { RandexFileNameOptions } from "./filename";
+import { RandexSingleNameOptions } from "./singleName";
+import { RandomNumberOptions } from "./number";
+import { RandexUsernameOptions } from "./username";
+import { RandexFullNameOptions } from "./fullname";
 export * from "./email";
 export * from "./filename";
-export * from "./name";
+export * from "./singleName";
 export * from "./username";
 export * from "./fullname";
 export * from "./number";
-export * from "./number-array";
-export * from "./array";
-export * from "./array-item";
-export * from "./bool";
+export declare class Randex {
+    private static randomString;
+    private static toContent;
+    private static toRangeOptions;
+    static random(...options: RandexContentOptions[]): string;
+    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): any;
+    static email(prefixLength: RandexLength, lowDomainLength?: RandexLength, hightDomainLength?: RandexLength): any;
+    static email(domain: string): any;
+    static fileName(options?: RandexFileNameOptions): any;
+    static fileName(fileNameLength: RandexLength, extensionLength?: RandexLength): any;
+    static fileName(fileNameLength: RandexLength, extension: string): any;
+    static fileName(extension: string): any;
+    static fullName(options?: RandexFullNameOptions): any;
+    static fullName(length: RandexLength): any;
+    static fullName(alphabet?: RandexAlphabet): any;
+    static fullName(alphabet: RandexAlphabet, length: RandexLength): any;
+    static fullName(alphabet: RandexAlphabet, firstLength: RandexLength, secondLength: RandexLength): any;
+    static singleName(options?: RandexSingleNameOptions): any;
+    static singleName(length: RandexLength): any;
+    static singleName(alphabet?: RandexAlphabet): any;
+    static singleName(alphabet: RandexAlphabet, length: RandexLength): any;
+    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;
+}