Options
All
  • Public
  • Public/Protected
  • All
Menu

@ideal-postcodes/api-typings

Index

Type aliases

AddressNumber

AddressNumber: number | string

Some numbers which may not be populated on a premise will return empty string "" instead of null or 0.

Instances of AddressNumber include:

  • Longitude, Latitude
  • Eastings, Northings
  • UMPRN

AddressResults

AddressResults: Address[]

Address queries will return a list of Address premises.

AddressSuggestionResults

AddressSuggestionResults: AddressSuggestion[]

Autocomplete requests will return a list of address suggestion objects inside a hits attribute

PostcodeResults

PostcodeResults: Address[]

Postcode results are represented as an array of addresses