randex 0.6.0 → 0.7.0

package/README.md

@@ -23,6 +23,11 @@ Functions:
 - [randomName](#randomname)
 - [randomFullName](#randomfullname)
 
+Deeps:
+
+- [Customization](#customization)
+- [Types](#types)
+
 ## random
 
 Basic function for construct random thing.
@@ -35,6 +40,8 @@ random({
   set: "english",
   length: 3,
 });
+// or short:
+random(["english", 3]);
 // EFd
 
 // 3 lower english chars
@@ -42,6 +49,8 @@ random({
   set: ["english", "lower"],
   length: 3,
 });
+// or short:
+random([["english", "lower"], 3]);
 // yhl
 
 // min 1 and max 3 english chars
@@ -49,6 +58,8 @@ random({
   set: "english",
   length: [1, 3],
 });
+// or short:
+random(["english", [1, 3]]);
 // eR
 
 // 3 number chars
@@ -56,6 +67,8 @@ random({
   set: "number",
   length: 3,
 });
+// or short:
+random(["number", 3]);
 // 643
 
 // 3 chars from custom range
@@ -70,6 +83,9 @@ random({
   set: ["english", "number"],
   length: 3,
 });
+// or short:
+random([["english", "number"], 3]);
+// x4d
 
 // 4 chars: 2 english and 2 english or number
 random(
@@ -82,6 +98,8 @@ random(
     length: 2,
   }
 );
+// or short:
+random(["english", 2], [["english", "number"], 2]);
 // Kb3b
 ```
 
@@ -106,20 +124,6 @@ randomFileName({
 // td1TX31eOB.txt
 ```
 
-Equals to:
-
-```ts
-random([["english", "number"], "_.", [5, 10]]) +
-  random(["english", "number"]) +
-  "." +
-  (extension
-    ? extension
-    : random([
-        ["english", "l"],
-        [2, 5],
-      ]));
-```
-
 ## randomUsername
 
 Randoms username.
@@ -127,65 +131,39 @@ Randoms username.
 ```ts
 import { randomUsername } from "randex";
 
-// default (min - 6, max - 10 chars)
+// default
 randomUsername();
 // icvv81d1j
 
 // with length 5 chars
 randomUsername({ length: 5 });
+// or short:
+randomUsername(5);
 // okmle
 
 // with 2 min and 5 max chars
 randomName({ length: [2, 5] });
+// or short:
+randomUsername([2, 5]);
 // lkhs
-
-```
-
-Equals to:
-
-```ts
-random(
-  ["english", "l"],
-  [
-    [["english", "l"], "number"],
-    [5, 10],
-  ]
-);
 ```
 
 Options:
 | Name | Type| Description|
 | ------------------------ | ---- |------------ |
-|length|[RandexLength](#randexlength) | Length of chars |
-
+|length|[RandexLength](#randexlength) | Length of chars. Default: min - 6, max - 10 chars. |
 
 ## randomEmail
 
-Randoms username.
+Randoms an email.
 
 ```ts
 import { randomEmail } from "randex";
 
-
 randomEmail();
 // stv4ox27sevt@mqsyin.fil
-
 ```
 
-Equals to:
-
-```ts
-random(["english", "l"], [[["english", "l"], "number"], 10], ["english", "l"]) +
-  "@" +
-  random(["english", "l"], [["english", "l"], "-", [0, 5]], ["english", "l"]) +
-  "." +
-  random([
-    ["english", "l"],
-    [2, 4],
-  ]);
-```
-
-
 ## randomName
 
 Randoms a name of the person, city, place, restaurant, ect.
@@ -193,40 +171,40 @@ Randoms a name of the person, city, place, restaurant, ect.
 ```ts
 import { randomName } from "randex";
 
-// default (min - 2, max - 10 chars)
+// default
 randomName();
 // Ijb
 
-// name from french alphabet
-randomName({ alphabet: "french" });
-// Dbïœ
-
 // with length 5 chars
 randomName({ length: 5 });
+// or short:
+randomName(5);
 // Okmpj
 
 // with 2 min and 5 max chars
 randomName({ length: [2, 5] });
+// or short:
+randomName([2, 5]);
 // Wslg
-```
 
-Equals to:
+// name from french alphabet
+randomName({ alphabet: "french" });
+// or short:
+randomName("french");
+// Dbïœ
 
-```ts
-random(
-  ["english", "u"],
-  [
-    ["english", "l"],
-    [1, 10],
-  ]
-);
+// name from french alphabet with length
+randomName({ alphabet: "french", length: 10 });
+// or short:
+randomName("french", 10);
+// Rsîrjhjôôw
 ```
 
 Options:
 | Name | Type| Description|
 | ------------------------ | ---- |------------ |
-|length|[RandexLength](#randexlength) | Length of chars |
-|alphabet|[RandexAlphabet](#randexalphabet) | Defined alphabet |
+|length|[RandexLength](#randexlength) | Length of chars. Default: min - 2, max - 10 chars|
+|alphabet|[RandexAlphabet](#randexalphabet) | Defined alphabet. Default: `english` |
 
 ## randomFullName
 
@@ -235,6 +213,7 @@ Randoms a full name of the person.
 ```ts
 import { randomFullName } from "randex";
 
+// default
 randomFullName();
 // Eqaa Bfmotnq
 ```
@@ -242,9 +221,84 @@ randomFullName();
 Options:
 | Name | Type| Description|
 | ------------------------ | ---- |------------ |
-|firstLength|[RandexLength](#randexlength) | First name length of chars |
-|secondLength|[RandexLength](#randexlength) | Second name length of chars |
-|alphabet|[RandexAlphabet](#randexalphabet) | Defined alphabet |
+|firstLength|[RandexLength](#randexlength) | First name length of chars. Default: min - 2, max - 10 chars |
+|secondLength|[RandexLength](#randexlength) | Second name length of chars. Default: min - 2, max - 10 chars |
+|alphabet|[RandexAlphabet](#randexalphabet) | Defined alphabet. Default: `english` |
+
+## Customization
+
+[random](#random) function is very flexible, there are many custom functions can be created.
+
+There are examples how to create custom function for most common cases:
+
+<b>randomFileName</b>
+
+```ts
+random([["english", "number"], "_.", [5, 10]]) +
+  random(["english", "number"]) +
+  "." +
+  random([
+    ["english", "l"],
+    [2, 5],
+  ]);
+```
+
+<b>randomUsername</b>
+
+```ts
+random(
+  ["english", "l"],
+  [
+    [["english", "l"], "number"],
+    [5, 10],
+  ]
+);
+```
+
+<b>randomEmail</b>
+
+```ts
+random(["english", "l"], [[["english", "l"], "number"], 10], ["english", "l"]) +
+  "@" +
+  random(["english", "l"], [["english", "l"], "-", [0, 5]], ["english", "l"]) +
+  "." +
+  random([
+    ["english", "l"],
+    [2, 4],
+  ]);
+```
+
+<b>randomName</b>
+
+```ts
+random(
+  ["english", "u"],
+  [
+    ["english", "l"],
+    [1, 10],
+  ]
+);
+```
+
+<b>randomFullName</b>
+
+```ts
+random(
+  ["english", "u"],
+  [
+    ["english", "l"],
+    [1, 10],
+  ]
+) +
+  " " +
+  random(
+    ["english", "u"],
+    [
+      ["english", "l"],
+      [1, 10],
+    ]
+  );
+```
 
 ## Types
 
@@ -256,6 +310,16 @@ Possible types:
 
 `[number, number]`: an array of min and max length.
 
+Example:
+
+```ts
+random({ set: "bit", length: 5 });
+random({ set: "bit", length: [5, 10] });
+// or short:
+random(["bit", 5]);
+random(["bit", [5, 10]]);
+```
+
 ## RandexSet
 
 Possible types:
@@ -264,20 +328,56 @@ Possible types:
 
 `[string, string]`: the first item is - [RandexAlphabet](#randexalphabet), the second item is - [RandexCase](#randexcase)
 
+Example:
+
+```ts
+random({ set: "bit" });
+random({ set: "spanish" });
+random({ set: ["spanish", "lower"] });
+// or short:
+random("bit");
+random("spanish");
+random(["spanish", "l"]);
+```
+
 ## RandexAlphabet
 
 An alphabet of chars
 
 `string` values: `english`, `french`, `spanish`, `russian`.
 
+Example:
+
+```ts
+random({ set: "spanish" });
+// or short:
+random("spanish");
+```
+
 ## RandexKit
 
 A kit of chars
 
 `string` values: `hex`, `symbol`, `number`, `binary`.
 
+Example:
+
+```ts
+random({ set: "hex" });
+// or short:
+random("hex");
+```
+
 ## RandexCase
 
 A case of alphabet
 
 `string` values: `upper`, `u`,`lower`, `l`.
+
+Example:
+
+```ts
+random({ set: ["spanish", "lower"] });
+// or short:
+random(["spanish", "l"]);
+```

package/lib/basic/type.d.ts

@@ -3,7 +3,7 @@ export declare class RandexTypeParser {
     private static inRange;
     private static inLiteral;
     static inCase(value: string): value is RandexCase;
-    static inAlphabet(value: string): value is RandexAlphabet;
+    static inAlphabet(value: any): value is RandexAlphabet;
     static inSet(value: string): value is RandexSingleSet;
     static isLength(value: any): value is RandexLength;
     static isSetSingle(value: any): value is RandexItemSet;

package/lib/basic/type.js

@@ -13,14 +13,15 @@ var RandexTypeParser = /** @class */ (function () {
         for (var _i = 1; _i < arguments.length; _i++) {
             expects[_i - 1] = arguments[_i];
         }
-        return !!expects.find(function (x) { return x === value; });
+        return typeof value === "string" && !!expects.find(function (x) { return x === value; });
     };
     RandexTypeParser.inCase = function (value) {
         return RandexTypeParser.inLiteral(value, "default", "lower", "upper", "l", "u");
     };
     RandexTypeParser.inAlphabet = function (value) {
-        return RandexTypeParser.inLiteral(value, "english", "french", "spanish", // "german",
-        "russian");
+        return (typeof value === "string" &&
+            RandexTypeParser.inLiteral(value, "english", "french", "spanish", // "german",
+            "russian"));
     };
     RandexTypeParser.inSet = function (value) {
         return RandexTypeParser.inAlphabet(value) || RandexTypeParser.inLiteral(value, "hex", "symbol", "number", "binary");

package/lib/custom/fullname.d.ts

@@ -0,0 +1,11 @@
+import { RandexAlphabet, RandexLength } from "../interfaces";
+export interface RandexFullNameOptions {
+    alphabet?: RandexAlphabet;
+    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

@@ -0,0 +1,35 @@
+"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

@@ -2,3 +2,4 @@ export * from "./email";
 export * from "./filename";
 export * from "./name";
 export * from "./username";
+export * from "./fullname";

package/lib/custom/index.js

@@ -18,3 +18,4 @@ __exportStar(require("./email"), exports);
 __exportStar(require("./filename"), exports);
 __exportStar(require("./name"), exports);
 __exportStar(require("./username"), exports);
+__exportStar(require("./fullname"), exports);

package/lib/custom/name.d.ts

@@ -1,12 +1,9 @@
 import { RandexAlphabet, RandexLength } from "../interfaces";
 export interface RandexNameOptions {
-    length?: RandexLength;
-    alphabet?: RandexAlphabet;
-}
-export interface RandexFullNameOptions {
-    firstLength?: RandexLength;
-    secondLength?: RandexLength;
     alphabet?: RandexAlphabet;
+    length?: RandexLength;
 }
-export declare function randomName(options?: RandexNameOptions): string;
-export declare function randomFullName(options?: RandexFullNameOptions): string;
+export declare function randomName(options?: RandexNameOptions): any;
+export declare function randomName(length: RandexLength): any;
+export declare function randomName(alphabet?: RandexAlphabet): any;
+export declare function randomName(alphabet: RandexAlphabet, length: RandexLength): any;

package/lib/custom/name.js

@@ -1,16 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.randomFullName = exports.randomName = void 0;
+exports.randomName = void 0;
 var basic_1 = require("../basic");
 var set_1 = require("../basic/set");
-function randomName(options) {
-    var _a = options || {}, length = _a.length, _b = _a.alphabet, alphabet = _b === void 0 ? "english" : _b;
+var type_1 = require("../basic/type");
+function randomName(p1, p2) {
+    var length = 0;
+    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;
+        }
+    }
     var currentLength = set_1.RandexSetUtil.getLength(1, length, [1, 9]);
     return (0, basic_1.random)([alphabet, "u"], [[alphabet, "l"], currentLength]);
 }
 exports.randomName = randomName;
-function randomFullName(options) {
-    var _a = options || {}, firstLength = _a.firstLength, secondLength = _a.secondLength, alphabet = _a.alphabet;
-    return randomName({ length: firstLength, alphabet: alphabet }) + " " + randomName({ length: secondLength, alphabet: alphabet });
-}
-exports.randomFullName = randomFullName;

package/lib/custom/username.d.ts

@@ -2,4 +2,4 @@ import { RandexLength } from "../interfaces";
 export interface RandexUsernameOptions {
     length?: RandexLength;
 }
-export declare function randomUsername(options?: RandexUsernameOptions): string;
+export declare function randomUsername(options?: RandexUsernameOptions | RandexLength): string;

package/lib/custom/username.js

@@ -3,8 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.randomUsername = void 0;
 var basic_1 = require("../basic");
 var set_1 = require("../basic/set");
+var type_1 = require("../basic/type");
 function randomUsername(options) {
-    var length = (options || {}).length;
+    var length = type_1.RandexTypeParser.isLength(options) ? options : options === null || options === void 0 ? void 0 : options.length;
     var currentLength = set_1.RandexSetUtil.getLength(1, length, [6, 10]);
     return (0, basic_1.random)(["english", "l"], [[["english", "l"], "number"], currentLength]);
 }

package/lib/test/fullname.test.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var name_1 = require("../custom/name");
+var custom_1 = require("../custom");
 var test_util_1 = require("./test-util");
 describe("randomFullName", function () {
     it("simple", function () {
         for (var i = 0; i < 100; i++) {
-            var value = (0, name_1.randomFullName)();
+            var value = (0, custom_1.randomFullName)();
             expect(test_util_1.TestUtil.isFullNameValid(value)).toBeTruthy();
         }
     });

package/lib/test/markdown.test.js

@@ -9,31 +9,47 @@ describe("markdown", function () {
             length: 3,
         });
         expect(value.length).toBe(3);
+        value = (0, basic_1.random)(["english", 3]);
+        expect(value.length).toBe(3);
+        //
         value = (0, basic_1.random)({
             set: ["english", "lower"],
             length: 3,
         });
         expect(value.length).toBe(3);
+        value = (0, basic_1.random)([["english", "lower"], 3]);
+        expect(value.length).toBe(3);
+        //
         value = (0, basic_1.random)({
             set: "english",
             length: [1, 3],
         });
         expect(value.length).toBeLessThanOrEqual(3);
+        value = (0, basic_1.random)(["english", [1, 3]]);
+        expect(value.length).toBeLessThanOrEqual(3);
+        //
         value = (0, basic_1.random)({
             set: "number",
             length: 3,
         });
         expect(value.length).toBe(3);
+        value = (0, basic_1.random)(["number", 3]);
+        expect(value.length).toBe(3);
+        //
         value = (0, basic_1.random)({
             range: "abc123",
             length: 3,
         });
         expect(value.length).toBe(3);
+        //
         value = (0, basic_1.random)({
             set: ["english", "number"],
             length: 3,
         });
         expect(value.length).toBe(3);
+        value = (0, basic_1.random)([["english", "number"], 3]);
+        expect(value.length).toBe(3);
+        //
         value = (0, basic_1.random)({
             set: "english",
             length: 2,
@@ -42,6 +58,8 @@ describe("markdown", function () {
             length: 2,
         });
         expect(value.length).toBe(4);
+        value = (0, basic_1.random)(["english", 2], [["english", "number"], 2]);
+        expect(value.length).toBe(4);
     });
     it("randomFileName", function () {
         var value = (0, custom_1.randomFileName)({

package/lib/test/name.test.js

@@ -9,12 +9,26 @@ describe("randomName", function () {
             expect(test_util_1.TestUtil.isNameValid(value)).toBeTruthy();
         }
     });
-    it("options", function () {
-        var value1 = (0, name_1.randomName)({ length: 5 });
-        expect(value1.length).toBe(5);
-        var value2 = (0, name_1.randomName)({ length: [5, 5] });
-        expect(value2.length).toBe(5);
-        var value3 = (0, name_1.randomName)({ length: [1, 5] });
-        expect(test_util_1.TestUtil.inNumberRange(value3.length, [1, 5])).toBeTruthy();
+    it("options: length", function () {
+        var value = (0, name_1.randomName)({ length: 5 });
+        expect(value.length).toBe(5);
+        value = (0, name_1.randomName)(5);
+        expect(value.length).toBe(5);
+        //
+        value = (0, name_1.randomName)({ length: [5, 5] });
+        expect(value.length).toBe(5);
+        value = (0, name_1.randomName)([5, 5]);
+        expect(value.length).toBe(5);
+        //
+        value = (0, name_1.randomName)({ length: [1, 5] });
+        expect(test_util_1.TestUtil.inNumberRange(value.length, [1, 5])).toBeTruthy();
+        value = (0, name_1.randomName)([1, 5]);
+        expect(test_util_1.TestUtil.inNumberRange(value.length, [1, 5])).toBeTruthy();
+    });
+    it("options: alphabet", function () {
+        var value = (0, name_1.randomName)({ alphabet: "russian", length: 5 });
+        expect(value.length).toBe(5);
+        value = (0, name_1.randomName)("french", 10);
+        expect(value.length).toBe(10);
     });
 });

package/lib/test/random.test.js

@@ -32,6 +32,12 @@ describe("random", function () {
         inSet("english", [1, 3]);
         inSet("english", [0, 1]);
     });
+    it("length: alphabet", function () {
+        var value = (0, basic_1.random)("english");
+        expect(value.length).toBe(1);
+        value = (0, basic_1.random)(["english", "l"]);
+        expect(value.length).toBe(1);
+    });
     it("alphabet: upper", function () {
         for (var i = 0; i < 100; i++) {
             var value = (0, basic_1.random)(["english", "u"]);

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

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

package/lib/test/set-util.test.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var set_1 = require("../basic/set");
+var defaultLength = [1, 10];
+function getLength(reservedChars, length, resultLength) {
+    var result = set_1.RandexSetUtil.getLength(reservedChars, length, defaultLength);
+    if (typeof resultLength === "number") {
+        expect(result).toBe(resultLength);
+    }
+    else {
+        expect(result).toMatchObject(resultLength);
+    }
+}
+describe("RandexSetUtil", function () {
+    describe("getLength", function () {
+        it("single", function () {
+            getLength(0, 2, 2);
+            getLength(1, 3, 2);
+            getLength(0, undefined, defaultLength);
+            getLength(5, 3, defaultLength);
+        });
+        it("array", function () {
+            getLength(0, [1, 2], [1, 2]);
+            getLength(1, [2, 3], [1, 2]);
+            getLength(3, [1, 5], defaultLength);
+        });
+    });
+});

package/lib/test/username.test.js

@@ -10,11 +10,19 @@ describe("randomEmail", function () {
         }
     });
     it("options", function () {
-        var value1 = (0, username_1.randomUsername)({ length: 5 });
-        expect(value1.length).toBe(5);
-        var value2 = (0, username_1.randomUsername)({ length: [5, 5] });
-        expect(value2.length).toBe(5);
-        var value3 = (0, username_1.randomUsername)({ length: [1, 5] });
-        expect(test_util_1.TestUtil.inNumberRange(value3.length, [1, 5])).toBeTruthy();
+        var value = (0, username_1.randomUsername)({ length: 5 });
+        expect(value.length).toBe(5);
+        value = (0, username_1.randomUsername)(5);
+        expect(value.length).toBe(5);
+        //
+        value = (0, username_1.randomUsername)({ length: [5, 5] });
+        expect(value.length).toBe(5);
+        value = (0, username_1.randomUsername)([5, 5]);
+        expect(value.length).toBe(5);
+        //
+        value = (0, username_1.randomUsername)({ length: [1, 5] });
+        expect(test_util_1.TestUtil.inNumberRange(value.length, [1, 5])).toBeTruthy();
+        value = (0, username_1.randomUsername)([1, 5]);
+        expect(test_util_1.TestUtil.inNumberRange(value.length, [1, 5])).toBeTruthy();
     });
 });

package/package.json

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