diff options
| author | ST-DDT <[email protected]> | 2022-01-27 18:13:29 +0100 |
|---|---|---|
| committer | GitHub <[email protected]> | 2022-01-27 12:13:29 -0500 |
| commit | 35de92ffaff2261eae29422474afd4ca674ab473 (patch) | |
| tree | dbc38e3abe4b7ea812292165f62e96b1814a437a /docs/api/commerce.md | |
| parent | 3242dfc4b2f566931c3687173f6361a6384b6247 (diff) | |
| download | faker-35de92ffaff2261eae29422474afd4ca674ab473.tar.xz faker-35de92ffaff2261eae29422474afd4ca674ab473.zip | |
docs: automatically generate api docs from source (#289)
Co-authored-by: Shinigami <[email protected]>
Diffstat (limited to 'docs/api/commerce.md')
| -rw-r--r-- | docs/api/commerce.md | 62 |
1 files changed, 0 insertions, 62 deletions
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 -``` |
