struct-fakerator 3.0.1 → 3.2.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.
Files changed (58) hide show
  1. package/README.md +2 -4
  2. package/dist/config_scheme.cjs +24 -40
  3. package/dist/config_scheme.js +24 -40
  4. package/dist/create_config.cjs +8 -7
  5. package/dist/create_config.js +8 -7
  6. package/dist/create_generator_fn.cjs +9 -8
  7. package/dist/create_generator_fn.js +9 -8
  8. package/dist/types/src/config_scheme.d.ts +35 -0
  9. package/dist/types/{create_config.d.ts → src/create_config.d.ts} +1 -14
  10. package/dist/types/src/create_generator_fn.d.ts +10 -0
  11. package/dist/types/src/type.d.ts +43 -0
  12. package/dist/types/{utils → src/utils}/airline.d.ts +3 -3
  13. package/dist/types/{utils → src/utils}/color.d.ts +7 -7
  14. package/dist/types/{utils → src/utils}/commerce.d.ts +6 -2
  15. package/dist/types/src/utils/common.d.ts +3 -0
  16. package/dist/types/{utils → src/utils}/datatype.d.ts +1 -1
  17. package/dist/types/{utils → src/utils}/datetime.d.ts +8 -8
  18. package/dist/types/{utils → src/utils}/finance.d.ts +7 -7
  19. package/dist/types/{utils → src/utils}/git.d.ts +3 -3
  20. package/dist/types/{utils → src/utils}/image.d.ts +9 -4
  21. package/dist/types/{utils → src/utils}/index.d.ts +2 -1
  22. package/dist/types/{utils → src/utils}/internet.d.ts +11 -11
  23. package/dist/types/{utils → src/utils}/location.d.ts +10 -10
  24. package/dist/types/{utils → src/utils}/lorem.d.ts +8 -8
  25. package/dist/types/{utils → src/utils}/number.d.ts +7 -7
  26. package/dist/types/{utils → src/utils}/person.d.ts +8 -6
  27. package/dist/types/{utils → src/utils}/phone.d.ts +1 -1
  28. package/dist/types/{utils → src/utils}/string.d.ts +25 -11
  29. package/dist/types/{utils → src/utils}/system.d.ts +5 -5
  30. package/dist/types/{utils → src/utils}/word.d.ts +9 -9
  31. package/dist/utils/commerce.cjs +5 -1
  32. package/dist/utils/commerce.js +2 -1
  33. package/dist/utils/image.cjs +4 -0
  34. package/dist/utils/image.js +2 -1
  35. package/dist/utils/index.cjs +18 -14
  36. package/dist/utils/index.js +2 -1
  37. package/dist/utils/string.cjs +4 -0
  38. package/dist/utils/string.js +2 -1
  39. package/package.json +54 -52
  40. package/dist/types/config_scheme.d.ts +0 -29
  41. package/dist/types/create_generator_fn.d.ts +0 -10
  42. package/dist/types/type.d.ts +0 -100
  43. package/dist/types/utils/common.d.ts +0 -2
  44. /package/dist/types/{config.d.ts → src/config.d.ts} +0 -0
  45. /package/dist/types/{create_config.test.d.ts → src/create_config.test.d.ts} +0 -0
  46. /package/dist/types/{create_generator_fn.test.d.ts → src/create_generator_fn.test.d.ts} +0 -0
  47. /package/dist/types/{generator_fn.d.ts → src/generator_fn.d.ts} +0 -0
  48. /package/dist/types/{index.d.ts → src/index.d.ts} +0 -0
  49. /package/dist/types/{utils → src/utils}/animal.d.ts +0 -0
  50. /package/dist/types/{utils → src/utils}/book.d.ts +0 -0
  51. /package/dist/types/{utils → src/utils}/company.d.ts +0 -0
  52. /package/dist/types/{utils → src/utils}/database.d.ts +0 -0
  53. /package/dist/types/{utils → src/utils}/food.d.ts +0 -0
  54. /package/dist/types/{utils → src/utils}/hacker.d.ts +0 -0
  55. /package/dist/types/{utils → src/utils}/music.d.ts +0 -0
  56. /package/dist/types/{utils → src/utils}/science.d.ts +0 -0
  57. /package/dist/types/{utils → src/utils}/utils.d.ts +0 -0
  58. /package/dist/types/{utils → src/utils}/vehicle.d.ts +0 -0
@@ -4,14 +4,14 @@ export declare const department: () => import("..").ValueConfig<string>;
4
4
  export declare const isbn: (options?: 10 | 13 | {
5
5
  variant?: 10 | 13;
6
6
  separator?: string;
7
- }) => import("..").ValueConfig<string>;
7
+ } | undefined) => import("..").ValueConfig<string>;
8
8
  /** Commerce [price](https://fakerjs.dev/api/commerce.html#price) */
9
9
  export declare const price: (options?: {
10
10
  min?: number;
11
11
  max?: number;
12
12
  dec?: number;
13
13
  symbol?: string;
14
- }) => import("..").ValueConfig<string>;
14
+ } | undefined) => import("..").ValueConfig<string>;
15
15
  /** Commerce [product](https://fakerjs.dev/api/commerce.html#product) */
