Interface IdNumberClass<I>

Base interface for ID number classes.

I is the type parse() returns for a valid ID (#123).

interface IdNumberClass<I extends object = ParsedInfo> {
    METADATA: IdMetadata;
    checksum?(idNumber: string): number | boolean | null;
    parse?(idNumber: string): I | null;
    validate(idNumber: string): boolean;
}

Type Parameters

I extends object = ParsedInfo

Index

Properties

Methods

checksum? parse? validate

Properties

`Readonly`METADATA

METADATA: IdMetadata

Metadata for this ID type

Methods

`Optional`checksum

checksum?(idNumber: string): number | boolean | null
Calculate checksum (if applicable)
Parameters
- idNumber: string
Returns number | boolean | null
- Defined in types.ts:68

`Optional`parse

parse?(idNumber: string): I | null
Parse ID number (if applicable)
Parameters
- idNumber: string
Returns I | null
- Defined in types.ts:70

validate

validate(idNumber: string): boolean
Validate an ID number
Parameters
- idNumber: string
Returns boolean
- Defined in types.ts:66