From acba5b7dd864ee51bc5dbc6861a2d5f3219ed5b2 Mon Sep 17 00:00:00 2001
From: ST-DDT <ST-DDT@gmx.de>
Date: Mon, 5 Feb 2024 09:39:09 +0100
Subject: docs: missing options jsdocs (#2638)

---
 src/modules/finance/index.ts | 15 +++++++++++++++
 src/modules/number/index.ts  |  4 +++-
 2 files changed, 18 insertions(+), 1 deletion(-)

(limited to 'src/modules')

diff --git a/src/modules/finance/index.ts b/src/modules/finance/index.ts
index 111db571..f7a84f74 100644
--- a/src/modules/finance/index.ts
+++ b/src/modules/finance/index.ts
@@ -271,8 +271,23 @@ export class FinanceModule extends ModuleBase {
    * @since 8.0.0
    */
   maskedNumber(options?: {
+    /**
+     * The length of the unmasked number.
+     *
+     * @default 4
+     */
     length?: number;
+    /**
+     * Whether to use surrounding parenthesis.
+     *
+     * @default true
+     */
     parens?: boolean;
+    /**
+     * Whether to prefix the numbers with an ellipsis.
+     *
+     * @default true
+     */
     ellipsis?: boolean;
   }): string;
   /**
diff --git a/src/modules/number/index.ts b/src/modules/number/index.ts
index b4137cce..9e9eb4ed 100644
--- a/src/modules/number/index.ts
+++ b/src/modules/number/index.ts
@@ -134,7 +134,7 @@ export class NumberModule extends SimpleModuleBase {
            * The maximum number of digits to appear after the decimal point, for example `2` will round to 2 decimal points.  Only one of `multipleOf`, `precision` or `fractionDigits` should be passed.
            */
           fractionDigits?: number;
-          /*
+          /**
            * Deprecated alias for `multipleOf`. Only one of `multipleOf`, `precision` or `fractionDigits` should be passed.
            *
            * @deprecated Use `multipleOf` instead.
@@ -156,7 +156,9 @@ export class NumberModule extends SimpleModuleBase {
       min = 0,
       max = 1,
       fractionDigits,
+      // eslint-disable-next-line deprecation/deprecation
       precision,
+      // eslint-disable-next-line deprecation/deprecation
       multipleOf: originalMultipleOf = precision,
       multipleOf = precision ??
         (fractionDigits == null ? undefined : 10 ** -fractionDigits),
-- 
cgit v1.2.3