@projetoacbr/acbrlib-cep-node
v1.0.7
Published
classe de alto nivel para carregar a acbrlibcep
Downloads
32
Readme
@projetoacbr/acbrlib-cep-node
📋 Descrição
ACBrLib CEP Node é uma implementação para consulta de CEP usando a biblioteca ACBrLibCEP. Esta classe fornece uma interface de alto nível para buscar informações de endereços através de CEPs, permitindo validação e consulta de logradouros.
🏗️ Arquitetura
Esta classe (ACBrLibCepMT) estende diretamente ACBrLibBaseMT e implementa métodos específicos para consulta de CEP.
📦 Instalação
npm install @projetoacbr/acbrlib-cep-node📖 Como Usar
🎯 Importação
📝 TypeScript (Recomendado)
// Importa a classe ACBrLibCepMT oficial conforme documentação
import ACBrLibCepMT from "@projetoacbr/acbrlib-cep-node/dist/src";⚙️ Configuração tsconfig.json recomendada:
{
"compilerOptions": {
"target": "es2022",
"module": "commonjs",
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"forceConsistentCasingInFileNames": true
}
}🔧 JavaScript/CommonJS
const ACBrLibCepMT = require('@projetoacbr/acbrlib-cep-node/dist/src').default🔧 Uso Básico
TypeScript
const acbrCep = new ACBrLibCepMT(
'./libacbrcep64.so', // Linux
// './ACBrCEP64.dll', // Windows
'./acbrlib.ini',
'12345678'
)JavaScript/CommonJS
const acbrCep = new ACBrLibCepMT(
'./libacbrcep64.so', // Linux
// './ACBrCEP64.dll', // Windows
'./acbrlib.ini',
'12345678'
)
// Inicializar a biblioteca
acbrCep.inicializar()
// Buscar por CEP
const endereco = acbrCep.buscarPorCep('18270-170')
console.log('Endereço:', endereco)🔧 Funcionalidades
Métodos Herdados (Base)
inicializar(),finalizar()configLer(),configGravar()nome(),versao()ultimoRetorno()
Métodos Específicos do CEP
Consulta de CEP
buscarPorCep(cep)- Busca informações de endereço por CEP
Validação
- Validação automática de formato de CEP
- Tratamento de erros de CEP inválido
🔗 Dependências
- @projetoacbr/acbrlib-base-node - Classe base fundamental
📚 Documentação
Para informações detalhadas sobre cada método, consulte a documentação JSDoc incluída no código fonte.
🤝 Contribuição
- Fork o projeto
- Crie uma branch para sua feature
- Commit suas mudanças
- Push para a branch
- Abra um Pull Request
📞 Suporte
- Issues: GitHub Issues
- Documentação ACBrLib: https://acbr.sourceforge.io/ACBrLib/BemVindo.html
📄 Licença
LGPL-2.1 License - veja o arquivo LICENSE para detalhes.
ACBrLib CEP Node - Interface Node.js para ACBrLibCEP
Versão: 1.0.6
Desenvolvido por: Projeto ACBr
