Verify CPF

Verify CPF is a TypeScript library designed to validate Brazilian CPFs. It ensures that the CPF is correctly formatted, checks for repeated digits (e.g., 111.111.111-11), validates the number of digits, and confirms whether the CPF is valid or not.

💖 Support This Project / Apoie Este Projeto

If this project has been helpful to you, please consider making a donation to support its ongoing development. Maintaining and improving this package takes time and effort, and your contribution helps ensure we can keep delivering quality solutions to the community.

Se este projeto foi útil para você, considere fazer uma doação para apoiar seu desenvolvimento contínuo. Manter este pacote atualizado e funcional exige tempo e esforço. Sua contribuição ajuda a garantir que possamos continuar fornecendo soluções de qualidade para a comunidade.

👉 Donate Here / Doe Aqui

Even a small contribution makes a big difference. Thank you for helping make this project possible!

Mesmo uma pequena contribuição faz uma grande diferença. Obrigado por ajudar a tornar este projeto possível! 🙏

Why donate? / Por que doar?

• ✅ To help develop new features.

  Para ajudar no desenvolvimento de novos recursos.

• ✅ To maintain compatibility with the latest versions of libraries and tools.

  Para manter a compatibilidade com as últimas versões de bibliotecas e ferramentas.

• ✅ To support a developer who values community contributions.

  Para apoiar um desenvolvedor que acredita na contribuição com a comunidade.

📦 Installation

To install the library, use the following command:

npm install h7-validate-cpf

🚀 Usage

Here's how to use the VerifyCPF class to validate a CPF:

import { VerifyCPF } from "h7-validate-cpf";

const verifyCPF = new VerifyCPF();

console.log(verifyCPF.verifyCPF("12345678909"));
console.log(verifyCPF.verifyCPF("11111111111"));

📖 Features

• Validates CPFs: Checks if the provided CPF is correct.
• Rejects repeated digits: Detects invalid CPFs with all digits the same (e.g., 111.111.111-11).
• TypeScript support: Fully typed and compatible with TypeScript projects.
• Lightweight: A simple and efficient library with no dependencies.

🛠️ How it Works

This library verifies CPFs by:

• Removing all non-numeric characters.
• Calculating the two verification digits based on the CPF algorithm.
• Comparing the calculated verification digits with the input to determine validity.

📜 Example Use Case

Imagine an application where users must provide a valid CPF for authentication or registration. Using this library, you can ensure that only valid CPFs are accepted:

import { VerifyCPF } from "h7-validate-cpf";

const cpf = "12345678909";
const verifyCPF = new VerifyCPF();

if (verifyCPF.verifyCPF(cpf)) {
  console.log("O CPF é válido.");
} else {
  console.log("CPF inválido. Por favor, verifique e tente novamente.");
}

🤝 Contributing

Feel free to contribute to this project by opening issues or submitting pull requests. All contributions are welcome!

👨‍💻 Author

Developed by Herlandio. If you find this library helpful, consider starring the repository on GitHub!

📝 License

This project is licensed under the MIT License. You are free to use, modify, and distribute it as long as you provide proper attribution.