Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Config

Index

Properties

agent

agent: Agent

HTTP Agent

For downstream clients like core-node and core-browser, this will default to the native platform HTTP client

api_key

api_key: string

API Key. Used in API helper methods

baseUrl

baseUrl: string

Target API hostname. Defaults to 'api.ideal-postcodes.co.uk'

header

header: Header

String map specifying default headers

strictAuthorisation

strictAuthorisation: boolean

Force autocomplete authorisation via HTTP headers only. Defaults to false

tags

tags: string[]

Append tags to helper requests like lookupPostcode and lookupUDPRN

Tags attached to the client are overwritten on an request if it is also specified in the helper request options

timeout

timeout: number

Default time in ms before HTTP request timeout. Defaults to 10s (10000)

tls

tls: boolean

Use TLS. Defaults to true

version

version: string

API version. Defaults to 'v1'