random-indian-names 1.1.0 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,6 +5,7 @@ A high-quality, lightweight Node.js module that uses a **Syllable Graph Engine**
|
|
|
5
5
|
Instead of random letters, this module uses real cultural "roots" and "transitions" to ensure names are phonetically natural, unique, and accurate.
|
|
6
6
|
|
|
7
7
|
## Features
|
|
8
|
+
- **TypeScript Ready**: Fully typed with type definitions.
|
|
8
9
|
- **Generative Algorithm**: Infinite variety, no stale datasets.
|
|
9
10
|
- **Length Control**: Specify `min` and `max` character counts.
|
|
10
11
|
- **Lightweight**: Zero dependencies.
|
|
@@ -25,13 +26,20 @@ const { getRandomName } = require('random-indian-names');
|
|
|
25
26
|
console.log(getRandomName()); // e.g., "Arjun"
|
|
26
27
|
```
|
|
27
28
|
|
|
29
|
+
### TypeScript / ES Modules
|
|
30
|
+
```typescript
|
|
31
|
+
import { getRandomName } from 'random-indian-names';
|
|
32
|
+
|
|
33
|
+
// Generate a random name
|
|
34
|
+
console.log(getRandomName(5, 10)); // e.g., "Vihaan"
|
|
35
|
+
```
|
|
36
|
+
|
|
28
37
|
### With Length Constraints
|
|
29
|
-
Get a name between 3 and 5 characters.
|
|
30
38
|
```javascript
|
|
39
|
+
// Get a name between 3 and 5 characters
|
|
31
40
|
console.log(getRandomName(3, 5)); // e.g., "Aditi"
|
|
32
41
|
|
|
33
|
-
//
|
|
34
|
-
console.log(getRandomName(5)); // e.g., "Vihaan"
|
|
42
|
+
// Call with one parameter (min=5, max defaults to 10)console.log(getRandomName(8)); // e.g., "Ishaninath"
|
|
35
43
|
```
|
|
36
44
|
|
|
37
45
|
## API
|