Referencia de la API

La referencia se genera a partir del JSDoc del código fuente de la librería cada vez que se construye el sitio, así que siempre coincide con el código. Tiene una página por cada punto de entrada del paquete, con todas sus exportaciones: su firma, qué significan cada parámetro y el valor devuelto, dos ejemplos que ejecutan los tests de la librería, la regla de SPEC que sigue y la versión que la añadió.

En inglés

Las páginas de la referencia están en inglés, porque su texto es el JSDoc del código. Las guías, en cambio, están en español: empieza por Primeros pasos si buscas una introducción.

Los puntos de entrada del paquete y qué exporta cada uno

Punto de entrada	Qué exporta
nif-dni-nie-cif-validation	Los validadores, validate(), normalize(), format(), getNifType(), computeControlCharacter(), describeCifOrganisation(), las constantes de la v1 y los tipos. Incluye los mensajes en inglés.
nif-dni-nie-cif-validation/locales/en	El objeto de idioma en inglés, que se pasa como locale a validate(), a describeCifOrganisation() y a los esquemas.
nif-dni-nie-cif-validation/locales/es	El objeto de idioma en español, que se pasa como locale a validate(), a describeCifOrganisation() y a los esquemas.
nif-dni-nie-cif-validation/locales/ca	El objeto de idioma en catalán (también para el valenciano), que se pasa como locale a validate(), a describeCifOrganisation() y a los esquemas.
nif-dni-nie-cif-validation/locales/eu	El objeto de idioma en euskera, que se pasa como locale a validate(), a describeCifOrganisation() y a los esquemas.
nif-dni-nie-cif-validation/locales/gl	El objeto de idioma en gallego, que se pasa como locale a validate(), a describeCifOrganisation() y a los esquemas.
nif-dni-nie-cif-validation/generate	Generadores con semilla de números válidos y no válidos, para tests. El punto de entrada principal nunca los importa.
nif-dni-nie-cif-validation/zod	Esquemas de Zod 4 para todos los tipos y para el NIF-IVA. Zod es una dependencia peer opcional.
nif-dni-nie-cif-validation/valibot	Esquemas de Valibot 1 para todos los tipos y para el NIF-IVA. Valibot es una dependencia peer opcional.
nif-dni-nie-cif-validation/yup	Esquemas de Yup 1 para todos los tipos y para el NIF-IVA. Yup es una dependencia peer opcional.

Tu editor muestra la misma documentación mientras escribes, a partir de las declaraciones de tipos que incluye el paquete.

Cómo leer la referencia

• Opciones. Los validadores reciben IsValidOptions, validate() recibe ValidateOptions y los esquemas reciben las opciones de validate(). El valor por defecto y el efecto de cada opción están en la página del punto de entrada principal.
• Reglas. Los enlaces a identificadores de reglas, como DNI-2, abren la página de fuentes oficiales.
• Alias. isValidCif e isValidLegalEntityNif son la misma función, como lo son isValidCifControlCode e isValidLegalEntityNifControlCode; CIF_REGEX y LEGAL_ENTITY_NIF_REGEX, y CIF_CONTROL_LETTERS y LEGAL_ENTITY_CONTROL_LETTERS, son la misma constante.
• Obsoleta. replaceNieLetter se mantiene para el código de la versión 1. Lanza una excepción con una entrada incorrecta, a diferencia de los validadores y las demás funciones (los generadores también lanzan un RangeError cuando sus opciones son imposibles).

Las decisiones detrás de la API están en docs/api-design.md (en inglés).