Popcorn-tools NPM

Popcorn Tools

npm

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');

findOrDefault(value, conditions)

Return a condition value or default value.

Arguments

Argument	Type
`value`	string
`conditions`	object

Example

  const value = 'error';

  const result = findOrDefault(value, {
    success: 'Successs',
    error: 'Error',
    _: 'Default'
  });

  enum MessagePatterns {
    SUCCESS = 'SUCCESS',
    ERROR = 'ERROR'
  }

  const value = 'ERROR';

  const result = findOrDefault(value, {
    [MessagePatterns.SUCCESS]: 'Successs',
    [MessagePatterns.ERROR]: 'Error',
    _: 'Default'
  });

  console.log(result) // Error

  enum MessagePatterns {
    SUCCESS = 'SUCCESS',
    ERROR = 'ERROR'
  }

  const value = 'ERROR_MESSAGE';

  const result = findOrDefault(value, {
    [MessagePatterns.SUCCESS]: 'Successs',
    [MessagePatterns.ERROR]: 'Error',
    _: 'Default'
  });

  console.log(result) // Default

  enum MessagePatterns {
    SUCCESS = 'SUCCESS',
    ERROR = 'ERROR'
  }

  const value = 'ERROR_MESSAGE';

  const result = findOrDefault(value, {
    [MessagePatterns.SUCCESS]: 'Successs',
    [MessagePatterns.ERROR]: 'Error'
  });

  console.log(result) // false

to(promise)

Return an array with result and error.

Arguments

Argument	Type
`promise`	Promise

Example

  const [result, error] = await to(api.getUsers());

toList(list, index)

Return a list with select index.

Arguments

Argument	Type
`list`	Array
`index`	string

Example

  const list = [{ name: 'Itadori', age: 15 }, { name: 'Megumi', age: 15 }];

  const nameList = toList(list, 'name');

  console.log(nameList) // ['Itadori', 'Megumi']