Skip to content

Latest commit

 

History

History
137 lines (116 loc) · 4.72 KB

README-pt.md

File metadata and controls

137 lines (116 loc) · 4.72 KB
Raw

@utils-fns/utils-fns

npm License Repository

README versions

Português 🇧🇷 | Inglês 🇺🇸

A biblioteca @utils-fns/utils-fns está sendo desenvolvida com o objetivo de fornecer ferramentas unificadas que facilitem as tarefas diárias dos programadores. Nossa motivação é simplificar tarefas comuns, como validadores, mascaramento de valores, classificação, métodos de busca e conversão, oferecendo uma solução abrangente e eficiente e possibilitando a utilização desse conjunto de bibliotecas em ambientes web - mobile - serviços.

✨ Features

Validators: A biblioteca @utils-fns/validators fornece os seguintes validadores:

  • cpfValidator
  • nisValidator
  • emailValidator
  • cnpjValidator
  • phoneValidator
  • paymentCardValidator (luhn algorithm)
  • paymentSlipValidator (ITF-14)
  • stateRegistrationValidator (inscrição estadual - BR)
  • voterRegistrationValidation (título de eleitor - BR)
  • cnhValidator
  • renavamValidator
  • cepValidator (cep - BR)

Link para documentação do módulo @utils-fns/validators: https://github.com/ccqueiroz/utils-fns/blob/main/packages/validators/README-pt.md

Mask: A biblioteca @utils-fns/mask fornece as seguintes máscaras:

  • cpf
  • nis
  • cnpj
  • date
  • paymentSlip
  • phone
  • renavam
  • cnh
  • voterRegister
  • cep
  • generic masks
  • numbers

Link to module documentation @utils-fns/mask: https://github.com/ccqueiroz/utils-fns/blob/main/packages/mask/README-pt.md

Utils: A biblioteca @utils-fns/utils fornece os seguintes utilitários:

Módulo em construção

  • Data List Cities (BR)
  • Data List States (BR)
  • Data List Countries
  • Lunh Algorithm
  • Lunh Algorithm Mod10
  • Lunh Algorithm Mod11
  • Payment Card Data List
  • Normalize Words
  • Sorting Algorithms
    • Bubble Sort
    • Merge Sort
    • Quick Sort
    • Heap Sort
    • Alphanumeric Sort
    • Heap
    • Selection
    • Bubble
    • Merge
  • Searching Algorithms
    • Binary Search
    • Breadth-First
    • Depth-First
    • Exponential Search
    • Heap Sort
  • Generate File Hash
  • converter base64
  • unConverter base64
  • Params serializer
  • PrintPDF
  • Blob dowload
  • Generate Password
  • Convert Hex To RGB
  • Add Opacity In Color Rgb

Link para documentação do módulo @utils-fns/utils: https://github.com/ccqueiroz/utils-fns/blob/main/packages/utils/README-pt.md

🖥 Ambientes Suportados

  • Aplicativos com javascript ES6 ou superior
    • Browsers modernos
    • Server-side
    • Electron
    • Mobile

📦 Instalação

Para instalar a biblioteca @utils-fns/utils-fns: utilize o gerenciador de pacotes da sua preferência

  yarn add @utils-fns/utils-fns

  ou

  npm install @utils-fns/utils-fns

🔨 Como utilizar

Para acessar as features, basta seguir o exemplo:

  //ES6
  import { validators, utils, mask } from "@utils-fns/utils-fns";
  //CommomJS
  const { validators, utils, mask } = require("@utils-fns/utils-fns");

Assim, basta escolher qual ferramenta de validação será utilizada.

  const cpfValidation = validators.cpf('64912007013')
  //return true

Typescript

@utils-fns/utils-fns é escrito em TypeScript com definições completas.

Autor


Caio Queiroz

Linkedin Badge Gmail Badge

Licença

Esta Api esta sob a licença MIT.