16
16
  export declare const product: () => import("..").ValueConfig<string>;
17
17
  /** Commerce [productAdjective](https://fakerjs.dev/api/commerce.html#productAdjective) */
@@ -22,3 +22,7 @@ export declare const productDescription: () => import("..").ValueConfig<string>;
22
22
  export declare const productMaterial: () => import("..").ValueConfig<string>;
23
23
  /** Commerce [productName](https://fakerjs.dev/api/commerce.html#productName) */
24
24
  export declare const productName: () => import("..").ValueConfig<string>;
25
+ /** Commerce [upc](https://fakerjs.dev/api/commerce.html#upc) */
26
+ export declare const upc: (options?: {
27
+ prefix?: string;
28
+ } | undefined) => import("..").ValueConfig<string>;
@@ -0,0 +1,3 @@
1
+ import { ValueConfig } from "../type";
2
+ /** Common constant */
3
+ export declare const constant: <T>(value: T) => ValueConfig<T>;
@@ -1,4 +1,4 @@
1
1
  /** Datatype [boolean](https://fakerjs.dev/api/datatype.html#boolean) */
2
2
  export declare const boolean: (options?: number | {
3
3
  probability?: number;
4
- }) => import("..").ValueConfig<boolean>;
4
+ } | undefined) => import("..").ValueConfig<boolean>;
@@ -1,7 +1,7 @@
1
1
  /** Datetime [anytime](https://fakerjs.dev/api/date.html#anytime) */
2
2
  export declare const anytime: (options?: {
3
3
  refDate?: string | Date | number;
4
- }) => import("..").ValueConfig<Date>;
4
+ } | undefined) => import("..").ValueConfig<Date>;
5
5
  /** Datetime [between](https://fakerjs.dev/api/date.html#between) */
6
6
  export declare const between: (options: {
7
7
  from: string | Date | number;
@@ -24,36 +24,36 @@ export declare const birthdate: (options?: {
24
24
  min: number;
25
25
  max: number;
26
26
  refDate?: string | Date | number;
27
- }) => import("..").ValueConfig<Date>;
27
+ } | undefined) => import("..").ValueConfig<Date>;
28
28
  /** Datetime [future](https://fakerjs.dev/api/date.html#future) */
29
29
  export declare const future: (options?: {
30
30
  years?: number;
31
31
  refDate?: string | Date | number;
32
- }) => import("..").ValueConfig<Date>;
32
+ } | undefined) => import("..").ValueConfig<Date>;
33
33
  /** Datetime [month](https://fakerjs.dev/api/date.html#month) */
34
34
  export declare const month: (options?: {
35
35
  abbreviated?: boolean;
36
36
  context?: boolean;
37
- }) => import("..").ValueConfig<string>;
37
+ } | undefined) => import("..").ValueConfig<string>;
38
38
  /** Datetime [past](https://fakerjs.dev/api/date.html#past) */
39
39
  export declare const past: (options?: {
40
40
  years?: number;
41
41
  refDate?: string | Date | number;
42
- }) => import("..").ValueConfig<Date>;
42
+ } | undefined) => import("..").ValueConfig<Date>;
43
43
  /** Datetime [recent](https://fakerjs.dev/api/date.html#recent) */
44
44
  export declare const recent: (options?: {
45
45
  days?: number;
46
46
  refDate?: string | Date | number;
47
- }) => import("..").ValueConfig<Date>;
47
+ } | undefined) => import("..").ValueConfig<Date>;
48
48
  /** Datetime [soon](https://fakerjs.dev/api/date.html#soon) */
49
49
  export declare const soon: (options?: {
50
50
  days?: number;
51
51
  refDate?: string | Date | number;
52
- }) => import("..").ValueConfig<Date>;
52
+ } | undefined) => import("..").ValueConfig<Date>;
53
53
  /** Datetime [timeZone](https://fakerjs.dev/api/date.html#timeZone) */
54
54
  export declare const timeZone: () => import("..").ValueConfig<string>;
55
55
  /** Datetime [weekday](https://fakerjs.dev/api/date.html#weekday) */
56
56
  export declare const weekday: (options?: {
57
57
  abbreviated?: boolean;
58
58
  context?: boolean;
59
- }) => import("..").ValueConfig<string>;
59
+ } | undefined) => import("..").ValueConfig<string>;
@@ -3,7 +3,7 @@ export declare const accountName: () => import("..").ValueConfig<string>;
3
3
  /** Finance [accountNumber](https://fakerjs.dev/api/finance.html#accountNumber) */
4
4
  export declare const accountNumber: (optionsOrLength?: number | {
5
5
  length?: number;
6
- }) => import("..").ValueConfig<string>;
6
+ } | undefined) => import("..").ValueConfig<string>;
7
7
  /** Finance [amount](https://fakerjs.dev/api/finance.html#amount) */
