randex 0.23.0 → 0.25.0

package/README.md

@@ -22,6 +22,7 @@ Strings:
 - [email](#email)
 - [singleName](#singlename)
 - [fullName](#fullname)
+- [word](#word)
 
 Numbers:
 - [number](#number)
@@ -301,6 +302,50 @@ 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/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";
@@ -20,22 +20,26 @@ export declare class Randex {
     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 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;

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.23.0",
+  "version": "0.25.0",
   "description": "",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",