Skip to content

Latest commit

 

History

History
59 lines (41 loc) · 2.42 KB

README.md

File metadata and controls

59 lines (41 loc) · 2.42 KB

Welcome to Platform Builders Helpers

Build Status codecov npm MIT

Welcome to the Platform Builder helpers package here you will find out all the helpers that we use on our projects

Whats the idea of this repository

Its a place that we can share a little bit of our code base and show how we work on our projects with our helpers

How can i use the library?

Just add the library to your project and import it!

  1. Depend on it:
yarn add @platformbuilders/helpers

2. Import:

import { getTheme } from '@platformbuilders/helpers' import { isIOS } from '@platformbuilders/helpers/native'


# Helpers Documentation

## React/JS

| Name                                               | Returns | Arguments                      |
| -------------------------------------------------- | ------- | ------------------------------ |
| [`formatToBase64`](./docs/formatToBase64.md)       | string  | (value)                        |
| [`currencyParser`](./docs/currencyParser.md)       | string  | (value, numberOfDecimalPlaces) |
| [`parseToThousands`](./docs/parseToThousands.md)   | string  | (value)                        |
| [`currencyToNumber`](./docs/currencyToNumber.md)   | string  | (value)                        |
| [`removeWhiteSpaces`](./docs/removeWhiteSpaces.md) | string  | (value)                        |
| [`toOnlyNumbers`](./docs/toOnlyNumbers.md)         | string  | (value)                        |
| [`formatToPhone`](./docs/formatToPhone.md)         | string  | (value)                        |

## React Native

| Name                                                | Returns | Arguments          |
| --------------------------------------------------- | ------- | ------------------ |
| [`isIOS`](./docs/native/isIOS.md)                   | boolean |                    |