address-br

Módulo de endereços do Brasil

Usage no npm install needed!

<script type="module">
  import addressBr from 'https://cdn.skypack.dev/address-br';
</script>

README

Módulo de endereços brasileiros por CEP

Passe uma CEP no getAddress dentro de uma função assíncrona, e obtenha um objeto no retorno com o endereço.

npm i address-br

Uso

const address = require('address-br')

async function functionName () {
    const address = await getAddress('01210000')

    console.log(address) 
    // returns { cep: '01210000', rua: 'Rua Vitória', bairro: 'Santa Efigênia', cidade: 'São Paulo', estado: 'SP' }
}

Uso ES6

import { getAddress, getStreet, getCityState, getNeighborhood } from 'address-br'

async function functionName () {

    const address = await getAddress('09911000')
    console.log(address) 
    // returns { cep: '09911000', rua: 'Rua São Francisco de Assis', bairro: 'Centro', cidade: 'Diadema', estado: 'SP' }

    const street = await getStreet('09911000')
    console.log(street) 
    // returns { rua: 'Rua São Francisco de Assis' }

    const cityState = await getCityState('09911000')
    console.log(cityState) 
    // returns { cidade: 'Diadema', estado: 'SP' }

    const neighborhood = await getNeighborhood('09911000')
    console.log(neighborhood) 
    // returns { bairro: 'Centro' }

    const formatado = await getAddressFormat('09911000', 232)
    console.log(formatado) 
    // returns 'Rua São Francisco de Assis, 232 - Centro - Diadema - SP - 09911000'
}

License

MIT