randex
v0.24.0
Published
Generates random filename, username, email, name, full name, etc for test purposes.
Downloads
679
Maintainers
Readme
randex
Generates random filename, username, email, name, full name, etc for test purposes.
Usage
Installation:
npm i randex
Strings:
Numbers:
Generic Type:
Deeps:
random
Basic function to construct random things.
import Randex from "randex";
// 3 english chars
Randex.random({
set: "english",
length: 3,
});
// or short:
Randex.random(["english", 3]);
// EFd
// 3 lower english chars
Randex.random({
set: ["english", "lower"],
length: 3,
});
// or short:
Randex.random([["english", "lower"], 3]);
// yhl
// min 1 and max 3 english chars
Randex.random({
set: "english",
length: [1, 3],
});
// or short:
Randex.random(["english", [1, 3]]);
// eR
// 3 number chars
Randex.random({
set: "number",
length: 3,
});
// or short:
Randex.random(["number", 3]);
// 643
// 3 chars from custom range
Randex.random({
range: "abc123",
length: 3,
});
// a21
// 3 english or number chars
Randex.random({
set: ["english", "number"],
length: 3,
});
// or short:
Randex.random([["english", "number"], 3]);
// x4d
// 4 chars: 2 english and 2 english or number
Randex.random(
{
set: "english",
length: 2,
},
{
set: ["english", "number"],
length: 2,
}
);
// or short:
Randex.random(["english", 2], [["english", "number"], 2]);
// Kb3b
Options:
| Name | Type| Description|
| ------------------------ | ---- |------------ |
|set|RandexSet | Defined chars|
|range|string
| Range or custom chars |
|length|RandexLength | Length of chars |
fileName
Randoms file name.
import Randex from "randex";
// default
Randex.fileName({
extension: "txt",
});
// td1TX31eOB.txt
// defined extension
Randex.fileName({
extension: "txt",
});
// or short:
Randex.fileName("txt");
// HkmOjqHC6.txt
// defined file name length and extension length
Randex.fileName({
fileNameLength: [7, 10],
extensionLength: 5,
});
// or short:
Randex.fileName([7, 10], 5);
// 1SJVkHSBjq.tejuw
// defined file name length and extension
Randex.fileName({
fileNameLength: 8,
extension: "xml",
});
// or short:
Randex.fileName(8, "xml");
// JyCsuN5kD.xml
Options:
| Name | Type| Description|
| ------------------------ | ---- |------------ |
|fileNameLength|RandexLength | Length of file name (not including extension). Default: [3,10] |
|extensionLength|RandexLength | Length of extension (not including file name) chars. Default: [2,5] |
|extension| string
| File extension. |
username
Randoms username.
import Randex from "randex";
// default
Randex.username();
// icvv81d1j
// with length 5 chars
Randex.username({ length: 5 });
// or short:
Randex.username(5);
// okmle
// with 2 min and 5 max chars
Randex.singleName({ length: [2, 5] });
// or short:
Randex.username([2, 5]);
// lkhs
Options: | Name | Type| Description| | ------------------------ | ---- |------------ | |length|RandexLength | Length of chars. Default: [6,10] |
randomEmail
Randoms an email.
import { randomEmail } from "randex";
// default
randomEmail();
// [email protected]
// defined prefix length
randomEmail({
prefixLength: 8,
});
// or shot:
randomEmail(8);
// [email protected]
// defined prefix, low domain and hight domain length
randomEmail({
prefixLength: 8,
lowDomainLength: 4,
hightDomainLength: 2,
});
// or shot:
randomEmail(8, 4, 2);
// [email protected]
// defined domain
randomEmail({
domain: "test.com",
});
// or shot:
randomEmail("test.com");
// [email protected]
Options:
| Name | Type| Description|
| ------------------------ | ---- |------------ |
|prefixLength|RandexLength | Length of email prefix (chars before @
). Default: [6, 10] |
|hightDomainLength|RandexLength | Length of hight domain part (example: test.com). Default: [1,6] |
|lowDomainLength|RandexLength | Length of low domain part (example: test.com). Default: [4,2] |
|domain| string
| Defined domain. |
singleName
Randoms a name of the person, city, place, restaurant, ect.
import Randex from "randex";
// default
Randex.singleName();
// Ijb
// with length 5 chars
Randex.singleName({ length: 5 });
// or short:
Randex.singleName(5);
// Okmpj
// with 2 min and 5 max chars
Randex.singleName({ length: [2, 5] });
// or short:
Randex.singleName([2, 5]);
// Wslg
// name from french alphabet
Randex.singleName({ alphabet: "french" });
// or short:
Randex.singleName("french");
// Dbïœ
// name from french alphabet with length
Randex.singleName({ alphabet: "french", length: 10 });
// or short:
Randex.singleName("french", 10);
// Rsîrjhjôôw
Options:
| Name | Type| Description|
| ------------------------ | ---- |------------ |
|length|RandexLength | Length of chars. Default: [2,10] |
|alphabet|RandexAlphabet | Defined alphabet. Default: english
|
randomFullName
Randoms a full name of the person.
import Randex from "randex";
// default
Randex.fullName();
// Eqaa Bfmotnq
Options:
| Name | Type| Description|
| ------------------------ | ---- |------------ |
|firstLength|RandexLength | First name length of chars. Default: [2, 10] |
|secondLength|RandexLength | Second name length of chars. Default: [2,10] |
|alphabet|RandexAlphabet | Defined alphabet. Default: english
|
word
Randoms a simple word.
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 | Length of chars. Default: [2,10] |
|alphabet|RandexAlphabet | Defined alphabet. Default: english
|
number
Generates random number from a range of numbers.
import Randex from "randex";
// Generates a number from a range: [0, 3] (includes 0 and 3).
Randex.number(3);
// Generates a number from a specified range: [3, 7].
Randex.number([3, 7]);
Options:
| Name | Type| Description|
| ------------------------ | ---- |------------ |
|decimals| number
| Number of decimal digits |
numberArray
Generates random array with values from a range.
import Randex from "randex";
// Generates an array (with length equals 2) with unique numbers from a range: [0, 3].
Randex.numberArray(3, 2);
// Generates an array (with length equals 3) with unique numbers from a range: [3, 7].
Randex.numberArray([3, 7], 3);
array
Generates random array with values from defined array.
import Randex from "randex";
// Generates an array (with length equals 2) with values picked from defined array as the first parameter.
Randex.array([1, 2, 3, 4], 2);
// [2, 4]
Randex.array(["1", "2", "3", "4"], 2);
// ["1", "3"]
Customization
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:
Randex.fileName
Randex.random([
["english", "number"],
[3, 10],
]) +
"." +
Randex.random([
["english", "l"],
[2, 5],
]);
Randex.username
Randex.random(
["english", "l"],
[
[["english", "l"], "number"],
[5, 10],
]
);
Randex.email
Randex.random([
[["english", "l"], "number"],
[6, 10],
]) +
"@" +
Randex.random([
["english", "l"],
[2, 4],
]) +
"." +
Randex.random([
["english", "l"],
[1, 6],
]);
Randex.singleName
Randex.random(
["english", "u"],
[
["english", "l"],
[1, 10],
]
);
Randex.fullName
Randex.random(
["english", "u"],
[
["english", "l"],
[1, 10],
]
) +
" " +
Randex.random(
["english", "u"],
[
["english", "l"],
[1, 10],
]
);
Types
RandexLength
Possible types:
number
: strict length
[number, number]
: an array of min and max length.
Example:
Randex.random({ set: "bit", length: 5 });
Randex.random({ set: "bit", length: [5, 10] });
// or short:
Randex.random(["bit", 5]);
Randex.random(["bit", [5, 10]]);
RandexSet
Possible types:
string
: an alphabet - RandexAlphabet or a set of chars - RandexKit
[string, string]
: the first item is - RandexAlphabet, the second item is - RandexCase
Example:
Randex.random({ set: "bit" });
Randex.random({ set: "spanish" });
Randex.random({ set: ["spanish", "lower"] });
// or short:
Randex.random("bit");
Randex.random("spanish");
Randex.random(["spanish", "l"]);
RandexAlphabet
An alphabet of chars
string
values: english
, french
, spanish
, russian
.
Example:
Randex.random({ set: "spanish" });
// or short:
Randex.random("spanish");
RandexKit
A kit of chars
string
values: hex
, symbol
, number
, binary
.
Example:
Randex.random({ set: "hex" });
// or short:
Randex.random("hex");
RandexCase
A case of alphabet
string
values: upper
, u
,lower
, l
.
Example:
Randex.random({ set: ["spanish", "lower"] });
// or short:
Randex.random(["spanish", "l"]);