aboutsummaryrefslogtreecommitdiff
path: root/src/modules/commerce
diff options
context:
space:
mode:
authorMatt Mayer <[email protected]>2024-12-29 22:42:50 +0700
committerGitHub <[email protected]>2024-12-29 15:42:50 +0000
commit637f81bf9035bdcf030c2dfcd1a875de2721ad71 (patch)
treee8f3eb44997d71d9f12b9bbdb6808db624894270 /src/modules/commerce
parent6c13fe0a86bb44c48e20c38b1ea600f9aa39446a (diff)
downloadfaker-637f81bf9035bdcf030c2dfcd1a875de2721ad71.tar.xz
faker-637f81bf9035bdcf030c2dfcd1a875de2721ad71.zip
docs: fix examples which return string/number (#3348)
Diffstat (limited to 'src/modules/commerce')
-rw-r--r--src/modules/commerce/index.ts10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/modules/commerce/index.ts b/src/modules/commerce/index.ts
index 61dd9a9c..70482d80 100644
--- a/src/modules/commerce/index.ts
+++ b/src/modules/commerce/index.ts
@@ -129,11 +129,11 @@ export class CommerceModule extends ModuleBase {
* @param options.symbol The currency value to use. Defaults to `''`.
*
* @example
- * faker.commerce.price() // 828.07
- * faker.commerce.price({ min: 100 }) // 904.19
- * faker.commerce.price({ min: 100, max: 200 }) // 154.55
- * faker.commerce.price({ min: 100, max: 200, dec: 0 }) // 133
- * faker.commerce.price({ min: 100, max: 200, dec: 0, symbol: '$' }) // $114
+ * faker.commerce.price() // '828.07'
+ * faker.commerce.price({ min: 100 }) // '904.19'
+ * faker.commerce.price({ min: 100, max: 200 }) // '154.55'
+ * faker.commerce.price({ min: 100, max: 200, dec: 0 }) // '133'
+ * faker.commerce.price({ min: 100, max: 200, dec: 0, symbol: '$' }) // '$114'
*
* @since 3.0.0
*/