ts-phonenumber - v2.0.0
    Preparing search index...

    Interface RegionMetadata

    Metadata for a single region/country. Maps to PhoneMetadata in libphonenumber.

    interface RegionMetadata {
        countryCode: number;
        fixedLine?: PhoneNumberDesc;
        formats?: NumberFormat[];
        generalDesc?: PhoneNumberDesc;
        internationalPrefix?: string;
        intlFormats?: NumberFormat[];
        leadingDigits?: RegExp;
        mainCountryForCode?: boolean;
        mobile?: PhoneNumberDesc;
        nationalPrefix?: string;
        nationalPrefixForParsing?: string;
        nationalPrefixTransformRule?: string;
        noInternationalDialling?: PhoneNumberDesc;
        pager?: PhoneNumberDesc;
        personalNumber?: PhoneNumberDesc;
        preferredInternationalPrefix?: string;
        premiumRate?: PhoneNumberDesc;
        regionCode: string;
        sameMobileAndFixedLinePattern?: boolean;
        sharedCost?: PhoneNumberDesc;
        tollFree?: PhoneNumberDesc;
        uan?: PhoneNumberDesc;
        voip?: PhoneNumberDesc;
    }
    Index

    Properties

    countryCode fixedLine? formats? generalDesc? internationalPrefix? intlFormats? leadingDigits? mainCountryForCode? mobile? nationalPrefix? nationalPrefixForParsing? nationalPrefixTransformRule? noInternationalDialling? pager? personalNumber? preferredInternationalPrefix? premiumRate? regionCode sameMobileAndFixedLinePattern? sharedCost? tollFree? uan? voip?

    Properties

    countryCode: number

    Country calling code (e.g., 49 for Germany)

    fixedLine?: PhoneNumberDesc

    Fixed-line/landline number patterns

    formats?: NumberFormat[]

    Number formatting rules for national format

    generalDesc?: PhoneNumberDesc

    General description matching any valid number

    internationalPrefix?: string

    International dialing prefix (e.g., "00")

    intlFormats?: NumberFormat[]

    Number formatting rules for international format

    leadingDigits?: RegExp

    Compiled leading digits pattern to identify this region for shared country codes (prefix match: ^pattern)

    mainCountryForCode?: boolean

    Whether this is the main country for the calling code

    mobile?: PhoneNumberDesc

    Mobile number patterns

    nationalPrefix?: string

    National prefix for domestic dialing (e.g., "0")

    nationalPrefixForParsing?: string

    Pattern for parsing/stripping national prefix

    nationalPrefixTransformRule?: string

    Transform rule for national prefix

    noInternationalDialling?: PhoneNumberDesc

    Numbers that cannot be dialed internationally

    pager?: PhoneNumberDesc

    Pager number patterns (treated as invalid in ts-phonenumber)

    personalNumber?: PhoneNumberDesc

    Personal number patterns (treated as invalid in ts-phonenumber)

    preferredInternationalPrefix?: string

    Preferred international prefix if multiple exist

    premiumRate?: PhoneNumberDesc

    Premium rate number patterns (treated as invalid in ts-phonenumber)

    regionCode: string

    ISO 3166-1 alpha-2 region code (e.g., "DE")

    sameMobileAndFixedLinePattern?: boolean

    Whether mobile and fixed line patterns are identical

    sharedCost?: PhoneNumberDesc

    Shared cost number patterns (treated as invalid in ts-phonenumber)

    tollFree?: PhoneNumberDesc

    Toll-free number patterns (treated as invalid in ts-phonenumber)

    uan?: PhoneNumberDesc

    Universal Access Number patterns (treated as invalid in ts-phonenumber)

    voip?: PhoneNumberDesc

    VoIP number patterns

    Settings

    Member Visibility

    On This Page

    Properties