@napunda/pix-key-ts

Pix Key Ts

A Pix Key Ts é uma biblioteca para validação, normalização e formatação de chaves Pix no Brasil. Ela suporta CPF, CNPJ, e-mail, telefone e UUID, garantindo conformidade com os padrões do Banco Central. Esta é uma versão otimizada com tipagens typscript da biblioteca pixkey.

Instalação

npm install @napunda/pix-key-ts

Uso

Importe as funções principais da biblioteca:

import { validate, normalize, format } from "@napunda/pix-key-ts";

Validação

A função validate verifica o tipo da chave Pix e retorna um array com os tipos identificados.

validate("123.456.789-09"); // ["cpf"]
validate("[e-mail]"); // ["email"]
validate("[phone]"); // ["phone"]

Normalização

A função normalize remove formatação da chave, deixando-a no formato padrão exigido pelo sistema bancário.

normalize("123.456.789-09"); // "12345678909"
normalize("[phone]"); // "[phone]"

Formatação

A função format aplica a formatação padrão de exibição para cada tipo de chave Pix.

format("12345678909"); // "123.456.789-09"
format("[phone]"); // "(11) 99999-9999"

Testes

A biblioteca inclui testes utilizando o node:test. Para executá-los, use:

npm test

Licença

Esta biblioteca está licenciada sob a Licença MIT.