Package Exports

validate-rfc

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (validate-rfc) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Validate RFC

Una librería sencilla y ligera para validar RFCs Mexicanos (Registro Federal de Contribuyentes).

Instalación

Usa NPM o YARN:

$ npm install validate-rfc

API

La librería expone una sola función (.validateRfc).

.validateRfc(rfc)

Valida que un string sea un RFC válido y entrega detalles sobre la validación.

Parámetros

Parámetro	Tipo	Descripción
`rfc`	String	El RFC a validar.

Respuesta

Regresa un objeto plano con los siguientes valores:

Parámetro	Tipo	Descripción
`isValid`	Boolean	Indica es el string ingresado es un RFC válido.
`rfc`	String	El RFC formateado (en mayúsculas, sin espacios ni simbolos). Regresa `null` en caso de que el RFC sea inválido.
`type`	String	El tipo del RFC ingresado. Los valores pueden ser `person` para personas físicas o `company` para personas morales. Regresa `null` en caso de que el RFC sea inválido.
`errors`	Array[String]	En caso de que el RFC no sea válido, aquí se indican los motivos por los que no fue válido.

Los posibles valores que puede contener el array errors y su descripción son:

Error	Descripción
`INVALID_FORMAT`	El formato es inválido, es decir, no cuenta con la longitud o estructura de caracteres esperado. Ej: `XYZ` porque claramente no es un RFC.
`INVALID_DATE`	El string tiene el formato adecuado, pero los dígitos para la fecha generan una fecha inválida. Ej: `MHTR815511A70` porque refiere al mes `55`.
`INVALID_VERIFICATION_DIGIT`	String

Ejemplo

const validateRfc = require('validate-rfc');

const response = validateRfc('mhtr93041179a');
console.log(response);

/*
Imprime:

{
  isValid: true,
  rfc: 'MHTR93041179A',
  type: 'person'
}

*/

const response = validateRfc('Este no es un RFC');
console.log(response);

/*
Imprime:

{
  isValid: false,
  rfc: null,
  type: null,
  errors: ['INVALID_FORMAT']
}

*/

Pruebas

Para correr las pruebas ejecuta el comando:

$ npm test

Licencia

MIT