Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PostalAddress

An implementation of a subset of https://schema.org/PostalAddress using only the fields that we need and/or plan to support

Hierarchy

  • PostalAddress

Implements

Index

Properties

@type

@type: "PostalAddress" = "PostalAddress"

schema type definition

addressCountry

addressCountry: string

ISO 3166-1 alpha-2 country code

Optional addressLocality

addressLocality: undefined | string

usually used for town/city

Optional addressRegion

addressRegion: undefined | string

region applicable to address, typically state, county or equivalent

Optional description

description: undefined | string

used to provide additional info on the address, i.e. as a notes field for example, for India this is used for the "Landmark" field

Optional postalCode

postalCode: undefined | string

streetAddress

streetAddress: string

Generated using TypeDoc