APIaren erreferentzia

Erreferentzia liburutegiaren iturburu-kodeko JSDoc-etik sortzen da gunea eraikitzen den bakoitzean; beraz, beti dator bat kodearekin. Paketearen sarrera-puntu bakoitzeko orri bat du, bere esportazio guztiekin: sinadura, parametro bakoitzak eta itzulitako balioak zer esan nahi duten, liburutegiaren probek exekutatzen dituzten bi adibide, jarraitzen duen SPEC araua eta gehitu zuen bertsioa.

Paketearen sarrera-puntuak, eta bakoitzak zer esportatzen duen
Sarrera-puntua	Zer esportatzen duen
`nif-dni-nie-cif-validation`	Egiaztatzaileak, validate(), normalize(), format(), getNifType(), computeControlCharacter(), describeCifOrganisation(), 1. bertsioko konstanteak eta motak. Ingelesezko mezuak barne ditu.
`nif-dni-nie-cif-validation/locales/en`	Hizkuntza-objektua (ingelesa), validate() eta describeCifOrganisation() funtzioei eta eskemei locale gisa pasatzeko.
`nif-dni-nie-cif-validation/locales/es`	Hizkuntza-objektua (gaztelania), validate() eta describeCifOrganisation() funtzioei eta eskemei locale gisa pasatzeko.
`nif-dni-nie-cif-validation/locales/ca`	Hizkuntza-objektua (katalana (valentzierarako ere bai)), validate() eta describeCifOrganisation() funtzioei eta eskemei locale gisa pasatzeko.
`nif-dni-nie-cif-validation/locales/eu`	Hizkuntza-objektua (euskara), validate() eta describeCifOrganisation() funtzioei eta eskemei locale gisa pasatzeko.
`nif-dni-nie-cif-validation/locales/gl`	Hizkuntza-objektua (galegoa), validate() eta describeCifOrganisation() funtzioei eta eskemei locale gisa pasatzeko.
`nif-dni-nie-cif-validation/generate`	Zenbaki baliozko eta baliogabeen sorgailu hazidunak, probetarako. Sarrera-puntu nagusiak ez ditu inoiz inportatzen.
`nif-dni-nie-cif-validation/zod`	Zod 4 eskemak mota guztietarako eta IFZ-BEZerako. Zod aukerako peer mendekotasun bat da.
`nif-dni-nie-cif-validation/valibot`	Valibot 1 eskemak mota guztietarako eta IFZ-BEZerako. Valibot aukerako peer mendekotasun bat da.
`nif-dni-nie-cif-validation/yup`	Yup 1 eskemak mota guztietarako eta IFZ-BEZerako. Yup aukerako peer mendekotasun bat da.

Zure editoreak dokumentazio bera erakusten du idatzi ahala, paketeak dakartzan mota-deklarazioetatik abiatuta.

Nola irakurri erreferentzia

Aukerak. Egiaztatzaileek IsValidOptions jasotzen dute, validate() funtzioak ValidateOptions, eta eskemek validate() funtzioaren aukerak. Aukera bakoitzaren balio lehenetsia eta eragina sarrera-puntu nagusiaren orrian daude.
Arauak. Arau-identifikatzaileetarako estekek, DNI-2 adibidez, iturri ofizialen orria irekitzen dute.
Aliasak. isValidCif eta isValidLegalEntityNif funtzio bera dira, baita isValidCifControlCode eta isValidLegalEntityNifControlCode ere; CIF_REGEX eta LEGAL_ENTITY_NIF_REGEX, eta CIF_CONTROL_LETTERS eta LEGAL_ENTITY_CONTROL_LETTERS, konstante bera dira.
Zaharkitua. replaceNieLetter 1. bertsioko kodearentzat mantentzen da. Salbuespen bat jaurtitzen du sarrera oker batekin, egiaztatzaileek eta gainerako funtzioek ez bezala (sorgailuek ere RangeError bat jaurtitzen dute, aukerak ezinezkoak direnean).

APIaren atzeko erabakiak docs/api-design.md fitxategian daude (ingelesez).