Class Cedula

constructor

• new Cedula(): DOM.Cedula

  Returns DOM.Cedula

Static ReadonlyMETADATA

METADATA

• get METADATA(): IdMetadata

  Metadata for this ID type

  Returns IdMetadata

checksum

• checksum(idNumber: string): CheckDigit

  Calculate checksum (if applicable)

  Parameters

  • idNumber: string

  Returns CheckDigit

parse

• parse(idNumber: string): CedulaParseResult | null

  Parse ID number (if applicable)

  Parameters

  • idNumber: string

  Returns CedulaParseResult | null

validate

• validate(idNumber: string): boolean

  Validate an ID number

  Parameters

  • idNumber: string

  Returns boolean

Staticchecksum

• checksum(idNumber: string): CheckDigit

  Calculate the expected Luhn check digit from the first 10 digits.

  This is the raw checksum calculation only -- it does not consult the exception list, so it can disagree with a legitimately-valid number. Use Cedula.validate for full validation.

  Parameters

  • idNumber: string

  Returns CheckDigit

Staticparse

• parse(idNumber: string): CedulaParseResult | null

  Parse a Dominican Republic cedula number into its component parts. Returns null when the number fails validation.

  Parameters

  • idNumber: string

  Returns CedulaParseResult | null

Staticvalidate

• validate(idNumber: string): boolean

  Validate a Dominican Republic cedula number.

  A false result means the number failed format/checksum validation -- it does NOT mean "this person does not exist". A small, documented set of legitimately-issued cedulas (including modern 402-series cards) fail the standard Luhn checksum; those are matched against CEDULA_LUHN_EXCEPTION_SET (in ./exceptions.ts) before falling back to Luhn.

  Parameters

  • idNumber: string

  Returns boolean