idnumbers
    Preparing search index...

    Interface CountryValidator<I>

    Interface that all country validators must implement.

    I is the type parse() returns for a valid ID. Validators built from a country module keep that module's parse result type (#123); the registry hands them out as CountryValidator (i.e. ParsedInfo), whose fields read as unknown.

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

    Type Parameters

    Index
    METADATA: IdMetadata
    • Parameters

      • idNumber: string

      Returns number | boolean | null

    • Parameters

      • idNumber: string

      Returns I | null

    • Parameters

      • idNumber: string

      Returns boolean