8
8
  export declare const amount: (options?: {
9
9
  min?: number;
@@ -11,16 +11,16 @@ export declare const amount: (options?: {
11
11
  dec?: number;
12
12
  symbol?: string;
13
13
  autoFormat?: boolean;
14
- }) => import("..").ValueConfig<string>;
14
+ } | undefined) => import("..").ValueConfig<string>;
15
15
  /** Finance [bic](https://fakerjs.dev/api/finance.html#bic) */
16
16
  export declare const bic: (options?: {
17
17
  includeBranchCode?: boolean;
18
- }) => import("..").ValueConfig<string>;
18
+ } | undefined) => import("..").ValueConfig<string>;
19
19
  /** Finance [bitcoinAddress](https://fakerjs.dev/api/finance.html#bitcoinAddress) */
20
20
  export declare const bitcoinAddress: (options?: {
21
21
  type?: import("@faker-js/faker").BitcoinAddressFamilyType;
22
22
  network?: import("@faker-js/faker").BitcoinNetworkType;
23
- }) => import("..").ValueConfig<string>;
23
+ } | undefined) => import("..").ValueConfig<string>;
24
24
  /** Finance [creditCardCVV](https://fakerjs.dev/api/finance.html#creditCardCVV) */
25
25
  export declare const creditCardCVV: () => import("..").ValueConfig<string>;
26
26
  /** Finance [creditCardIssuer](https://fakerjs.dev/api/finance.html#creditCardIssuer) */
@@ -28,7 +28,7 @@ export declare const creditCardIssuer: () => import("..").ValueConfig<string>;
28
28
  /** Finance [creditCardNumber](https://fakerjs.dev/api/finance.html#creditCardNumber) */
29
29
  export declare const creditCardNumber: (options?: string | {
30
30
  issuer?: string;
31
- }) => import("..").ValueConfig<string>;
31
+ } | undefined) => import("..").ValueConfig<string>;
32
32
  /** Finance [currency](https://fakerjs.dev/api/finance.html#currency) */
33
33
  export declare const currency: () => import("..").ValueConfig<import("@faker-js/faker").Currency>;
34
34
  /** Finance [currencyCode](https://fakerjs.dev/api/finance.html#currencyCode) */
@@ -45,13 +45,13 @@ export declare const ethereumAddress: () => import("..").ValueConfig<string>;
45
45
  export declare const iban: (options?: {
46
46
  formatted?: boolean;
47
47
  countryCode?: string;
48
- }) => import("..").ValueConfig<string>;
48
+ } | undefined) => import("..").ValueConfig<string>;
49
49
  /** Finance [litecoinAddress](https://fakerjs.dev/api/finance.html#litecoinAddress) */
50
50
  export declare const litecoinAddress: () => import("..").ValueConfig<string>;
51
51
  /** Finance [pin](https://fakerjs.dev/api/finance.html#pin) */
52
52
  export declare const pin: (options?: number | {
53
53
  length?: number;
54
- }) => import("..").ValueConfig<string>;
54
+ } | undefined) => import("..").ValueConfig<string>;
55
55
  /** Finance [routingNumber](https://fakerjs.dev/api/finance.html#routingNumber) */
56
56
  export declare const routingNumber: () => import("..").ValueConfig<string>;
57
57
  /** Finance [transactionDescription](https://fakerjs.dev/api/finance.html#transactionDescription) */
@@ -3,16 +3,16 @@ export declare const branch: () => import("..").ValueConfig<string>;
3
3
  /** Git [commitDate](https://fakerjs.dev/api/git.html#commitDate) */
4
4
  export declare const commitDate: (options?: {
5
5
  refDate?: string | Date | number;
6
- }) => import("..").ValueConfig<string>;
6
+ } | undefined) => import("..").ValueConfig<string>;
7
7
  /** Git [commitEntry](https://fakerjs.dev/api/git.html#commitEntry) */
8
8
  export declare const commitEntry: (options?: {
9
9
  merge?: boolean;
10
10
  eol?: "LF" | "CRLF";
11
11
  refDate?: string | Date | number;
12
- }) => import("..").ValueConfig<string>;
12
+ } | undefined) => import("..").ValueConfig<string>;
13
13
  /** Git [commitMessage](https://fakerjs.dev/api/git.html#commitMessage) */
14
14
  export declare const commitMessage: () => import("..").ValueConfig<string>;
15
15
  /** Git [commitSha](https://fakerjs.dev/api/git.html#commitSha) */
16
16
  export declare const commitSha: (options?: {
17
17
  length?: number;
18
- }) => import("..").ValueConfig<string>;
18
+ } | undefined) => import("..").ValueConfig<string>;
@@ -8,22 +8,27 @@ export declare const dataUri: (options?: {
8
8
  height?: number;
9
9
  color?: string;
10
10
  type?: "svg-uri" | "svg-base64";
11
- }) => import("..").ValueConfig<string>;
11
+ } | undefined) => import("..").ValueConfig<string>;
12
+ /** Image [personPortrait](https://fakerjs.dev/api/image.html#personPortrait) */
13
+ export declare const personPortrait: (options?: {
14
+ sex?: import("@faker-js/faker").SexType;
15
+ size?: 512 | 256 | 128 | 64 | 32;
16
+ } | undefined) => import("..").ValueConfig<string>;
12
17
  /** Image [url](https://fakerjs.dev/api/image.html#url) */
