1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
import { ModuleBase } from '../../internal/module-base';
/**
* Module to generate vehicle related entries.
*
* ### Overview
*
* Most methods are related to cars/automobiles: a [`vehicle()`](https://fakerjs.dev/api/vehicle.html#vehicle) name is comprised of a car [`manufacturer()`](https://fakerjs.dev/api/vehicle.html#manufacturer) and [`model()`](https://fakerjs.dev/api/vehicle.html#model). You can also generate [`fuel()`](https://fakerjs.dev/api/vehicle.html#fuel), [`type()`](https://fakerjs.dev/api/vehicle.html#type), and [`color()`](https://fakerjs.dev/api/vehicle.html#color), as well as typical car registration IDs [`vin()`](https://fakerjs.dev/api/vehicle.html#vin) and [`vrm()`](https://fakerjs.dev/api/vehicle.html#vrm).
*
* If you prefer two wheels, you can generate a [`bicycle()`](https://fakerjs.dev/api/vehicle.html#bicycle) type instead.
*/
export class VehicleModule extends ModuleBase {
/**
* Returns a random vehicle.
*
* @example
* faker.vehicle.vehicle() // 'BMW Explorer'
*
* @since 5.0.0
*/
vehicle(): string {
return `${this.manufacturer()} ${this.model()}`;
}
/**
* Returns a manufacturer name.
*
* @example
* faker.vehicle.manufacturer() // 'Ford'
*
* @since 5.0.0
*/
manufacturer(): string {
return this.faker.helpers.arrayElement(
this.faker.definitions.vehicle.manufacturer
);
}
/**
* Returns a vehicle model.
*
* @example
* faker.vehicle.model() // 'Explorer'
*
* @since 5.0.0
*/
model(): string {
return this.faker.helpers.arrayElement(
this.faker.definitions.vehicle.model
);
}
/**
* Returns a vehicle type.
*
* @example
* faker.vehicle.type() // 'Coupe'
*
* @since 5.0.0
*/
type(): string {
return this.faker.helpers.arrayElement(this.faker.definitions.vehicle.type);
}
/**
* Returns a fuel type.
*
* @example
* faker.vehicle.fuel() // 'Electric'
*
* @since 5.0.0
*/
fuel(): string {
return this.faker.helpers.arrayElement(this.faker.definitions.vehicle.fuel);
}
/**
* Returns a vehicle identification number (VIN).
*
* @example
* faker.vehicle.vin() // 'YV1MH682762184654'
*
* @since 5.0.0
*/
vin(): string {
const exclude = ['o', 'i', 'q', 'O', 'I', 'Q'];
return `${this.faker.string.alphanumeric({
length: 10,
casing: 'upper',
exclude,
})}${this.faker.string.alpha({
length: 1,
casing: 'upper',
exclude,
})}${this.faker.string.alphanumeric({
length: 1,
casing: 'upper',
exclude,
})}${this.faker.string.numeric({ length: 5, allowLeadingZeros: true })}`;
}
/**
* Returns a vehicle color.
*
* @example
* faker.vehicle.color() // 'red'
*
* @since 5.0.0
*/
color(): string {
return this.faker.color.human();
}
/**
* Returns a vehicle registration number (Vehicle Registration Mark - VRM)
*
* @example
* faker.vehicle.vrm() // 'MF56UPA'
*
* @since 5.4.0
*/
vrm(): string {
return `${this.faker.string.alpha({
length: 2,
casing: 'upper',
})}${this.faker.string.numeric({
length: 2,
allowLeadingZeros: true,
})}${this.faker.string.alpha({
length: 3,
casing: 'upper',
})}`;
}
/**
* Returns a type of bicycle.
*
* @example
* faker.vehicle.bicycle() // 'Adventure Road Bicycle'
*
* @since 5.5.0
*/
bicycle(): string {
return this.faker.helpers.arrayElement(
this.faker.definitions.vehicle.bicycle_type
);
}
}
|
