docs(transloco-locale): add sign display number format option (#671)

jsverse · Aug 1, 2023 · 8270080 · 8270080
1 parent 781a6d3
commit 8270080
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/docs/docs/plugins/locale.mdx b/docs/docs/plugins/locale.mdx
@@ -245,6 +245,7 @@ Note the format option of the global, locale's format and the one's being passed
 - `maximumFractionDigits`- The maximum number of fraction digits to use. Possible values are from 0 to 20 (default is 3).
 - `minimumSignificantDigits`- The minimum number of significant digits to use. Possible values are from 1 to 21 (default is 1).
 - `maximumSignificantDigits`- The maximum number of significant digits to use. Possible values are from 1 to 21 (default is 21).
+- `signDisplay`- When to display the sign for the number. Possible values are "auto", "always", "exceptZero", "negative", "never" (default is "auto").
 
 ## Date Format Options
 

diff --git a/libs/transloco-locale/src/lib/transloco-locale.types.ts b/libs/transloco-locale/src/lib/transloco-locale.types.ts
@@ -30,7 +30,11 @@ export interface NumberFormatOptions {
   /**
    * The maximum number of significant digits to use. Possible values are from 1 to 21
    */
-  maximumSignificantDigits?: number;
+  maximumSignificantDigits?: Intl.NumberFormatOptions['maximumSignificantDigits'];
+  /**
+   * When to display the sign for the number. Possible values are "auto", "always", "exceptZero", "negative", "never"; the default is "auto".
+   */
+  signDisplay?: Intl.NumberFormatOptions['signDisplay'];
 }
 
 /**