npm promotes metadefinitions

    cpf-check
    TypeScript icon, indicating that this package has built-in type declarations

    3.0.0 • Public • Published

    cpf-check

    Gerador, validador e formatador de CPF que roda tanto no navegador quanto no servidor. Super pequeno, apenas 447 Bytes gzipped.

    Build Status Coverage Status npm version npm downloads per month

    (README available in english in README-en).

    Instalação

    Instale a última versão do cpf-check:

    npm install cpf-check --save
    

    Agora é só usá-lo no seu index.html

    <script type="text/javascript" src="./node_modules/cpf-check/dist/index.umd.js"></script>
    // window.CPF

    Ou importa-lo como um módulo:

    const CPF = require('cpf-check');
     
    // ou, em ES6+
     
    import CPF from 'cpf-check';

    Esse módulo é compativel com o padrão UMD, portanto é compatível com o RequireJs, AMD, CommonJs 1 e 2, etc.

    API & Uso.

    CPF.validate();

    Assinatura do método:

    validate(algumCpfany)boolean;
    import CPF, { validate } from 'cpf-check';
     
    const algumCpf = '676.754.677-10';
     
    CPF.validate(algumCpf);
    // « true
     
    validate(algumCpf);
    // « true
     
    validate('não-cpf');
    // « false
     
    validate('12345678910');
    // « false

    CPF.generate();

    Assinatura do método:

    generate(formatar?: boolean)string;

    Esse método gera CPFs válidos.

    import CPF, { generate } from 'cpf-check';
     
    CPF.generate();
    // « '67675467710'
     
    generate(true);
    // « '676.754.677-10'
     
    generate();
    // « '67675467710'

    CPF.format();

    Assinatura do método:

    format(algumCpfany)string;

    Esse método adiciona pontuação a strings de CPFs.

    import CPF, { format } from 'cpf-check';
     
    const meuCpf = '67675467710';
     
    CPF.format(meuCpf);
    // « '676.754.677-10'
     
    format(meuCpf);
    // « '676.754.677-10'
     
    format('não-cpf');
    // « ''

    CPF.strip();

    Assinatura do método:

    strip(algumCpfany)string;

    Esse método retira caracteres não numéricos de uma string.

    import CPF, { strip } from 'cpf-check';
     
    const algumCpf = '676.754.677-10';
     
    CPF.strip(algumCpf);
    // « '67675467710'
     
    strip(algumCpf);
    // « '67675467710'

    Copyright e Licença

    Copyright (c) 2019 Marcel de Oliveira Coelho sob a Licença MIT. Go Crazy. 🚀

    Install

    npm i cpf-check

    DownloadsWeekly Downloads

    871

    Version

    3.0.0

    License

    MIT

    Unpacked Size

    13.2 kB

    Total Files

    9

    Last publish

    Collaborators

    • husscode