Wondering what’s next for npm?Check out our public roadmap! »

    @lacussoft/cpf-fmt
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.10 • Public • Published

    LacusSoft :: cpf-fmt

    NPM Latest Version Downloads Count Bundle Size Test Status Last Update Date Project License

    Basic function to format CPF strings (Brazilian ID document).

    Browser Support

    Chrome Firefox Safari Opera Edge IE
    Latest Latest Latest Latest Latest 11

    Installation

    $ npm install @lacussoft/cpf-fmt

    Import

    // ES Modules
    import cpfFmt from '@lacussoft/cpf-fmt'
    
    // Common JS
    const cpfFmt = require('@lacussoft/cpf-fmt')

    or import it through your HTML file, using CDN:

    <script src="https://cdn.jsdelivr.net/npm/@lacussoft/cpf-fmt@latest/dist/cpf-fmt.min.js"></script>

    Usage

    const cpf = '47844241055'
    
    cpfFmt(cpf)       // returns '478.442.410-55'
    
    cpfFmt(cpf, {     // returns '478.***.***-**'
      hidden: true
    })
    
    cpfFmt(cpf, {     // returns '478442410_55'
      delimiters: {
        dot: '',
        dash: '_'
      }
    })

    Formatting options

    cpfFmt(cpf, {
      delimiters: {
        dot: '.',       // string to replace the dot characters
        dash: '-',      // string to replace the dash character
      },
      escape: false,    // boolean to define if the result should be HTML escaped
      hidden: false,    // boolean to define if digits should be hidden
      hiddenKey: '*',   // string to replace hidden digits
      hiddenRange: {
        start: 3,       // starting index of the numeric sequence to be hidden (min 0)
        end: 10,        // ending index of the numeric sequence to be hidden (max 10)
      },
      onFail(value) {   // fallback function to be invoked in case a non-11-digits is passed
        return value
      }
    })

    Install

    npm i @lacussoft/cpf-fmt

    DownloadsWeekly Downloads

    24

    Version

    1.0.10

    License

    MIT

    Unpacked Size

    23.6 kB

    Total Files

    10

    Last publish

    Collaborators

    • avatar