From 35de92ffaff2261eae29422474afd4ca674ab473 Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Thu, 27 Jan 2022 18:13:29 +0100 Subject: docs: automatically generate api docs from source (#289) Co-authored-by: Shinigami --- docs/api/commerce.md | 62 ---------------------------------------------------- 1 file changed, 62 deletions(-) delete mode 100644 docs/api/commerce.md (limited to 'docs/api/commerce.md') diff --git a/docs/api/commerce.md b/docs/api/commerce.md deleted file mode 100644 index a7809709..00000000 --- a/docs/api/commerce.md +++ /dev/null @@ -1,62 +0,0 @@ -# Commerce - -[[toc]] - -## Color - -Return random color name - -```js -faker.commerce.color(); // fuchsia -``` - -## Department - -Return random department name - -```js -faker.commerce.department(); // Grocery -``` - -## Price - -Generates random price - -::: tip -| Param | Type | Default | -| ------ | ------ | :-----: | -| min | number | `1` | -| max | number | `1000` | -| dec | number | `2` | -| symbol | string | `` | -::: - -```js -faker.commerce.price(); // 4.00 -faker.commerce.price(2, 22, 1, '$'); // $7.0 -``` - -## Product - -Return random product - -```js -faker.commerce.product(); // Gloves -faker.commerce.productName(); // Rustic Granite Shirt -``` - -## Product Adjective - -Return random product adjective - -```js -faker.commerce.productAdjective(); // Handmade -``` - -## Product Material - -Return random product material - -```js -faker.commerce.productMaterial(); // Steel -``` -- cgit v1.2.3