randex 0.22.0 → 0.24.0

package/README.md

@@ -17,18 +17,19 @@ 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)
+- [word](#word)
 
 Numbers:
-- [randomNumber](#randomnumber)
-- [randomNumberArray](#randomnumberarray)
+- [number](#number)
+- [numberArray](#numberarray)
 
 Generic Type:
-- [randomArray](#randomarray)
+- [array](#array)
 
 Deeps:
 
@@ -40,62 +41,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 +107,7 @@ random(
   }
 );
 // or short:
-random(["english", 2], [["english", "number"], 2]);
+Randex.random(["english", 2], [["english", "number"], 2]);
 // Kb3b
 ```
 
@@ -117,43 +118,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 +165,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 +240,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 +287,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 +302,62 @@ Options:
 |alphabet|[RandexAlphabet](#randexalphabet) | Defined alphabet. Default: `english` |
 
 
-## randomNumber
+
+## 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.
 
 ```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 +365,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 +400,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 +426,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 +457,10 @@ random(
 );
 ```
 
-<b>randomFullName</b>
+<b>Randex.fullName</b>
 
 ```ts
-random(
+Randex.random(
   ["english", "u"],
   [
     ["english", "l"],
@@ -423,7 +468,7 @@ random(
   ]
 ) +
   " " +
-  random(
+  Randex.random(
     ["english", "u"],
     [
       ["english", "l"],
@@ -445,11 +490,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 +508,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 +526,9 @@ An alphabet of chars
 Example:
 
 ```ts
-random({ set: "spanish" });
+Randex.random({ set: "spanish" });
 // or short:
-random("spanish");
+Randex.random("spanish");
 ```
 
 ## RandexKit
@@ -495,9 +540,9 @@ A kit of chars
 Example:
 
 ```ts
-random({ set: "hex" });
+Randex.random({ set: "hex" });
 // or short:
-random("hex");
+Randex.random("hex");
 ```
 
 ## RandexCase
@@ -509,7 +554,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/index.d.ts

@@ -1,13 +1,13 @@
 import { RandexAlphabet, RandexContentOptions, RandexLength } from "../interfaces";
 import { RandexEmailOptions } from "./email";
 import { RandexFileNameOptions } from "./filename";
-import { RandexSingleNameOptions } from "./singleName";
+import { RandexWordOptions } from "./word";
 import { RandomNumberOptions } from "./number";
 import { RandexUsernameOptions } from "./username";
 import { RandexFullNameOptions } from "./fullname";
 export * from "./email";
 export * from "./filename";
-export * from "./singleName";
+export * from "./word";
 export * from "./username";
 export * from "./fullname";
 export * from "./number";
@@ -32,10 +32,14 @@ export declare class Randex {
     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(options?: RandexWordOptions): any;
     static singleName(length: RandexLength): any;
     static singleName(alphabet?: RandexAlphabet): any;
     static singleName(alphabet: RandexAlphabet, length: RandexLength): any;
+    static word(options?: RandexWordOptions): any;
+    static word(length: RandexLength): any;
+    static word(alphabet?: RandexAlphabet): any;
+    static word(alphabet: RandexAlphabet, length: RandexLength): any;
     static numberArray(length: RandexLength, count: number): number[];
     private static getNumberBase;
     private static getNumberValue;

package/lib/custom/index.js

@@ -19,7 +19,7 @@ var set_1 = require("../basic/set");
 var type_1 = require("../basic/type");
 __exportStar(require("./email"), exports);
 __exportStar(require("./filename"), exports);
-__exportStar(require("./singleName"), exports);
+__exportStar(require("./word"), exports);
 __exportStar(require("./username"), exports);
 __exportStar(require("./fullname"), exports);
 __exportStar(require("./number"), exports);
@@ -260,6 +260,28 @@ var Randex = /** @class */ (function () {
         var currentLength = set_1.RandexSetUtil.getLength(1, length, [1, 9]);
         return Randex.random([alphabet, "u"], [[alphabet, "l"], currentLength]);
     };
+    Randex.word = function (p1, p2) {
+        var length = [2, 10];
+        var alphabet = "english";
+        if (type_1.RandexTypeParser.isLength(p1)) {
+            length = p1;
+        }
+        else if (type_1.RandexTypeParser.inAlphabet(p1)) {
+            alphabet = p1;
+            if (type_1.RandexTypeParser.isLength(p2)) {
+                length = p2;
+            }
+        }
+        else if (typeof p1 === "object") {
+            if (p1.alphabet) {
+                alphabet = p1.alphabet;
+            }
+            if (p1.length) {
+                length = p1.length;
+            }
+        }
+        return Randex.random([[alphabet, "l"], length]);
+    };
     Randex.numberArray = function (length, count) {
         var min = 0;
         var max = 0;

package/lib/custom/{singleName.d.ts → word.d.ts}

@@ -1,5 +1,5 @@
 import { RandexAlphabet, RandexLength } from "../interfaces";
-export interface RandexSingleNameOptions {
+export interface RandexWordOptions {
     alphabet?: RandexAlphabet;
     length?: RandexLength;
 }

package/lib/test/test-util.d.ts

@@ -12,9 +12,11 @@ export declare class TestUtil {
     static isEmailValid(email: string): RegExpMatchArray | null;
     static isUsernameValid(email: string): RegExpMatchArray | null;
     static isNameValid(email: string): RegExpMatchArray | null;
+    static isWordValid(word: string, length?: RandexLength): RegExpMatchArray | null;
     static isUpperCharValid(value: string, length?: RandexLength): RegExpMatchArray | null;
     static isLowerCharValid(value: string, length?: RandexLength): RegExpMatchArray | null;
     static isFullNameValid(email: string): RegExpMatchArray | null;
     static isFileNameValid(email: string): RegExpMatchArray | null;
     static inNumberRange(value: number, range: [number, number]): boolean;
+    private static getLength;
 }

package/lib/test/test-util.js

@@ -77,14 +77,19 @@ var TestUtil = /** @class */ (function () {
     TestUtil.isNameValid = function (email) {
         return String(email).match(/^[A-Z][a-z]{1,}$/);
     };
+    TestUtil.isWordValid = function (word, length) {
+        if (length === void 0) { length = 2; }
+        var l = TestUtil.getLength(length);
+        return String(word).match(new RegExp("^[a-z]{".concat(l, "}$")));
+    };
     TestUtil.isUpperCharValid = function (value, length) {
         if (length === void 0) { length = 1; }
-        var l = Array.isArray(length) ? "".concat(length[0], ",").concat(length[1]) : length;
+        var l = TestUtil.getLength(length);
         return String(value).match(new RegExp("^[A-Z]{".concat(l, "}$")));
     };
     TestUtil.isLowerCharValid = function (value, length) {
         if (length === void 0) { length = 1; }
-        var l = Array.isArray(length) ? "".concat(length[0], ",").concat(length[1]) : length;
+        var l = TestUtil.getLength(length);
         return String(value).match(new RegExp("^[a-z]{".concat(l, "}$")));
     };
     TestUtil.isFullNameValid = function (email) {
@@ -98,6 +103,9 @@ var TestUtil = /** @class */ (function () {
     TestUtil.inNumberRange = function (value, range) {
         return value >= range[0] && value <= range[1];
     };
+    TestUtil.getLength = function (length) {
+        return Array.isArray(length) ? "".concat(length[0], ",").concat(length[1]) : length;
+    };
     return TestUtil;
 }());
 exports.TestUtil = TestUtil;

package/lib/test/word.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/test/word.test.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var custom_1 = require("../custom");
+var test_util_1 = require("./test-util");
+describe("word", function () {
+    it("classic", function () {
+        test_util_1.TestUtil.loop(function () {
+            var w = custom_1.Randex.word();
+            expect(test_util_1.TestUtil.isWordValid(w, [2, 10])).toBeTruthy();
+        });
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "randex",
-  "version": "0.22.0",
+  "version": "0.24.0",
   "description": "",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",