JSPM

brjs

0.1.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 5
  • Score
    100M100P100Q28766F
  • License MIT

Validador de strings para formatos e padrões brasileiros

Package Exports

  • brjs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (brjs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

br.js

[Em desenvolvimento] Validador de strings para formatos e padrões brasileiros

Build Status js-standard-style

Por quê ?

É cansativo e trabalhoso ter que buscar e utilizar libs separadas para validações e utilizações de padrões brasileiros, como cpf, cnpj, cep, números de telefone, etc. Embora este módulo não seja uma novidade, pois você vai encontrar libs separadas que fazem validações do tipo, a proposta aqui é unificar as validações comuns de padrões brasileiros em um único módulo, afim de poupar tempo buscando e utilizando diferentes módulos no seu projeto.

Instalação

Npm:

npm install brjs --save

Validadores

Validadores disponíveis:

Validador Descrição
cep.isValid(str) Verifica se string é um CEP válido com ou sem "-"
phoneNumber.isValid(str) Verifica se string é um número de celular válido com DDD

Exemplos de Validadores:

var br = require('brjs')

/* CEP */
br.cep.isValid('60135-222')
//=> true

br.cep.isValid('60135222')
//=> true

// Com tamanho de string inválido
br.cep.isValid('6013522')
//=> false

/* Número de Celular */
br.phoneNumber.isValid('85998283344')
//=> true

// Com tamanho de string inválido
br.phoneNumber.isValid('8599828334')
//=> false

// Com números repetidos
br.phoneNumber.isValid('85999999999')
//=> false

// Com DDD inválido
br.phoneNumber.isValid('1099828334')
//=> false

Utilitários

Lista de utilitários disponíveis:

Utilitário Descrição
cep.search(str, function(error, response)) Callback para realizar busca de cep na base dos correios

Exemplos de Utilitários:

var br = require('brjs')

br.cep.search( '60135-222', function(error, response) {
    if(response.statusCode == 200){
      console.log(response.body)
     /*
      => { 
            complemento: 'de 700/701 ao fim',
            bairro: 'Dionisio Torres',
            cidade: 'Fortaleza',
            logradouro: 'Rua Marcondes Pereira',
            estado_info: { 
              area_km2: '148.887,632', codigo_ibge: '23', nome: 'Ceará' 
            },
            cep: '60135222',
            cidade_info: { 
              area_km2: '314,93', codigo_ibge: '2304400' 
            },
              estado: 'CE' 
          }
   */
    } else {
      // Retorna status 404 para cep não localizado
      console.log(response.statusCode)
    }
})

Lista de funcionalidades implementadas e pendentes

Qualquer ajuda é bem-vinda, seja para implementar funcionalidades pendentes ou sugeridas por você.

Validadores Disponíveis

Endereço

  • CEP

Números de telefone celular

  • DDD + Número de telefone

Número de documentos

  • CPF
  • CNPJ
  • RG

Contas bancárias

  • Número de agência
  • Dígito da agência
  • Conta corrente
  • Dígito da conta corrente

Utilitários

  • Busca de CEP na base dos correios

Testes

npm test

Licença

The MIT License