13
18
  export declare const url: (options?: {
14
19
  width?: number;
15
20
  height?: number;
16
- }) => import("..").ValueConfig<string>;
21
+ } | undefined) => import("..").ValueConfig<string>;
17
22
  /** Image [urlLoremFlickr](https://fakerjs.dev/api/image.html#urlLoremFlickr) */
18
23
  export declare const urlLoremFlickr: (options?: {
19
24
  width?: number;
20
25
  height?: number;
21
26
  category?: string;
22
- }) => import("..").ValueConfig<string>;
27
+ } | undefined) => import("..").ValueConfig<string>;
23
28
  /** Image [urlPicsumPhotos](https://fakerjs.dev/api/image.html#urlPicsumPhotos) */
24
29
  export declare const urlPicsumPhotos: (options?: {
25
30
  width?: number;
26
31
  height?: number;
27
32
  grayscale?: boolean;
28
33
  blur?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
29
- }) => import("..").ValueConfig<string>;
34
+ } | undefined) => import("..").ValueConfig<string>;
@@ -23,6 +23,7 @@ export * as Phone from "./phone";
23
23
  export * as Science from "./science";
24
24
  export * as String from "./string";
25
25
  export * as System from "./system";
26
+ export * as Word from "./word";
27
+ export * as Vehicle from "./vehicle";
26
28
  export * as utils from "./utils";
27
29
  export { makeValueConfigFn } from "./utils";
28
- export * as Vehicle from "./vehicle";
@@ -2,7 +2,7 @@
2
2
  export declare const displayName: (options?: {
3
3
  firstName?: string;
4
4
  lastName?: string;
5
- }) => import("..").ValueConfig<string>;
5
+ } | undefined) => import("..").ValueConfig<string>;
6
6
  /** Internet [domainName](https://fakerjs.dev/api/internet.html#domainName) */
7
7
  export declare const domainName: () => import("..").ValueConfig<string>;
8
8
  /** Internet [domainSuffix](https://fakerjs.dev/api/internet.html#domainSuffix) */
@@ -15,23 +15,23 @@ export declare const email: (options?: {
15
15
  lastName?: string;
16
16
  provider?: string;
17
17
  allowSpecialCharacters?: boolean;
18
- }) => import("..").ValueConfig<string>;
18
+ } | undefined) => import("..").ValueConfig<string>;
19
19
  /** Internet [emoji](https://fakerjs.dev/api/internet.html#emoji) */
20
20
  export declare const emoji: (options?: {
21
21
  types?: ReadonlyArray<"symbol" | "object" | "smiley" | "body" | "person" | "nature" | "food" | "travel" | "activity" | "flag">;
22
- }) => import("..").ValueConfig<string>;
22
+ } | undefined) => import("..").ValueConfig<string>;
23
23
  /** Internet [exampleEmail](https://fakerjs.dev/api/internet.html#exampleEmail) */
24
24
  export declare const exampleEmail: (options?: {
25
25
  firstName?: string;
26
26
  lastName?: string;
27
27
  allowSpecialCharacters?: boolean;
28
- }) => import("..").ValueConfig<string>;
28
+ } | undefined) => import("..").ValueConfig<string>;
29
29
  /** Internet [httpMethod](https://fakerjs.dev/api/internet.html#httpMethod) */
30
30
  export declare const httpMethod: () => import("..").ValueConfig<"GET" | "POST" | "PUT" | "DELETE" | "PATCH">;
31
31
  /** Internet [httpStatusCode](https://fakerjs.dev/api/internet.html#httpStatusCode) */
32
32
  export declare const httpStatusCode: (options?: {
33
33
  types?: ReadonlyArray<"informational" | "success" | "clientError" | "serverError" | "redirection">;
34
- }) => import("..").ValueConfig<number>;
34
+ } | undefined) => import("..").ValueConfig<number>;
35
35
  /** Internet [ip](https://fakerjs.dev/api/internet.html#ip) */
36
36
  export declare const ip: () => import("..").ValueConfig<string>;
37
37
  /** Internet [ipv4](https://fakerjs.dev/api/internet.html#ipv4) */
@@ -39,7 +39,7 @@ export declare const ipv4: (options?: {
39
39
  cidrBlock?: string;
40
40
  } | {
41
41
  network?: import("@faker-js/faker").IPv4NetworkType;
42
- }) => import("..").ValueConfig<string>;
42
+ } | undefined) => import("..").ValueConfig<string>;
43
43
  /** Internet [ipv6](https://fakerjs.dev/api/internet.html#ipv6) */
44
44
  export declare const ipv6: () => import("..").ValueConfig<string>;
45
45
  /** Internet [jwt](https://fakerjs.dev/api/internet.html#jwt) */
@@ -47,20 +47,20 @@ export declare const jwt: (options?: {
47
47
  header?: Record<string, unknown>;
48
48
  payload?: Record<string, unknown>;
49
49
  refDate?: string | Date | number;
50
- }) => import("..").ValueConfig<string>;
50
+ } | undefined) => import("..").ValueConfig<string>;
51
51
  /** Internet [jwtAlgorithm](https://fakerjs.dev/api/internet.html#jwtAlgorithm) */
