mateusandrade / use-cep-hook

Brazilian CEP info on a elegant way! :scream_cat: :mag: :mailbox:

use-cep-hook 🌎

This is a simple React Hooks that let you search for a brazillian postal-code.

Installation

Just run a yarn add use-cep-hook or npm i --save use-cep-hook

How to use

Simply import use-cep-hook on your component, then call this on that way:

import useCep from "use-cep-hook";

const Foo = () => {
  const [postalCode, setPostalCode] = useState("");

  const [loading, cep, error] = useCep(postalCode);

  return (
    <div className="field">
      <label>CEP:</label>
      <input onChange={e => setPostalCode(e.target.value)} value={postalCode} />
    </div>
  );
};

Every time that a valid CEP is passed to this hooks, this will cause a side effect that will search for the updated value.

You can check the full implementation here!

TODO:

• Port to TS
• Apply some cool CSS to example
• Write TESTS!
• Deploy example to GH pages!
• Configure Github Actions

use-cep-hook's Issues

You can use cep-promise

Description

That's actually not an Issue, but rather an suggestion 😬

Right now your hook relies only at ViaCep to reply to it's user, and if there's any outage at ViaCep your hook simply wont work.

In order to solve this you might update your integration to use https://www.npmjs.com/package/cep-promise that will simplify all your logic and also provide integration with:

• ViaCep
• Correios
• WideNet

The module will fetch the data form all providers and return as soon as at least one of the services reply =)

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• chore(deps): update dependency @testing-library/jest-dom to v5.17.0
• chore(deps): update dependency @testing-library/react to v14.1.2
• chore(deps): update dependency eslint to v8.55.0
• chore(deps): update actions/checkout action to v4
• chore(deps): update actions/setup-node action to v4
• chore(deps): update commitlint monorepo to v18 (major) (@commitlint/cli, @commitlint/config-conventional)
• chore(deps): update dependency @testing-library/jest-dom to v6
• chore(deps): update dependency @types/node to v20
• chore(deps): update dependency gh-pages to v6
• chore(deps): update dependency husky to v8
• chore(deps): update dependency lint-staged to v15
• chore(deps): update dependency prettier to v3
• chore(deps): update dependency typescript to v5
• 🔐 Create all rate-limited PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update dependency @types/node to v16.18.68
• chore(deps): update dependency prettier to v2.8.8
• chore(deps): update commitlint monorepo to v17.8.1 (@commitlint/cli, @commitlint/config-conventional)
• chore(deps): update dependency @types/jest to v27.5.2
• chore(deps): update dependency eslint-plugin-react to v7.33.2
• chore(deps): update dependency lint-staged to v12.5.0
• chore(deps): update react monorepo (@types/react, @types/react-dom)
• fix(deps): update dependency cep-promise to v4.4.0
• chore(deps): update dependency @testing-library/user-event to v14
• chore(deps): update dependency @types/jest to v29
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

github-actions

.github/workflows/actions.yml

• actions/checkout v3
• actions/setup-node v2
• actions/cache v3

npm

package.json

• cep-promise ^4.0.0
• @commitlint/cli 17.6.1
• @commitlint/config-conventional 17.6.1
• @testing-library/jest-dom 5.16.5
• @testing-library/react 14.0.0
• @testing-library/user-event 13.5.0
• @types/jest 27.4.1
• @types/node 16.18.21
• @types/react 18.0.31
• @types/react-dom 18.0.11
• eslint 8.36.0
• eslint-plugin-react 7.29.4
• gh-pages 3.2.3
• husky 7.0.4
• lint-staged 12.3.7
• prettier 2.8.7
• react 18.2.0
• react-dom 18.2.0
• react-scripts 5.0.1
• typescript 4.9.5

---

• Check this box to trigger a request for Renovate to run again on this repository