Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Client

Index

Constructors

constructor

  • Parameters

    Returns Client

Properties

addresses

addresses: AddressResource

agent

agent: Agent

api_key

api_key: string

baseUrl

baseUrl: string

header

header: Header

keys

postcodes

postcodes: PostcodeResource

strictAuthorisation

strictAuthorisation: boolean

timeout

timeout: number

tls

tls: boolean

udprn

umprn

version

version: string

Static errors

errors: "/opt/build/repo/lib/error" = errors

Methods

checkKeyUsability

lookupAddress

lookupPostcode

  • Lookup Postcode

    Search for addresses given a postcode. Postcode queries are case and space insensitive

    Invalid postcodes return an empty array address result []

    API Documentation for /postcodes

    Parameters

    Returns Promise<Address[]>

lookupUdprn

lookupUmprn

ping

  • Ping API base (/)

    Dispatches HTTP request to root endpoint "/"

    Returns Promise<HttpResponse>

protocol

  • Returns Protocol

url

  • url(): string
  • Return base URL for API requests

    Returns string

Object literals

Static defaults

defaults: object

header

header: object

Accept

Accept: string = "application/json"

Content-Type

Content-Type: string = "application/json"