Referencia da API

A referencia xérase a partir do JSDoc do código fonte da biblioteca cada vez que se constrúe o sitio, así que sempre coincide co código. Ten unha páxina por cada punto de entrada do paquete, con todas as súas exportacións: a súa sinatura, que significan cada parámetro e o valor devolto, dous exemplos que executan as probas da biblioteca, a regra de SPEC que segue e a versión que a engadiu.

En inglés

As páxinas da referencia están en inglés, porque o seu texto é o JSDoc do código. As guías, en cambio, están en galego: comece por Primeiros pasos se busca unha introdución.

Os puntos de entrada do paquete e que exporta cada un

Punto de entrada	Que exporta
nif-dni-nie-cif-validation	Os validadores, validate(), normalize(), format(), getNifType(), computeControlCharacter(), describeCifOrganisation(), as constantes da v1 e os tipos. Inclúe as mensaxes en inglés.
nif-dni-nie-cif-validation/locales/en	O obxecto de idioma en inglés, que se pasa como locale a validate(), a describeCifOrganisation() e aos esquemas.
nif-dni-nie-cif-validation/locales/es	O obxecto de idioma en castelán, que se pasa como locale a validate(), a describeCifOrganisation() e aos esquemas.
nif-dni-nie-cif-validation/locales/ca	O obxecto de idioma en catalán (tamén para o valenciano), que se pasa como locale a validate(), a describeCifOrganisation() e aos esquemas.
nif-dni-nie-cif-validation/locales/eu	O obxecto de idioma en éuscaro, que se pasa como locale a validate(), a describeCifOrganisation() e aos esquemas.
nif-dni-nie-cif-validation/locales/gl	O obxecto de idioma en galego, que se pasa como locale a validate(), a describeCifOrganisation() e aos esquemas.
nif-dni-nie-cif-validation/generate	Xeradores con semente de números válidos e non válidos, para probas. O punto de entrada principal nunca os importa.
nif-dni-nie-cif-validation/zod	Esquemas de Zod 4 para todos os tipos e para o NIF-IVE. Zod é unha dependencia peer opcional.
nif-dni-nie-cif-validation/valibot	Esquemas de Valibot 1 para todos os tipos e para o NIF-IVE. Valibot é unha dependencia peer opcional.
nif-dni-nie-cif-validation/yup	Esquemas de Yup 1 para todos os tipos e para o NIF-IVE. Yup é unha dependencia peer opcional.

O seu editor mostra a mesma documentación mentres escribe, a partir das declaracións de tipos que inclúe o paquete.

Como ler a referencia

• Opcións. Os validadores reciben IsValidOptions, validate() recibe ValidateOptions e os esquemas reciben as opcións de validate(). O valor predeterminado e o efecto de cada opción están na páxina do punto de entrada principal.
• Regras. As ligazóns a identificadores de regras, como DNI-2, abren a páxina de fontes oficiais.
• Alias. isValidCif e isValidLegalEntityNif son a mesma función, como o son isValidCifControlCode e isValidLegalEntityNifControlCode; CIF_REGEX e LEGAL_ENTITY_NIF_REGEX, e CIF_CONTROL_LETTERS e LEGAL_ENTITY_CONTROL_LETTERS, son a mesma constante.
• Obsoleta. replaceNieLetter mantense para o código da versión 1. Lanza unha excepción cunha entrada incorrecta, a diferenza dos validadores e das demais funcións (os xeradores tamén lanzan un RangeError cando as súas opcións son imposibles).

As decisións detrás da API están en docs/api-design.md (en inglés).