52
52
  export declare const jwtAlgorithm: () => import("..").ValueConfig<string>;
53
53
  /** Internet [mac](https://fakerjs.dev/api/internet.html#mac) */
54
54
  export declare const mac: (options?: string | {
55
55
  separator?: string;
56
- }) => import("..").ValueConfig<string>;
56
+ } | undefined) => import("..").ValueConfig<string>;
57
57
  /** Internet [password](https://fakerjs.dev/api/internet.html#password) */
58
58
  export declare const password: (options?: {
59
59
  length?: number;
60
60
  memorable?: boolean;
61
61
  pattern?: RegExp;
62
62
  prefix?: string;
63
- }) => import("..").ValueConfig<string>;
63
+ } | undefined) => import("..").ValueConfig<string>;
64
64
  /** Internet [port](https://fakerjs.dev/api/internet.html#port) */
65
65
  export declare const port: () => import("..").ValueConfig<number>;
66
66
  /** Internet [protocol](https://fakerjs.dev/api/internet.html#protocol) */
@@ -69,11 +69,11 @@ export declare const protocol: () => import("..").ValueConfig<"http" | "https">;
69
69
  export declare const url: (options?: {
70
70
  appendSlash?: boolean;
71
71
  protocol?: "http" | "https";
72
- }) => import("..").ValueConfig<string>;
72
+ } | undefined) => import("..").ValueConfig<string>;
73
73
  /** Internet [userAgent](https://fakerjs.dev/api/internet.html#userAgent) */
74
74
  export declare const userAgent: () => import("..").ValueConfig<string>;
75
75
  /** Internet [userName](https://fakerjs.dev/api/internet.html#userName) */
76
76
  export declare const username: (options?: {
77
77
  firstName?: string;
78
78
  lastName?: string;
79
- }) => import("..").ValueConfig<string>;
79
+ } | undefined) => import("..").ValueConfig<string>;
@@ -5,7 +5,7 @@ export declare const buildingNumber: () => ValueConfig<string>;
5
5
  /** Location [cardinalDirection](https://fakerjs.dev/api/location.html#cardinalDirection) */
6
6
  export declare const cardinalDirection: (options?: {
7
7
  abbreviated?: boolean;
8
- }) => ValueConfig<string>;
8
+ } | undefined) => ValueConfig<string>;
9
9
  /** Location [city](https://fakerjs.dev/api/location.html#city) */
10
10
  export declare const city: () => ValueConfig<string>;
11
11
  /** Location [continent](https://fakerjs.dev/api/location.html#continent) */
@@ -15,13 +15,13 @@ export declare const country: () => ValueConfig<string>;
15
15
  /** Location [countryCode](https://fakerjs.dev/api/location.html#countryCode) */
16
16
  export declare const countryCode: (options?: "alpha-2" | "alpha-3" | "numeric" | {
17
17
  variant?: "alpha-2" | "alpha-3" | "numeric";
18
- }) => ValueConfig<string>;
18
+ } | undefined) => ValueConfig<string>;
19
19
  /** Location [county](https://fakerjs.dev/api/location.html#county) */
20
20
  export declare const county: () => ValueConfig<string>;
21
21
  /** Location [direction](https://fakerjs.dev/api/location.html#direction) */
22
22
  export declare const direction: (options?: {
23
23
  abbreviated?: boolean;
24
- }) => ValueConfig<string>;
24
+ } | undefined) => ValueConfig<string>;
25
25
  type Language = ReturnType<typeof faker.location.language>;
26
26
  /** Location [language](https://fakerjs.dev/api/location.html#language) */
27
27
  export declare const language: () => ValueConfig<Language>;
@@ -30,40 +30,40 @@ export declare const latitude: (options?: {
30
30
  max?: number;
31
31
  min?: number;
32
32
  precision?: number;
33
- }) => ValueConfig<number>;
33
+ } | undefined) => ValueConfig<number>;
34
34
  /** Location [longitude](https://fakerjs.dev/api/location.html#longitude) */
35
35
  export declare const longitude: (options?: {
36
36
  max?: number;
37
37
  min?: number;
38
38
  precision?: number;
39
- }) => ValueConfig<number>;
39
+ } | undefined) => ValueConfig<number>;
40
40
  /** Location [nearbyGPSCoordinate](https://fakerjs.dev/api/location.html#nearbyGPSCoordinate) */
41
41
  export declare const nearbyGPSCoordinate: (options?: {
42
42
  origin?: [latitude: number, longitude: number];
43
43
  radius?: number;
44
44
  isMetric?: boolean;
45
- }) => ValueConfig<[latitude: number, longitude: number]>;
45
+ } | undefined) => ValueConfig<[latitude: number, longitude: number]>;
46
46
  /** Location [ordinalDirection](https://fakerjs.dev/api/location.html#ordinalDirection) */
