vietnamese-name-generator 0.1.0
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/LICENSE +21 -0
- package/README.md +177 -0
- package/dist/index.cjs +27291 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +59 -0
- package/dist/index.d.ts +59 -0
- package/dist/index.js +27257 -0
- package/dist/index.js.map +1 -0
- package/package.json +55 -0
package/dist/index.d.cts
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
declare enum EGender {
|
|
2
|
+
Male = "male",
|
|
3
|
+
Female = "female",
|
|
4
|
+
Unisex = "unisex"
|
|
5
|
+
}
|
|
6
|
+
declare enum ERegion {
|
|
7
|
+
North = "north",
|
|
8
|
+
Central = "central",
|
|
9
|
+
South = "south"
|
|
10
|
+
}
|
|
11
|
+
declare enum EEra {
|
|
12
|
+
Traditional = "traditional",
|
|
13
|
+
Modern = "modern"
|
|
14
|
+
}
|
|
15
|
+
declare enum EMeaningCategory {
|
|
16
|
+
Strength = "strength",
|
|
17
|
+
Virtue = "virtue",
|
|
18
|
+
Nature = "nature",
|
|
19
|
+
Precious = "precious",
|
|
20
|
+
Beauty = "beauty",
|
|
21
|
+
Celestial = "celestial",
|
|
22
|
+
Season = "season",
|
|
23
|
+
Intellect = "intellect",
|
|
24
|
+
Prosperity = "prosperity"
|
|
25
|
+
}
|
|
26
|
+
type TWeightedEntry = {
|
|
27
|
+
value: string;
|
|
28
|
+
weight: number;
|
|
29
|
+
};
|
|
30
|
+
type TGivenNameEntry = {
|
|
31
|
+
value: string;
|
|
32
|
+
meaning?: string;
|
|
33
|
+
sinoVietnamese?: string;
|
|
34
|
+
category?: EMeaningCategory;
|
|
35
|
+
};
|
|
36
|
+
type TGenerateOptions = {
|
|
37
|
+
gender?: EGender;
|
|
38
|
+
region?: ERegion;
|
|
39
|
+
era?: EEra;
|
|
40
|
+
compoundName?: boolean;
|
|
41
|
+
meaningCategory?: EMeaningCategory;
|
|
42
|
+
withMiddleName?: boolean;
|
|
43
|
+
};
|
|
44
|
+
interface INameResult {
|
|
45
|
+
surname: string;
|
|
46
|
+
middleName: string;
|
|
47
|
+
givenName: string;
|
|
48
|
+
fullName: string;
|
|
49
|
+
gender: EGender;
|
|
50
|
+
region: ERegion;
|
|
51
|
+
era: EEra;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
declare function generate(options?: TGenerateOptions): INameResult;
|
|
55
|
+
declare function generateFullName(options?: TGenerateOptions): string;
|
|
56
|
+
declare function generateMany(count: number, options?: TGenerateOptions): INameResult[];
|
|
57
|
+
declare function generateManyFullNames(count: number, options?: TGenerateOptions): string[];
|
|
58
|
+
|
|
59
|
+
export { EEra, EGender, EMeaningCategory, ERegion, type INameResult, type TGenerateOptions, type TGivenNameEntry, type TWeightedEntry, generate, generateFullName, generateMany, generateManyFullNames };
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
declare enum EGender {
|
|
2
|
+
Male = "male",
|
|
3
|
+
Female = "female",
|
|
4
|
+
Unisex = "unisex"
|
|
5
|
+
}
|
|
6
|
+
declare enum ERegion {
|
|
7
|
+
North = "north",
|
|
8
|
+
Central = "central",
|
|
9
|
+
South = "south"
|
|
10
|
+
}
|
|
11
|
+
declare enum EEra {
|
|
12
|
+
Traditional = "traditional",
|
|
13
|
+
Modern = "modern"
|
|
14
|
+
}
|
|
15
|
+
declare enum EMeaningCategory {
|
|
16
|
+
Strength = "strength",
|
|
17
|
+
Virtue = "virtue",
|
|
18
|
+
Nature = "nature",
|
|
19
|
+
Precious = "precious",
|
|
20
|
+
Beauty = "beauty",
|
|
21
|
+
Celestial = "celestial",
|
|
22
|
+
Season = "season",
|
|
23
|
+
Intellect = "intellect",
|
|
24
|
+
Prosperity = "prosperity"
|
|
25
|
+
}
|
|
26
|
+
type TWeightedEntry = {
|
|
27
|
+
value: string;
|
|
28
|
+
weight: number;
|
|
29
|
+
};
|
|
30
|
+
type TGivenNameEntry = {
|
|
31
|
+
value: string;
|
|
32
|
+
meaning?: string;
|
|
33
|
+
sinoVietnamese?: string;
|
|
34
|
+
category?: EMeaningCategory;
|
|
35
|
+
};
|
|
36
|
+
type TGenerateOptions = {
|
|
37
|
+
gender?: EGender;
|
|
38
|
+
region?: ERegion;
|
|
39
|
+
era?: EEra;
|
|
40
|
+
compoundName?: boolean;
|
|
41
|
+
meaningCategory?: EMeaningCategory;
|
|
42
|
+
withMiddleName?: boolean;
|
|
43
|
+
};
|
|
44
|
+
interface INameResult {
|
|
45
|
+
surname: string;
|
|
46
|
+
middleName: string;
|
|
47
|
+
givenName: string;
|
|
48
|
+
fullName: string;
|
|
49
|
+
gender: EGender;
|
|
50
|
+
region: ERegion;
|
|
51
|
+
era: EEra;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
declare function generate(options?: TGenerateOptions): INameResult;
|
|
55
|
+
declare function generateFullName(options?: TGenerateOptions): string;
|
|
56
|
+
declare function generateMany(count: number, options?: TGenerateOptions): INameResult[];
|
|
57
|
+
declare function generateManyFullNames(count: number, options?: TGenerateOptions): string[];
|
|
58
|
+
|
|
59
|
+
export { EEra, EGender, EMeaningCategory, ERegion, type INameResult, type TGenerateOptions, type TGivenNameEntry, type TWeightedEntry, generate, generateFullName, generateMany, generateManyFullNames };
|