Interface ParseSuccess<I>

A successful parseIdInfo() call: the ID is valid and info holds what was parsed from it.

interface ParseSuccess<I extends object = ParsedInfo> {
    countryCode: string;
    idNumber: string;
    info: I;
    ok: true;
}

Type Parameters

I extends object = ParsedInfo

Index

Properties

countryCode idNumber info ok

Properties

countryCode

countryCode: string

The resolved ISO 3166-1 alpha-3 code, e.g. 'TWN' for 'tw'.

idNumber

idNumber: string

info

info: I

ok

ok: true