aboutsummaryrefslogtreecommitdiff
path: root/src/modules/commerce
diff options
context:
space:
mode:
Diffstat (limited to 'src/modules/commerce')
-rw-r--r--src/modules/commerce/index.ts28
1 files changed, 24 insertions, 4 deletions
diff --git a/src/modules/commerce/index.ts b/src/modules/commerce/index.ts
index 48f56568..1be3fcb2 100644
--- a/src/modules/commerce/index.ts
+++ b/src/modules/commerce/index.ts
@@ -115,7 +115,7 @@ export class CommerceModule extends ModuleBase {
/**
* Generates a price between min and max (inclusive).
*
- * @param options An options object. Defaults to `{}`.
+ * @param options An options object.
* @param options.min The minimum price. Defaults to `1`.
* @param options.max The maximum price. Defaults to `1000`.
* @param options.dec The number of decimal places. Defaults to `2`.
@@ -179,7 +179,7 @@ export class CommerceModule extends ModuleBase {
/**
* Generates a price between min and max (inclusive).
*
- * @param options The minimum price or on options object. Defaults to `{}`.
+ * @param options The minimum price or on options object.
* @param options.min The minimum price. Defaults to `1`.
* @param options.max The maximum price. Defaults to `1000`.
* @param options.dec The number of decimal places. Defaults to `2`.
@@ -201,9 +201,29 @@ export class CommerceModule extends ModuleBase {
options?:
| number
| {
+ /**
+ * The minimum price.
+ *
+ * @default 1
+ */
min?: number;
+ /**
+ * The maximum price.
+ *
+ * @default 1000
+ */
max?: number;
+ /**
+ * The number of decimal places.
+ *
+ * @default 2
+ */
dec?: number;
+ /**
+ * The currency value to use.
+ *
+ * @default ''
+ */
symbol?: string;
},
legacyMax?: number,
@@ -213,7 +233,7 @@ export class CommerceModule extends ModuleBase {
/**
* Generates a price between min and max (inclusive).
*
- * @param options The minimum price or on options object. Defaults to `{}`.
+ * @param options The minimum price or on options object.
* @param options.min The minimum price. Defaults to `1`.
* @param options.max The maximum price. Defaults to `1000`.
* @param options.dec The number of decimal places. Defaults to `2`.
@@ -330,7 +350,7 @@ export class CommerceModule extends ModuleBase {
/**
* Returns a random [ISBN](https://en.wikipedia.org/wiki/ISBN) identifier.
*
- * @param options The variant to return or an options object. Defaults to `{}`.
+ * @param options The variant to return or an options object.
* @param options.variant The variant to return. Can be either `10` (10-digit format)
* or `13` (13-digit format). Defaults to `13`.
* @param options.separator The separator to use in the format. Defaults to `'-'`.