Interface AddressOptions

interface AddressOptions {
    includeCountry?: boolean;
    includeState?: boolean;
    includeZip?: boolean;
    locale?: string;
    zipFormat?: string;
}

Properties

includeCountry?: boolean

Include the country name in the address. Defaults to false.

includeState?: boolean

Include the state/province/region (if available in locale). Defaults to true.

includeZip?: boolean

Include the postal/zip code. Defaults to true.

locale?: string

Target locale (e.g., 'en-US', 'en-GB', 'fr-FR'). Defaults to context locale or 'en-US'.

zipFormat?: string

Override the locale's default postal code format (e.g., 'XXXXX', 'XXN NAA'). 'X' for digit, 'A' for letter, 'N' for digit.