TON DOCUMENT VALIDATOR
A library of document validation tools.
Getting Started
Install this library through npm or yarn
npm install ton-document-validator
yarn add ton-document-validator
Import into your project
// Es6 import
import * as tdv from 'ton-document-validator'
// Or with commonJs require
const tdv = require('ton-document-validator')
// And you can also import specific modules
import {
isCPF,
isCNPJ,
validateDocument,
maskDocument,
unmaskDocument,
joiDocumentExtend,
joiDocumentSchema
} from 'ton-document-validator'
Module Summary
module.isCPF() |
validate if document cpf is valid |
module.isCNPJ() |
validate if document cnpj is valid |
module.validateDocument() |
get type of document |
module.maskDocument() |
mask document |
module.unmaskDocument() |
unmask document |
module.joiDocumentExtend() |
Joi functions to extend |
module.joiDocumentSchema() |
Schema to use with Joi |
Functions
isCPF
returns if the cpf is valid
import { isCPF } from 'ton-document-validator'
isCPF('08749237004') // true
isCPF('12345678910') // false
isCPF('tafareeeel') // false
isCNPJ
returns if the cnpj is valid.
import { isCNPJ } from 'ton-document-validator'
isCNPJ('98794055000115') // true
isCNPJ('01234567890001') // false
isCNPJ('7 a 1') // false
validateDocument
validate document and return its type
import { validateDocument } from 'ton-document-validator'
validateDocument("82246981069") // cpf
validateDocument("16667721000190") // cnpj
validateDocument("12345678910") // undefined
validateDocument('invalido_parceiro') // undefined
maskDocument
return masked document
import { maskDocument } from 'ton-document-validator'
maskDocument("12345678910") // 123.456.789-10
maskDocument('01234567891234') // 01.234.567/8912-34
maskDocument("invalid_document") // invalid_document
unmaskDocument
return unmasked document
import { unmaskDocument } from 'ton-document-validator'
unmaskDocument("123.456.789-10") // 12345678910
unmaskDocument("01.234.567/8912-34") // 01234567891234
unmaskDocument("hello-world") // helloworld
joiDocumentExtend
New validation features to use with the
Joi
import { joiDocumentExtend } from 'ton-document-validator'
const Joi = require('joi').extend(joiDocumentExtend)
Joi.document().is_cpf() // valid if is cpf
Joi.document().is_cnpj() // valid if is cnpj
Joi.document().is_document() // valid if is cpf or cnpj
joiDocumentSchema
Schema to validate document with schema in
Joi
import {
joiDocumentExtend,
joiDocumentSchema
} from 'ton-document-validator'
const Joi = require('joi').extend(joiDocumentExtend)
const document_schema = joiDocumentSchema(Joi)
const schema = Joi.object({
...document_schema,
})