Skip to content

Commit 28d7cdb

Browse files
feat: Add functions to generate secure and customizable IDs and numbers
This commit adds new functions to the '@astreak/unity' package that allow users to generate secure and customizable registration numbers, SKUs, order IDs, ticket IDs, tracking numbers, random strings, random numbers, random hex strings, random passwords, random tokens, and random IVs for encryption. The new functions include: - `generateRegistrationNumber(prefix: string, length: number, includeAlpha: boolean, includeNumeric: boolean): string` - `generateSKU(prefix: string, length: number, includeAlpha: boolean, includeNumeric: boolean): string` - `generateOrderID(prefix: string, length: number, includeAlpha: boolean, includeNumeric: boolean): string` - `generateTicketID(prefix: string, length: number, includeAlpha: boolean, includeNumeric: boolean): string` - `generateTrackingNumber(prefix: string, length: number, includeAlpha: boolean, includeNumeric: boolean): string` - `generateRandomString(length: number): string` - `generateRandomNumber(min: number, max: number): number` - `generateRandomHex(length: number): string` - `generateRandomPassword(length: number): string` - `generateRandomToken(length: number): string` - `generateRandomIV(): string` These functions provide users with a convenient way to generate various types of secure and customizable IDs and numbers for their applications.
1 parent 865430d commit 28d7cdb

File tree

1 file changed

+101
-3
lines changed

1 file changed

+101
-3
lines changed

README.md

+101-3
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,115 @@ Install the package via npm:
88

99
```bash
1010
npm install @astreak/unity
11-
11+
```
1212

1313
## Usage
1414

15+
1516
```javascript
16-
import { readFile } = '@astreak/unity';
17+
18+
import { exmaple } = '@astreak/unity';
19+
20+
```
21+
22+
## API
23+
24+
### `example()`
1725

1826

27+
### Generating Registration Number
28+
Generate a secure and customizable registration number:
1929

30+
javascript
2031

21-
// Generate a SKU
2232

33+
```javascript
34+
const registrationNumber = generateRegistrationNumber('USR', 6, true, true);
35+
console.log(registrationNumber); // Example output: USR-L8FJP-A1B2C3
36+
37+
```
38+
39+
### Generating SKU
40+
Generate a secure and customizable SKU:
41+
42+
```javascript
2343

44+
const sku = generateSKU('ELEC', 8, true, true);
45+
console.log(sku); // Example output: ELEC-L8FJP-A1B2C3D4
46+
47+
```
48+
49+
50+
### Generating Order ID
51+
Generate a secure and customizable order ID:
52+
53+
```javascript
54+
55+
const orderID = generateOrderID('ORD', 6, true, true);
56+
console.log(orderID); // Example output: ORD-L8FJP-A1B2C3
57+
58+
```
59+
60+
### Generating Ticket ID
61+
Generate a secure and customizable ticket ID:
62+
63+
```javascript
64+
const ticketID = generateTicketID('TCK', 6, true, true);
65+
console.log(ticketID); // Example output: TCK-L8FJP-A1B2C3
66+
```
2467

68+
### Generating Tracking Number
69+
Generate a secure and customizable tracking number:
70+
71+
```javascript
72+
const trackingNumber = generateTrackingNumber('TRK', 8, true, true);
73+
console.log(trackingNumber); // Example output: TRK-L8FJP-A1B2C3D4
74+
```
75+
76+
### Generating Random String
77+
Generate a random string of a specified length:
78+
79+
```javascript
80+
const randomString = generateRandomString(10);
81+
console.log(randomString); // Example output: a1b2c3d4e5
82+
```
83+
84+
### Generating Random Number
85+
Generate a random number within a specified range:
86+
87+
```javascript
88+
const randomNumber = generateRandomNumber(1, 100);
89+
console.log(randomNumber); // Example output: 42
90+
```
91+
92+
### Generating Random Hex
93+
Generate a random hexadecimal string of a specified length:
94+
95+
```javascript
96+
const randomHex = generateRandomHex(6);
97+
console.log(randomHex); // Example output: a1b2c3
98+
```
99+
100+
### Generating Random Password
101+
Generate a random password of a specified length:
102+
103+
```javascript
104+
const randomPassword = generateRandomPassword(10);
105+
console.log(randomPassword); // Example output: A1b2C3d4E5
106+
```
107+
108+
### Generating Random Token
109+
Generate a random token of a specified length:
110+
111+
```javascript
112+
const randomToken = generateRandomToken(16);
113+
console.log(randomToken); // Example output: a1b2c3d4e5f6a7b8
114+
```
115+
116+
### Generating Random IV
117+
Generate a random initialization vector (IV) for encryption:
118+
119+
```javascript
120+
const randomIV = generateRandomIV();
121+
console.log(randomIV); // Example output: a1b2c3d4e5f6a7b8c9d0e1f2
122+
```

0 commit comments

Comments
 (0)