Kommentarer

Author: frodehansen2

packages/sif-common-formik-ds/src/utils/numberInputUtils.ts

@@ -1,6 +1,7 @@
 import { IntlShape } from 'react-intl';
 import { TextFieldFormatter } from '../components/formik-text-field/FormikTextField';
 
+/* Returns a number from a string value, if the string value is a valid number */
 export const getNumberFromNumberInputValue = (inputValue: string | undefined): number | undefined => {
     if (inputValue === undefined || inputValue === '' || Array.isArray(inputValue)) {
         return undefined;
@@ -17,24 +18,26 @@ export const getNumberFromNumberInputValue = (inputValue: string | undefined): n
 
     const cleanedValue = (inputValue || '').trim();
 
-    const hasCommas = cleanedValue.includes(',');
-    const hasDots = cleanedValue.includes('.');
-
-    if (hasCommas && hasDots) {
+    /** Return undefined if both comma and dots are present  */
+    if (cleanedValue.includes(',') && cleanedValue.includes('.')) {
         return undefined;
     }
 
+    /** Return undefined if spaces are present, and they are not in a valid thousand separator format 00 000 000 */
     if (cleanedValue.includes(' ')) {
         const parts = cleanedValue.split(' ');
+        /** First part has to contain less than 4 digits */
         if (parts[0].length > 3) {
             return undefined;
         }
+        /** All the rest has to contain 3 digits */
         const rest = parts.slice(1);
         if (rest.some((part) => part.length !== 3)) {
             return undefined;
         }
     }
 
+    /** Replace comma with dot, and remove spaces */
     const value = `${cleanedValue}`.replace(/,/g, '.').replace(/\s/g, '');
     const numValue = Number(value);
     if (isNaN(numValue)) {
@@ -43,15 +46,18 @@ export const getNumberFromNumberInputValue = (inputValue: string | undefined): n
     return numValue;
 };
 
+/** To be deprecated */
 export const getStringForNumberInputValue = (value?: number): string => {
     return value === undefined ? '' : `${value}`.replace(/\./g, ',');
 };
 
 export const getNumberInputFormatter = (intl: IntlShape): TextFieldFormatter => ({
+    /** Formats a number string value to norwegian format 1 000 000,0 */
     applyFormatting: (value: string): string => {
         const numValue = getNumberFromNumberInputValue(value);
         return numValue !== undefined ? intl.formatNumber(numValue) : value;
     },
+    /** Removes all formatting from a number string value */
     clearFormatting: (value: string): string => {
         const numValue = getNumberFromNumberInputValue(value);
         return numValue !== undefined ? getStringForNumberInputValue(numValue) : value;