Options
All
  • Public
  • Public/Protected
  • All
Menu

Client Configuration Object

Hierarchy

  • Config

Index

Properties

Optional 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

default

""

Optional baseUrl

baseUrl: string

Target API domain

default

"api.ideal-postcodes.co.uk"

Optional header

header: StringMap

String map specifying default headers

default

{}

Optional strictAuthorisation

strictAuthorisation: boolean

Force autocomplete authorisation via HTTP headers only

default

false

Optional 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

default

[]

Optional timeout

timeout: number

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

default

10000

Optional tls

tls: boolean

Use TLS

default

true

Optional version

version: string

API version

default

"v1"