Saltar al contingut
nif-dni-nie-cif-validation

Referència de l'API

La referència es genera a partir del JSDoc del codi font de la biblioteca cada vegada que es construeix el lloc web, de manera que sempre coincideix amb el codi. Té una pàgina per a cada punt d’entrada del paquet, amb totes les seves exportacions: la signatura, què volen dir cada paràmetre i el valor retornat, dos exemples que executen els tests de la biblioteca, la regla de SPEC que segueix i la versió que la va afegir.

Els punts d'entrada del paquet i què exporta cadascun
Punt d'entradaQuè exporta
nif-dni-nie-cif-validationEls validadors, validate(), normalize(), format(), getNifType(), computeControlCharacter(), describeCifOrganisation(), les constants de la v1 i els tipus. Inclou els missatges en anglès.
nif-dni-nie-cif-validation/locales/enL'objecte d'idioma en anglès, que es passa com a locale a validate(), a describeCifOrganisation() i als esquemes.
nif-dni-nie-cif-validation/locales/esL'objecte d'idioma en castellà, que es passa com a locale a validate(), a describeCifOrganisation() i als esquemes.
nif-dni-nie-cif-validation/locales/caL'objecte d'idioma en català (també per al valencià), que es passa com a locale a validate(), a describeCifOrganisation() i als esquemes.
nif-dni-nie-cif-validation/locales/euL'objecte d'idioma en basc, que es passa com a locale a validate(), a describeCifOrganisation() i als esquemes.
nif-dni-nie-cif-validation/locales/glL'objecte d'idioma en gallec, que es passa com a locale a validate(), a describeCifOrganisation() i als esquemes.
nif-dni-nie-cif-validation/generateGeneradors amb llavor de números vàlids i no vàlids, per a tests. El punt d'entrada principal no els importa mai.
nif-dni-nie-cif-validation/zodEsquemes de Zod 4 per a tots els tipus i per al NIF-IVA. Zod és una dependència peer opcional.
nif-dni-nie-cif-validation/valibotEsquemes de Valibot 1 per a tots els tipus i per al NIF-IVA. Valibot és una dependència peer opcional.
nif-dni-nie-cif-validation/yupEsquemes de Yup 1 per a tots els tipus i per al NIF-IVA. Yup és una dependència peer opcional.

El vostre editor mostra la mateixa documentació mentre escriviu, a partir de les declaracions de tipus que inclou el paquet.

Com llegir la referència

Secció titulada «Com llegir la referència»
  • Opcions. Els validadors reben IsValidOptions, validate() rep ValidateOptions i els esquemes reben les opcions de validate(). El valor per defecte i l’efecte de cada opció són a la pàgina del punt d’entrada principal.
  • Regles. Els enllaços a identificadors de regles, com DNI-2, obren la pàgina de fonts oficials.
  • Àlies. isValidCif i isValidLegalEntityNif són la mateixa funció, com ho són isValidCifControlCode i isValidLegalEntityNifControlCode; CIF_REGEX i LEGAL_ENTITY_NIF_REGEX, i CIF_CONTROL_LETTERS i LEGAL_ENTITY_CONTROL_LETTERS, són la mateixa constant.
  • Obsoleta. replaceNieLetter es manté per al codi de la versió 1. Llança una excepció amb una entrada incorrecta, a diferència dels validadors i les altres funcions (els generadors també llancen un RangeError quan les seves opcions són impossibles).

Les decisions darrere de l’API són a docs/api-design.md (en anglès).