blob: 99515463bc72fe6134b811ce915ab10d7ccc0df7 (
plain)
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
|
import type { Faker } from '../../faker';
/**
* Module to generate commerce and product related entries.
*/
export class CommerceModule {
constructor(private readonly faker: Faker) {
// Bind `this` so namespaced is working correctly
for (const name of Object.getOwnPropertyNames(CommerceModule.prototype)) {
if (name === 'constructor' || typeof this[name] !== 'function') {
continue;
}
this[name] = this[name].bind(this);
}
}
/**
* Returns a department inside a shop.
*
* @example
* faker.commerce.department() // 'Garden'
*
* @since 3.0.0
*/
department(): string {
return this.faker.helpers.arrayElement(
this.faker.definitions.commerce.department
);
}
/**
* Generates a random descriptive product name.
*
* @example
* faker.commerce.productName() // 'Incredible Soft Gloves'
*
* @since 3.0.0
*/
productName(): string {
return `${this.productAdjective()} ${this.productMaterial()} ${this.product()}`;
}
/**
* Generates a price between min and max (inclusive).
*
* @param min The minimum price. Defaults to `1`.
* @param max The maximum price. Defaults to `1000`.
* @param dec The number of decimal places. Defaults to `2`.
* @param symbol The currency value to use. Defaults to `''`.
*
* @example
* faker.commerce.price() // 828.00
* faker.commerce.price(100) // 904.00
* faker.commerce.price(100, 200) // 154.00
* faker.commerce.price(100, 200, 0) // 133
* faker.commerce.price(100, 200, 0, '$') // $114
*
* @since 3.0.0
*/
price(
min: number = 1,
max: number = 1000,
dec: number = 2,
symbol: string = ''
): string {
if (min < 0 || max < 0) {
return `${symbol}${0.0}`;
}
// TODO @Shinigami92 2022-11-24: https://github.com/faker-js/faker/issues/350
const randValue = this.faker.number.int({ min, max });
return symbol + randValue.toFixed(dec);
}
/**
* Returns an adjective describing a product.
*
* @example
* faker.commerce.productAdjective() // 'Handcrafted'
*
* @since 3.0.0
*/
productAdjective(): string {
return this.faker.helpers.arrayElement(
this.faker.definitions.commerce.product_name.adjective
);
}
/**
* Returns a material of a product.
*
* @example
* faker.commerce.productMaterial() // 'Rubber'
*
* @since 3.0.0
*/
productMaterial(): string {
return this.faker.helpers.arrayElement(
this.faker.definitions.commerce.product_name.material
);
}
/**
* Returns a short product name.
*
* @example
* faker.commerce.product() // 'Computer'
*
* @since 3.0.0
*/
product(): string {
return this.faker.helpers.arrayElement(
this.faker.definitions.commerce.product_name.product
);
}
/**
* Returns a product description.
*
* @example
* faker.commerce.productDescription() // 'Andy shoes are designed to keeping...'
*
* @since 5.0.0
*/
productDescription(): string {
return this.faker.helpers.arrayElement(
this.faker.definitions.commerce.product_description
);
}
}
|