47
47
  export declare const ordinalDirection: (options?: {
48
48
  abbreviated?: boolean;
49
- }) => ValueConfig<string>;
49
+ } | undefined) => ValueConfig<string>;
50
50
  /** Location [secondaryAddress](https://fakerjs.dev/api/location.html#secondaryAddress) */
51
51
  export declare const secondaryAddress: () => ValueConfig<string>;
52
52
  /** Location [state](https://fakerjs.dev/api/location.html#state) */
53
53
  export declare const state: (options?: {
54
54
  abbreviated?: boolean;
55
- }) => ValueConfig<string>;
55
+ } | undefined) => ValueConfig<string>;
56
56
  /** Location [street](https://fakerjs.dev/api/location.html#street) */
57
57
  export declare const street: () => ValueConfig<string>;
58
58
  /** Location [streetAddress](https://fakerjs.dev/api/location.html#streetAddress) */
59
59
  export declare const streetAddress: (options?: boolean | {
60
60
  useFullAddress?: boolean;
61
- }) => ValueConfig<string>;
61
+ } | undefined) => ValueConfig<string>;
62
62
  /** Location [timeZone](https://fakerjs.dev/api/location.html#timeZone) */
63
63
  export declare const timeZone: () => ValueConfig<string>;
64
64
  /** Location [zipCode](https://fakerjs.dev/api/location.html#zipCode) */
65
65
  export declare const zipCode: (options?: string | {
66
66
  state?: string;
67
67
  format?: string;
68
- }) => ValueConfig<string>;
68
+ } | undefined) => ValueConfig<string>;
69
69
  export {};
@@ -2,32 +2,32 @@
2
2
  export declare const lines: (lineCount?: number | {
3
3
  min: number;
4
4
  max: number;
5
- }) => import("..").ValueConfig<string>;
5
+ } | undefined) => import("..").ValueConfig<string>;
6
6
  /** Lorem [paragraph](https://fakerjs.dev/api/lorem.html#paragraph) */
7
7
  export declare const paragraph: (sentenceCount?: number | {
8
8
  min: number;
9
9
  max: number;
10
- }) => import("..").ValueConfig<string>;
10
+ } | undefined) => import("..").ValueConfig<string>;
11
11
  /** Lorem [paragraphs](https://fakerjs.dev/api/lorem.html#paragraphs) */
12
12
  export declare const paragraphs: (paragraphCount?: number | {
13
13
  min: number;
14
14
  max: number;
15
- }, separator?: string) => import("..").ValueConfig<string>;
15
+ } | undefined, separator?: string | undefined) => import("..").ValueConfig<string>;
16
16
  /** Lorem [sentence](https://fakerjs.dev/api/lorem.html#sentence) */
17
17
  export declare const sentence: (wordCount?: number | {
18
18
  min: number;
19
19
  max: number;
20
- }) => import("..").ValueConfig<string>;
20
+ } | undefined) => import("..").ValueConfig<string>;
21
21
  /** Lorem [sentences](https://fakerjs.dev/api/lorem.html#sentences) */
22
22
  export declare const sentences: (sentenceCount?: number | {
23
23
  min: number;
24
24
  max: number;
25
- }, separator?: string) => import("..").ValueConfig<string>;
25
+ } | undefined, separator?: string | undefined) => import("..").ValueConfig<string>;
26
26
  /** Lorem [slug](https://fakerjs.dev/api/lorem.html#slug) */
27
27
  export declare const slug: (wordCount?: number | {
28
28
  min: number;
29
29
  max: number;
30
- }) => import("..").ValueConfig<string>;
30
+ } | undefined) => import("..").ValueConfig<string>;
31
31
  /** Lorem [text](https://fakerjs.dev/api/lorem.html#text) */
32
32
  export declare const text: () => import("..").ValueConfig<string>;
33
33
  /** Lorem [word](https://fakerjs.dev/api/lorem.html#word) */
@@ -37,9 +37,9 @@ export declare const word: (options?: number | {
37
37
  max: number;
38
38
  };
39
39
  strategy?: "fail" | "closest" | "shortest" | "longest" | "any-length";
40
- }) => import("..").ValueConfig<string>;
40
+ } | undefined) => import("..").ValueConfig<string>;
41
41
  /** Lorem [words](https://fakerjs.dev/api/lorem.html#words) */
42
42
  export declare const words: (wordCount?: number | {
43
43
  min: number;
44
44
  max: number;
45
- }) => import("..").ValueConfig<string>;
45
+ } | undefined) => import("..").ValueConfig<string>;
@@ -3,37 +3,37 @@ export declare const bigInt: (options?: string | number | bigint | boolean | {
3
3
  min?: bigint | number | string | boolean;
4
4
  max?: bigint | number | string | boolean;
5
5
  multipleOf?: bigint | number | string | boolean;
6
- }) => import("..").ValueConfig<bigint>;
6
+ } | undefined) => import("..").ValueConfig<bigint>;
7
7
  /** Number [binary](https://fakerjs.dev/api/number.html#binary) */
