feat(currency-number): created helper with docs (#231)

Co-authored-by: Michael Amaral <[email protected]>

README.md

@@ -54,6 +54,7 @@ import { isIOS } from '@platformbuilders/helpers/native'
 | [`getTheme`](./docs/getTheme.md)                   | string          | (themeProp)({ theme })         |
 | [`ifStyle`](./docs/ifStyle.md)                     | truthy OR falsy | (prop)(truthy, falsy)(style)   |
 | [`parseToThousands`](./docs/parseToThousands.md)   | string          | (value)                        |
+| [`currencyToNumber`](./docs/currencyToNumber.md)   | string          | (value)                        |
 | [`removeWhiteSpaces`](./docs/removeWhiteSpaces.md) | string          | (value)                        |
 | [`switchStyle`](./docs/switchStyle.md)             | string          | (name)(stylesObj)(props)       |
 | [`toOnlyNumbers`](./docs/toOnlyNumbers.md)         | string          | (value)                        |

docs/currencyToNumber.md

@@ -0,0 +1,19 @@
+# `currencyToNumber`
+
+Parse brazilian currency string to number format.
+
+## Arguments
+
+- `currency: string`: currency value to be format
+
+## Returns
+
+- `value: number`: A number
+
+## Usage
+
+```jsx
+import { currencyToNumber } from '@platformbuilders/helpers';
+
+currencyToNumber('R$ 1000,00'); // return 1000
+```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformbuilders/helpers",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "Platfom builders helpers library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/__tests__/currencyToNumber.spec.ts

@@ -0,0 +1,12 @@
+import { currencyToNumber } from '../currencyToNumber';
+
+describe('currencyToNumber tests', () => {
+  it('should parse to thousands', () => {
+    const parsed = currencyToNumber('R$ 1000,00');
+    expect(parsed).toBe(1000);
+  });
+  it('should parse to thousands with decimals', () => {
+    const parsed = currencyToNumber('R$ 1000,10');
+    expect(parsed).toBe(1000.1);
+  });
+});

src/currencyToNumber.ts

@@ -0,0 +1,2 @@
+export const currencyToNumber = (currency: string): number =>
+  parseFloat(currency.replace('R$', '').replace('.', '').replace(',', '.'));

src/index.ts

@@ -7,3 +7,4 @@ export * from './ifStyle';
 export * from './switchStyle';
 export * from './base64';
 export * from './pixelToRem';
+export * from './currencyToNumber';