README
Popcorn Tools
Installation
$ npm install popcorn-tools --save
How to use
ES6
// to import a specific method
import { measureFormat } from 'popcorn-tools';
// using method
measureFormat(1000);
Methods
Follow the methods that the library provides.
measureFormat(value)
Format numbers according to the unit of measurement.
Arguments
Argument | Type |
---|---|
value |
number |
Example
const data = measureFormat(1000);
validateCpf(cpf)
Valid if the number of a CPF (Individual Taxpayer Registration) is valid.
Arguments
Argument | Type |
---|---|
cpf |
string |
Example
const valid = validateCpf(cpf);
mobileCheck()
checks if the browser is on a mobile device..
Example
const check = mobileCheck();
currencyFormat(data)
Format a number for the desired currency.
Arguments
Argument | Type |
---|---|
value |
number |
style |
string |
currency |
string |
Example
currencyFormat({ currency: 'BRL', style: 'pt-BR', value: 10 })
years(number, number)
Return an array of years.
Arguments
Argument | Type |
---|---|
after |
number |
before |
number |
Example
years(10, 5)
filter(array, value, param)
Filter an array of objects based on a string.
Arguments
Argument | Type |
---|---|
array |
array |
value |
string |
param |
string |
Example
const data = [
{ value: 'Banana' },
{ value: 'Maçã' },
{ value: 'Laranja' },
{ value: 'Morango' },
{ value: 'Abacaxi' },
{ value: 'Mamão' },
];
const dataFilter = filter(data, 'mam', 'value');
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Authors
Denner Rondinely |
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE.md file for details