8
8
  export declare const binary: (options?: number | {
9
9
  min?: number;
10
10
  max?: number;
11
- }) => import("..").ValueConfig<string>;
11
+ } | undefined) => import("..").ValueConfig<string>;
12
12
  /** Number [float](https://fakerjs.dev/api/number.html#float) */
13
13
  export declare const float: (options?: number | {
14
14
  min?: number;
15
15
  max?: number;
16
16
  fractionDigits?: number;
17
17
  multipleOf?: number;
18
- }) => import("..").ValueConfig<number>;
18
+ } | undefined) => import("..").ValueConfig<number>;
19
19
  /** Number [hex](https://fakerjs.dev/api/number.html#hex) */
20
20
  export declare const hex: (options?: number | {
21
21
  min?: number;
22
22
  max?: number;
23
- }) => import("..").ValueConfig<string>;
23
+ } | undefined) => import("..").ValueConfig<string>;
24
24
  /** Number [int](https://fakerjs.dev/api/number.html#int) */
25
25
  export declare const int: (options?: number | {
26
26
  min?: number;
27
27
  max?: number;
28
28
  multipleOf?: number;
29
- }) => import("..").ValueConfig<number>;
29
+ } | undefined) => import("..").ValueConfig<number>;
30
30
  /** Number [octal](https://fakerjs.dev/api/number.html#octal) */
31
31
  export declare const octal: (options?: number | {
32
32
  min?: number;
33
33
  max?: number;
34
- }) => import("..").ValueConfig<string>;
34
+ } | undefined) => import("..").ValueConfig<string>;
35
35
  /** Number [romanNumeral](https://fakerjs.dev/api/number.html#romanNumeral) */
36
36
  export declare const romanNumeral: (options?: number | {
37
37
  min?: number;
38
38
  max?: number;
39
- }) => import("..").ValueConfig<string>;
39
+ } | undefined) => import("..").ValueConfig<string>;
@@ -1,13 +1,13 @@
1
1
  /** Person [bio](https://fakerjs.dev/api/person.html#bio) */
2
2
  export declare const bio: () => import("..").ValueConfig<string>;
3
3
  /** Person [firstName](https://fakerjs.dev/api/person.html#firstName) */
4
- export declare const firstName: (sex?: "female" | "male") => import("..").ValueConfig<string>;
4
+ export declare const firstName: (sex?: "female" | "generic" | "male" | undefined) => import("..").ValueConfig<string>;
5
5
  /** Person [fullName](https://fakerjs.dev/api/person.html#fullName) */
6
6
  export declare const fullName: (options?: {
7
7
  firstName?: string;
8
8
  lastName?: string;
9
9
  sex?: import("@faker-js/faker").SexType;
10
- }) => import("..").ValueConfig<string>;
10
+ } | undefined) => import("..").ValueConfig<string>;
11
11
  /** Person [gender](https://fakerjs.dev/api/person.html#gender) */
12
12
  export declare const gender: () => import("..").ValueConfig<string>;
13
13
  /** Person [jobArea](https://fakerjs.dev/api/person.html#jobArea) */
@@ -19,15 +19,17 @@ export declare const jobTitle: () => import("..").ValueConfig<string>;
19
19
  /** Person [jobType](https://fakerjs.dev/api/person.html#jobType) */
20
20
  export declare const jobType: () => import("..").ValueConfig<string>;
21
21
  /** Person [lastName](https://fakerjs.dev/api/person.html#lastName) */
22
- export declare const lastName: (sex?: "female" | "male") => import("..").ValueConfig<string>;
22
+ export declare const lastName: (sex?: "female" | "generic" | "male" | undefined) => import("..").ValueConfig<string>;
23
23
  /** Person [middleName](https://fakerjs.dev/api/person.html#middleName) */
24
- export declare const middleName: (sex?: "female" | "male") => import("..").ValueConfig<string>;
24
+ export declare const middleName: (sex?: "female" | "generic" | "male" | undefined) => import("..").ValueConfig<string>;
25
25
  /** Person [prefix](https://fakerjs.dev/api/person.html#prefix) */
26
- export declare const prefix: (sex?: "female" | "male") => import("..").ValueConfig<string>;
26
+ export declare const prefix: (sex?: "female" | "generic" | "male" | undefined) => import("..").ValueConfig<string>;
27
27
  /** Person [sex](https://fakerjs.dev/api/person.html#sex) */
28
28
  export declare const sex: () => import("..").ValueConfig<string>;
29
29
  /** Person [sexType](https://fakerjs.dev/api/person.html#sexType) */
30
- export declare const sexType: () => import("..").ValueConfig<"female" | "male">;
30
+ export declare const sexType: (options?: {
31
+ includeGeneric?: boolean;
32
+ } | undefined) => import("..").ValueConfig<"female" | "generic" | "male">;
31
33
  /** Person [suffix](https://fakerjs.dev/api/person.html#suffix) */
32
34
  export declare const suffix: () => import("..").ValueConfig<string>;
33
35
  /** Person [zodiacSign](https://fakerjs.dev/api/person.html#zodiacSign) */
@@ -3,4 +3,4 @@ export declare const imei: () => import("..").ValueConfig<string>;
3
3
  /** Phone [number](https://fakerjs.dev/api/phone.html#number) */
