Class NationalID

Iran national ID number (کارت ملی/kart-e-meli) https://en.wikipedia.org/wiki/National_identification_number#Iran,_Islamic_Republic_of

Implements

IdNumberClass

Index

Constructors

Properties

Accessors

Methods

checksum validate checksum validate

Constructors

constructor

new NationalID(): IRN.NationalID

Returns IRN.NationalID

Properties

`Static` `Readonly`METADATA

METADATA: IdMetadata = ...

Accessors

METADATA

get METADATA(): IdMetadata
Metadata for this ID type

Returns IdMetadata
Implementation of IdNumberClass.METADATA
- Defined in countries/irn/nationalId.ts:34

Methods

checksum

checksum(idNumber: string): number | null
Calculate checksum (if applicable)
Parameters
- idNumber: string
Returns number | null
Implementation of IdNumberClass.checksum
- Defined in countries/irn/nationalId.ts:82

validate

validate(idNumber: string): boolean
Validate an ID number
Parameters
- idNumber: string
Returns boolean
Implementation of IdNumberClass.validate
- Defined in countries/irn/nationalId.ts:56

`Static`checksum

checksum(idNumber: string): number | null
Calculate checksum for Iran national ID Algorithm: https://github.com/mohammadv184/idvalidator/blob/main/validate/nationalid/nationalid.go
Parameters
- idNumber: string
Returns number | null
- Defined in countries/irn/nationalId.ts:64

`Static`validate

validate(idNumber: string): boolean
Validate Iran national ID number
Parameters
- idNumber: string
Returns boolean
- Defined in countries/irn/nationalId.ts:48