@utils-fns/utils-fns

README versions

Portuguese 🇧🇷 | English 🇺🇸

The @utils-fns/utils-fns library is being developed with the aim of providing unified tools that facilitate programmers' daily tasks. Our motivation is to simplify common tasks, such as validators, value masking, classification, search and conversion methods, offering a comprehensive and efficient solution and making it possible to use this set of libraries in web - mobile - service environments.

✨ Features

Validators: The @utils-fns/validators library provides the following validators:

• <input checked="" disabled="" type="checkbox"> cpfValidator
• <input checked="" disabled="" type="checkbox"> nisValidator
• <input checked="" disabled="" type="checkbox"> emailValidator
• <input checked="" disabled="" type="checkbox"> cnpjValidator
• <input checked="" disabled="" type="checkbox"> phoneValidator
• <input checked="" disabled="" type="checkbox"> paymentCardValidator (luhn algorithm)
• <input checked="" disabled="" type="checkbox"> paymentSlipValidator (ITF-14)
• <input checked="" disabled="" type="checkbox"> stateRegistrationValidator (inscrição estadual - BR)
• <input checked="" disabled="" type="checkbox"> voterRegistrationValidation (título de eleitor - BR)
• <input checked="" disabled="" type="checkbox"> cnhValidator
• <input checked="" disabled="" type="checkbox"> renavamValidator
• <input checked="" disabled="" type="checkbox"> cepValidator (cep - BR)

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

Mask: The @utils-fns/mask library provides the following masks:

• <input checked="" disabled="" type="checkbox"> cpf
• <input checked="" disabled="" type="checkbox"> nis
• <input checked="" disabled="" type="checkbox"> cnpj
• <input checked="" disabled="" type="checkbox"> date
• <input checked="" disabled="" type="checkbox"> paymentSlip
• <input checked="" disabled="" type="checkbox"> phone
• <input checked="" disabled="" type="checkbox"> renavam
• <input checked="" disabled="" type="checkbox"> cnh
• <input checked="" disabled="" type="checkbox"> voterRegister
• <input checked="" disabled="" type="checkbox"> cep
• <input checked="" disabled="" type="checkbox"> generic masks
• <input checked="" disabled="" type="checkbox"> numbers

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

Utils: The @utils-fns/utils library provides the following utilities:

Module under construction

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

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

🖥 Supported Environments

• Applications with javascript ES6 or higher
  • Modern Browsers
  • Server-side
  • Electron
  • Mobile

📦 Install

To install the @utils-fns/utils-fns library: use your preferred package manager

  yarn add @utils-fns/utils-fns

  or

  npm install @utils-fns/utils-fns

🔨 How to use

To access the features, just follow the example:

  //ES6
  import { validators, utils, mask } from "@utils-fns/utils-fns";

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

So, just choose which validation tool will be used.

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

Typescript

@utils-fns/utils-fns is written in TypeScript with complete definitions.

Author

_{Caio Queiroz}

Licença

This API is licensed MIT.