Type alias Address

Address: {
    city: string;
    country: Country;
    postalCode?: string;
    region?: string;
    streetAddress: string;
    streetAddress2?: string;
}

Physical location represented by an address

Type declaration

  • city: string

    City/town, more precise than region.

    Example

    Columbus
    
  • country: Country

    2-letter ISO 3166 country code

    Example

    US
    
  • Optional postalCode?: string

    Postal code formatted to the specification of the country specified in the country field.

    Example

    43215
    
  • Optional region?: string

    Region formatted to the specification of the country specified by the country field.

    The region should be set to the state (ex. US), county, borough, or municipality depending on the addressing standards of the country.

    Example

    OH
    
  • streetAddress: string

    Example

    629 N. High St. Suite 300
    
  • Optional streetAddress2?: string