diff options
Diffstat (limited to 'src/modules/commerce')
| -rw-r--r-- | src/modules/commerce/index.ts | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/src/modules/commerce/index.ts b/src/modules/commerce/index.ts index 54d2bce1..ffb602b0 100644 --- a/src/modules/commerce/index.ts +++ b/src/modules/commerce/index.ts @@ -3,6 +3,14 @@ import { deprecated } from '../../internal/deprecated'; /** * Module to generate commerce and product related entries. + * + * ### Overview + * + * For a long product name like `'Incredible Soft Gloves'`, use [`productName()`](https://next.fakerjs.dev/api/commerce.html#productname). The product names are generated from a list of adjectives, materials, and products, which can each be accessed separately using [`productAdjective()`](https://next.fakerjs.dev/api/commerce.html#productadjective), [`productMaterial()`](https://next.fakerjs.dev/api/commerce.html#productmaterial), and [`product()`](https://next.fakerjs.dev/api/commerce.html#product). You can also create a description using [`productDescription()`](https://next.fakerjs.dev/api/commerce.html#productdescription). + * + * For a department in a shop or product category, use [`department()`](https://next.fakerjs.dev/api/commerce.html#department). + * + * You can also create a price using [`price()`](https://next.fakerjs.dev/api/commerce.html#price). */ export class CommerceModule { constructor(private readonly faker: Faker) { |