Giter Club home page Giter Club logo

another-utils-lib's Introduction

Another Utils Library

This package was born with the plan of solving only one mans problem (the author), but it can, of course be of your interest.

Feel free to use, star, fork, make pull requests, appoint issues, and all that sort of stuff.

Summary

Installation

With npm
npm install another-utils-lib --save

Or if you're using yarn
yarn add another-utils-lib

in the following you'll see the library documentation.

Documentation

API References for the package.

BR (Brazilian Utils)

const utils = require('another-utils-lib/br');

On this part you can find utilities for CPF, CNPJ (as listed below)

CPF

Generate CPF

const { CPF } = require('another-utils-lib/br');

CPF.generate([formatOption]);

Check format options.

Validate CPF

const { CPF } = require('another-utils-lib/br');

CPF.validate('123.456.789-01');

Note: characters like ., -, and space are allowed.

Format CPF

const { CPF } = require('another-utils-lib/br');

CPF.format('123.456.789-01', [formatOption]);

Check format options.

Format options

  • Default
const { CPF } = require('another-utils-lib/br');

CPF.format('123.456.789-01');

Returns a CPF with the format XXX.XXX.XXX-XX

  • Digits
const { CPF } = require('another-utils-lib/br');

CPF.format('123.456.789-01', 'digits');

Returns a CPF with the format XXXXXXXXXXX

  • Checker
const { CPF } = require('another-utils-lib/br');

CPF.format('123.456.789-01', 'checker');

Returns a CPF with the format XXXXXXXXX-XX

CNPJ

Validate CNPJ

const { CNPJ } = require('another-utils-lib/br');

CNPJ.validate('23.655.393/0001-77');

Note: characters like ., - and space are allowed.

E-mail

Validate e-mail

const { validateEmail } = require('another-utils-lib');

validateEmail('[email protected]');

Contribution guidelines

  • Fork it!
  • Create your feature branch: git checkout -b my-new-feature
  • Commit your changes: git commit -m 'Add some feature'
  • Push to the branch: git push origin my-new-feature
  • Submit a pull request

License

This package in under the MIT License.


Made with ❤️ by Bruno De Masi

another-utils-lib's People

Contributors

brunodmsi avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.