 [](LICENSE) [](https://github.com/ccqueiroz/utils-fn) ##
npm install @utils-fns/validators!npm


The @utils-fns/validators library was developed to be part of a larger library, @utils-fns, which is being developed with the aim of providing unified tools that facilitate the daily tasks of programmers. Our motivation is to simplify common tasks, such as validators, value masking, sorting, search and conversion methods, offering a comprehensive and efficient solution that makes possible the use of this set of libraries in web - mobile - service environments.
To install the @utils-fns/validators library: use your preferred package manager
``javascript
yarn add @utils-fns/validators
or
npm install @utils-fns/validators
`
To access the features, just follow the example:
`javascript`
//ES6
import { validators } from "@utils-fns/validators";`javascript`
//CommomJS
const { validators } = require("@utils-fns/validators");
So, just choose which validation tool will be used.
`javascript`
const cpfValidation = validators.cpf('64912007013')
//return true`$3
@utils-fns/validators` is written in TypeScript with complete definitions.
| cpf | string \| undefined |`javascript
import { validators } from "@utils-fns/validators"; validators.cpf('64912007013')
//âś… return true
validators.cpf('649.120.070-13')
//âś… return true
validators.cpf('01234598329')
//❌ return false
`
Nis Validator
| Method | Params | Type |
|---|---|---|
| nis | nis | string \| undefined |
`javascript
import { validators } from "@utils-fns/validators"; validators.nis('90152083257')
//âś… return true
validators.nis('901.52083.25-7')
//âś… return true
validators.nis('00000000000')
//❌ return false
`
Email Validator
| Method | Params | Type |
|---|---|---|
| email | email | string \| undefined |
| email | paramsEmailValidator.minMaxUserNameEmail.min | number \| undefined |
| email | paramsEmailValidator.minMaxUserNameEmail.max | number \| undefined |
| email | paramsEmailValidator.minMaxEmailDomain.min | number \| undefined |
| email | paramsEmailValidator.minMaxEmailDomain.max | number \| undefined |
| email | paramsEmailValidator.emailDomainName | RegExp \| undefined |`javascript
import { validators } from "@utils-fns/validators"; validators.email({ email: 'foobar@validator.com' })
//âś… return true
validators.email({ email: 'fĂłobar@validatior.com' })
//❌ return false
validators.email({
email: 'foobar@gmail.com',
paramsEmailValidator: {
emailDomainName: RegExp(/(gmail.com|hotmail.com)/)
},
})
//âś… return true
validators.email({
email: 'foobar@validator.com',
paramsEmailValidator: {
emailDomainName: RegExp(/(gmail.com|hotmail.com)/)
},
})
//❌ return false
`
Cnpj Validator
| Method | Params | Type |
|---|---|---|
| cnpj | cnpj | string \| undefined |`javascript
import { validators } from "@utils-fns/validators"; validators.cnpj('22014929000102')
//âś… return true
validators.cnpj('22.014.929/0001-02')
//âś… return true
validators.cnpj('01234569841234')
//❌ return false
`
Phone Validator
| Method | Params | Type |
|---|---|---|
| phone | phone | string \| undefined |
| phone | paramsPhoneValidator.onlyMobilePhoneBR | boolean \| undefined |
| phone | paramsPhoneValidator.canReceiveInternationalNumbers | boolean \| undefined |
| phone | paramsPhoneValidator.customPatternPhone.coutryCode | RegExp |
| phone | paramsPhoneValidator.customPatternPhone.areaStateCode | RegExp |
| phone | paramsPhoneValidator.customPatternPhone.phoneNumber | RegExp |
| phone | paramsPhoneValidator.publicUtilityNumberBR | boolean \| undefined |
| phone | paramsPhoneValidator.numberWithoutCodeAreas | boolean \| undefined |`javascript
import { validators } from "@utils-fns/validators"; validators.phone({ phone: '(63) 92102-2418' })
//âś… return true
validators.phone({ phone: '63921022418' })
//âś… return true
validators.phone({ phone: '988283' })
//❌ return false
validators.phone({ phone: '190', {
publicUtilityNumberBR: true
} })
//âś… return true
validators.phone({ phone: '(11) 99385-3318', {
numberWithoutCodeAreas: true
} })
//❌ return false
validators.phone({ phone: '66934451006', {
canReceiveInternationalNumbers: true,
customPatternPhone: {
coutryCode: RegExp(/66/),
areaStateCode: RegExp(/9{0,1}/),
phoneNumber: RegExp(/([2-9]{1}\d{6,7})$/),
}
}
})
//âś… return true
validators.phone({ phone: '+1 (541) 708-3275', {
canReceiveInternationalNumbers: true
}
})
//âś… return true
`PaymentCard Validator
| Method | Params | Type |
|---|---|---|
| paymentCard | cardNumber | string \| undefined |
| paymentCard.isValid | paramsPaymentCardValidator.validationTypeCard | credit \| debit \| credit-debit \| undefined |
| paymentCard.isValid | paramsPaymentCardValidator.specificBrandCard | american-express \| diners-club \| discover \| elo \| hiper \| hipercard \| jcb \| maestro \| mastercard \| mir \| unionpay \| visa \| visa-electron \| undefined |
| paymentCard.isValid | paramsPaymentCardValidator.customPatternPaymentCard | RegExp \| undefined |
| paymentCard.getData | - | - |`javascript
import { validators } from "@utils-fns/validators"; validators.paymentCard({ cardNumber: '4024 0071 6435 7039' }).getData()
//âś… return {
// bankDigits: '4',
// bankName: 'Visa',
// cardNumber: '4024 0071 6435 7039',
// isValid: true,
// }
validators.paymentCard({ cardNumber: '4024 0071 6435 7039' }).isValid()
//âś… return true
validators.paymentCard({ cardNumber: '4124007164357039' }).isValid({
customPatternPaymentCard: RegExp(/^40-2$/),
})
//âś… return true
validators.paymentCard({ cardNumber: '3014 842898 5841' }).isValid({
specificBrandCard: 'diners-club',
})
//âś… return true
validators.paymentCard({ cardNumber: '3014 842898 5841' }).isValid({
specificBrandCard: 'visa',
})
//❌ return false
`
PaymentSlip Validator
| Method | Params | Type |
|---|---|---|
| paymentSlip | digits | string \| undefined |
| paymentSlip.isValid | paramsPaymentSlipValidator.validByBank | BankCode \| BankName \| undefined |
| paymentSlip.isValid | paramsPaymentSlipValidator.validSegmentType | Taxas Municipais \| Taxas de Saneamento \| Taxas de Energia Elétrica e Gás \| Taxas de Telecomunicações \| Taxas de Órgãos Governamentais \| Taxas de Trânsito \| Uso Exclusivo dos Bancos \| Pagamento de Boletos Bancários \| Outros \| undefined |
| paymentSlip.isValid | paramsPaymentSlipValidator.validByPrice | string \| number \| undefined |
| paymentSlip.isValid | paramsPaymentSlipValidator.validByDate | string \| Date \| undefined |
| paymentSlip.isValid | paramsPaymentSlipValidator.validByTypeOfPaymentSlip | Boleto Bancário | Boleto de Arrecadação \| undefined |
| paymentSlip.isValid | paramsPaymentSlipValidator.validByIfIsBarCodeOrTypeableLine | Cód. Barras \| Linha Digitável \| undefined |
| paymentSlip.getData | - | - |`javascript
import { validators } from "@utils-fns/validators"; validators.paymentSlip({ digits: '65591942700000005000000000442500009390032700' }).getData()
//âś… return {
// bankCode: '655',
// bankName: 'Banco Votorantim S.A.',
// barCodeOrTypeableLine: 'CĂłd. Barras',
// digits: '65591942700000005000000000442500009390032700',
// expirationDate: '30/07/2023',
// price: '5.00',
// segmentPaymentSplip: 'Pagamento de Boletos Bancários',
// typeOfPaymentSlip: 'Boleto Bancário',
// isValid: true,
// }
validators.paymentSlip({ digits: '65591942700000005000000000442500009390032700' }).isValid()
//âś… return true
validators.paymentSlip({ digits: '65591942700000005000000000442500009390032700' }).isValid({
validByTypeOfPaymentSlip: 'Boleto Bancário'
})
//âś… return true
validators.paymentSlip({ digits: '65591942700000005000000000442500009390032700' }).isValid({
validByTypeOfPaymentSlip: 'Boleto de Arrecadação'
})
//❌ return false
validators.paymentSlip({ digits: '84610000000319901090110049617944480805321901' }).isValid({
validByPrice: '31.99',
validSegmentType: 'Taxas de Telecomunicações',
validByIfIsBarCodeOrTypeableLine: 'CĂłd. Barras',
validByTypeOfPaymentSlip: 'Boleto de Arrecadação',
})
//âś… return true
validators.paymentSlip({ digits: '65590000020044250000594059050008194290000006050' }).isValid({
validByBank: '655',
validByDate: '08-01-2023',
validByPrice: 60.5,
validSegmentType: 'Pagamento de Boletos Bancários',
validByIfIsBarCodeOrTypeableLine: 'Linha Digitável',
validByTypeOfPaymentSlip: 'Boleto Bancário',
})
//âś… return true
`
State Registration Validator
| Method | Params | Type |
|---|---|---|
| stateRegistrationValidator | digits | string \| undefined |
| stateRegistrationValidator | uf | AC \| AL \| AP \| AM \| BA \| CE \| DF \| ES \| GO \| MA \| MT \| MS \| MG \| PA \| PB \| PR \| PE \| PI \| RJ \| RN \| RS \| RO \| RR \| SC \| SP \| SE \| TO |`javascript
import { validators } from "@utils-fns/validators"; validators.stateRegistrationValidator({ digits: '746943024', uf: 'PB' })
//âś… return true
validators.stateRegistrationValidator({ digits: '746943024', uf: 'SP' })
//❌ return false
`
Voter Registration Validator
| Method | Params | Type |
|---|---|---|
| voterRegistrationValidation | digits | string \| undefined |`javascript
import { validators } from "@utils-fns/validators"; validators.voterRegistration('613752510213')
//âś… return true
validators.voterRegistration('0123.4567.8901')
//❌ return false
`
Cnh Validator
| Method | Params | Type |
|---|---|---|
| cnh | cnh | string \| undefined |`javascript
import { validators } from "@utils-fns/validators"; validators.cnh('45426105401')
//âś… return true
validators.cnh('703417160228787182')
//❌ return false
`
Renavam Validator
| Method | Params | Type |
|---|---|---|
| renavamValidator | renavam | string \| undefined |`javascript
import { validators } from "@utils-fns/validators"; validators.renavam('08804737318')
//âś… return true
validators.renavam('703417160228787182')
//❌ return false
`Cep Validator
| Method | Params | Type |
|---|---|---|
| cep | cep | string \| undefined |
| cep.isValid | - | - |
| cep.getData | signal | AbortSignal \| null \| undefined |`javascript
import { validators } from "@utils-fns/validators"; validators.cep('01001000').isValid()
//âś… return true
await validators.cep('01001000').getData()
//âś… return {
// estado: 'SĂŁo Paulo',
// uf: 'SP',
// complemento: '- lado Ămpar',
// cep: '01001-000',
// cidade: 'SĂŁo Paulo',
// bairro: 'SĂ©',
// logradouro: 'Praça da Sé',
// enderecoPostal: 'Praça da SĂ©, lado Ămpar, SĂ©, 01001-000, SĂŁo Paulo/SP',
// isValid: true,
// }
``


This API is licensed MIT.