Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

child?: Core.Graph
curie: "fx:countries"
links: { fx:property_helpers: PropertyHelpers; self: Countries }

Type declaration

props: { message: string; values: {} }

Type declaration

  • message: string

    A small, human readable explanation of this property helper.

  • values: {}

    JSON objects with the country codes as the keys.

    • [key: string]: { active: boolean; alternate_values: string[]; boost: number; cc2: string; cc3: string; default: string; has_regions: boolean | { active: boolean; alt: string[]; boost: number; c: string; n: string }[]; regions_required: boolean; regions_type: string }
      • active: boolean

        If this country is currently internationally recognized.

      • alternate_values: string[]

        Array of alternative names for this country.

      • boost: number

        This value determines which countries will show up first in our find-as-you-type system.

      • cc2: string

        The official 2 character country code.

      • cc3: string

        The official 3 character country code.

      • default: string

        The default name for this country.

      • has_regions: boolean | { active: boolean; alt: string[]; boost: number; c: string; n: string }[]

        If include_regions is passed in, this will be replaced with regions, an array of region information for this country. Boolean otherwise.

      • regions_required: boolean

        Whether this country requires regions for shipping or not.

      • regions_type: string

        What type of region this is such as state, province, etc.

zooms?: Readonly<Record<string, undefined | Core.Graph>>

Generated using TypeDoc