npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

immutable-cpf

v1.4.1

Published

A tiny library to handle CPF (Cadastro de Pessoa Física), a brazilian identification document, in an immutable flavour.

Downloads

14

Readme

Immutable CPF

A tiny library to handle CPF in an immutable flavour.

The CPF (Cadastro de Pessoas Físicas, [sepeˈɛfi]; portuguese for "Natural Persons Register") is the Brazilian individual taxpayer registry identification. This number is attributed by the Brazilian Federal Revenue to Brazilians and resident aliens who, directly or indirectly, pay taxes in Brazil.

View on NPM License 🇧🇷

Installation

Use the npm package manager to install Immutable CPF.

npm i immutable-cpf

Usage

The library provides a the CPF class to create immutable instances representing CPF documents. You can create instances with any iterable of digits and format or validate them. See the example:

import { CPF } from 'immutable-cpf';

const cpf = new CPF([3, 1, 6, 7, 5, 7, 4, 5, 5, 0, 1]);

cpf.equals(cpf); // true

cpf.checkValidity(); // true

cpf.format(); // '316.757.455-01'

You can also create instances from strings using the CPF.from method.

import { CPF } from 'immutable-cpf';

const cpfA = new CPF([3, 1, 6, 7, 5, 7, 4, 5, 5, 0, 1]);
const cpfB = CPF.from('316.757.455-01');
const cpfC = CPF.from('3  1  6 7 5  7 4 5  5 0   1   ');

cpfA.equals(cpfB); // true

cpfA.equals(cpfC); // true

The CPF class implements the Evaluable interface and it's suitable to be used along ImmutableJS data structures.

The method CPF.prototype.getValidity returns the validity state of the instance. If you only want to check if the instance is valid or not, see the CPF.prototype.checkValidity method.

import { CPF } from 'immutable-cpf';

const empty = new CPF([]);
empty.checkValidity(); // false, it's empty

const semi = new CPF([3, 1, 6, 7]);
semi.checkValidity(); // false, it's not complete

const invalid = new CPF([3, 1, 6, 7, 5, 7, 4, 5, 5, 1, 2]);
semi.checkValidity(); // false, its check digits fails

const valid = new CPF([3, 1, 6, 7, 5, 7, 4, 5, 5, 0, 1]);
valid.checkValidity(); // true

The library also provides the method CPF.create to generate valid instances with pseudo-random numbers.

import { CPF } from 'immutable-cpf';

const cpf = CPF.create();

cpf.checkValidity(); // true

The default JSON serialization a CPF instance is a string. You can also access it directly calling the CPF.prototype.toJSON.

import { CPF } from 'immutable-cpf';

const user = {s
  name: 'José Silva',
  cpf: new CPF([3, 1, 6, 7, 5, 7, 4, 5, 5, 0, 1]),
};

JSON.stringify(user); // '{"name": "José Silva", "cpf": "31675745501"}'

user.cpf.toJSON(); // '31675745501'

API

See the complete API on the Wiki's page.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT