Plugin for postalcode
npm install @postalcode/service-viacep#### Plugin for PostalCode
``ts
import PostalCode from "@postalcode/postalcode";
import serviceViacep, { ServiceOptions } from "@postalcode/service-viacep";
const postalCode = new PostalCode({
/ All Postal Code Options/
});
postCode.use
/ All Service Options/
});
viaCep.get("05010000").then(console.log);
// {
// "postalcode": "05010000",
// "state": "SP",
// "city": "São Paulo",
// "street": "Rua Caiubí",
// "neighborhood": "Perdizes",
// }
`
#### Use direct Service.
`js
import ViaCepService from "@postalcode/service-viacep";
const viaCep = new ViaCepService();
viaCep.get("05010000").then(console.log);
// {
// "postalcode": "05010000",
// "state": "SP",
// "city": "São Paulo",
// "street": "Rua Caiubí",
// "neighborhood": "Perdizes",
// }
`
#### Browser using CDN
`html
`
#### npm
``
$ npm install --save @postalcode/service-viacep
#### yarn
``
$ yarn add @postalcode/service-viacep
#### Typescript
`ts
import serviceViacep from "@postalcode/service-viacep";
const viaCep = new serviceViacep();
viaCep.name;
viaCep.type;
viaCep.country;
viaCep.codeLength;
viaCep.get("05010000").then(console.log);
// {
// "postalcode": "05010000",
// "state": "SP",
// "city": "São Paulo",
// "street": "Rua Caiubí",
// "neighborhood": "Perdizes",
// }
``
Read our contribution guide here