4
4
  export declare const number: (options?: {
5
5
  style?: "human" | "national" | "international";
6
- }) => import("..").ValueConfig<string>;
6
+ } | undefined) => import("..").ValueConfig<string>;
@@ -8,7 +8,7 @@ export declare const alpha: (options?: number | {
8
8
  exclude?: ReadonlyArray<(("a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z") | ("A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R" | "S" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z")) | (string & {
9
9
  zz_IGNORE_ME?: never;
10
10
  })> | string;
11
- }) => import("..").ValueConfig<string>;
11
+ } | undefined) => import("..").ValueConfig<string>;
12
12
  /** String [alphanumeric](https://fakerjs.dev/api/string.html#alphanumeric) */
13
13
  export declare const alphanumeric: (options?: number | {
14
14
  length?: number | {
@@ -19,7 +19,7 @@ export declare const alphanumeric: (options?: number | {
19
19
  exclude?: ReadonlyArray<(string & {
20
20
  zz_IGNORE_ME?: never;
21
21
  }) | ((("a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z") | ("A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R" | "S" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z")) | ("0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9"))> | string;
22
- }) => import("..").ValueConfig<string>;
22
+ } | undefined) => import("..").ValueConfig<string>;
23
23
  /** String [binary](https://fakerjs.dev/api/string.html#binary) */
24
24
  export declare const binary: (options?: {
25
25
  length?: number | {
@@ -27,12 +27,12 @@ export declare const binary: (options?: {
27
27
  max: number;
28
28
  };
29
29
  prefix?: string;
30
- }) => import("..").ValueConfig<string>;
30
+ } | undefined) => import("..").ValueConfig<string>;
31
31
  /** String [fromCharacters](https://fakerjs.dev/api/string.html#fromCharacters) */
32
32
  export declare const fromCharacters: (characters: string | readonly string[], length?: number | {
33
33
  min: number;
34
34
  max: number;
35
- }) => import("..").ValueConfig<string>;
35
+ } | undefined) => import("..").ValueConfig<string>;
36
36
  /** String [hexadecimal](https://fakerjs.dev/api/string.html#hexadecimal) */
37
37
  export declare const hexadecimal: (options?: {
38
38
  length?: number | {
@@ -41,12 +41,23 @@ export declare const hexadecimal: (options?: {
41
41
  };
42
42
  casing?: "lower" | "upper" | "mixed";
43
43
  prefix?: string;
44
- }) => import("..").ValueConfig<string>;
44
+ } | undefined) => import("..").ValueConfig<string>;
45
45
  /** String [nanoid](https://fakerjs.dev/api/string.html#nanoid) */
46
46
  export declare const nanoid: (length?: number | {
47
47
  min: number;
48
48
  max: number;
49
- }) => import("..").ValueConfig<string>;
49
+ } | undefined) => import("..").ValueConfig<string>;
50
+ /** String [numeric](https://fakerjs.dev/api/string.html#numeric) */
51
+ export declare const numeric: (options?: number | {
52
+ length?: number | {
53
+ min: number;
54
+ max: number;
55
+ };
56
+ allowLeadingZeros?: boolean;
57
+ exclude?: ReadonlyArray<(string & {
58
+ zz_IGNORE_ME?: never;
59
+ }) | ("0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9")> | string;
60
+ } | undefined) => import("..").ValueConfig<string>;
50
61
  /** String [octal](https://fakerjs.dev/api/string.html#octal) */
51
62
  export declare const octal: (options?: {
52
63
  length?: number | {
@@ -54,20 +65,23 @@ export declare const octal: (options?: {
54
65
  max: number;
55
66
  };
56
67
  prefix?: string;
57
- }) => import("..").ValueConfig<string>;
68
+ } | undefined) => import("..").ValueConfig<string>;
58
69
  /** String [sample](https://fakerjs.dev/api/string.html#sample) */
59
70
  export declare const sample: (length?: number | {
60
71
  min: number;
61
72
  max: number;
62
- }) => import("..").ValueConfig<string>;
73
+ } | undefined) => import("..").ValueConfig<string>;
63
74
  /** String [symbol](https://fakerjs.dev/api/string.html#symbol) */
64
75
  export declare const symbol: (length?: number | {
65
76
  min: number;
66
77
  max: number;
67
- }) => import("..").ValueConfig<string>;
78
+ } | undefined) => import("..").ValueConfig<string>;
68
79
  /** String [ulid](https://fakerjs.dev/api/string.html#ulid) */
69
80
  export declare const ulid: (options?: {
70
81
  refDate?: string | Date | number;
71
- }) => import("..").ValueConfig<string>;
82
+ } | undefined) => import("..").ValueConfig<string>;
72
83
  /** String [uuid](https://fakerjs.dev/api/string.html#uuid) */
73
- export declare const uuid: () => import("..").ValueConfig<string>;
84
+ export declare const uuid: (options?: {
85
+ version?: 4 | 7;
86
+ refDate?: string | Date | number;
87
+ } | undefined) => import("..").ValueConfig<string>;