Typings for the Ideal Postcodes API (api.ideal-postcodes.co.uk)
Typescript typings which define:
Address
, autocomplete suggestions AddressSuggestion
, API key status KeyStatus
)PostcodesResponse
, address autocomplete queries AddressSuggestionResponse
, address search queries AddressQueryResponse
)Typings are exported to index.d.ts
when published to npm. The typings in this repository are defined in lib/index.ts
.
Install package
npm install --save-dev @ideal-postcodes/api-typings
Import interfaces and other definitions
// Import Address type
import { Address } from "@ideal-postcodes/api-typings";
let address: Address;
Typings allow IDEs to provide a richer, more productive environment to develop integrations. This includes providing code completions and suggestions.
Our typings also bear documentation which can be rendered in your IDE as you work.
Compile time checks that your library or application appropriately consumes objects and data types returned by our APIs and client libraries
Your integration does not have to be exclusively Typescript driven to benefit from this typings repository.
Some IDEs (e.g. Visual Studio, Visual Studio Code, Sublime Text) use Typescript typings to provide inline code completion and documentation for plain JavaScript files.
It is also possible to develop a partial, robust Typescript integration against our services and subsequently incorporate it in a larger JavaScript project. Typescript compiles down to plain JavaScript which can conform to ES3 and later. That output can be exported to other JavaScript projects.
The testing process involves attempting to compile a test file which assigns API fixtures generated by the API to the interfaces exported by this typings library. The tests will fail to compile if the API fixtures fail to conform to types.
npm test
MIT
Address queries will return a list of Address premises.
Autocomplete requests will return a list of address suggestion objects inside a hits attribute
Array of licensees
Postcode results are represented as an array of addresses
Address Number
Some numbers which may not be populated on a premise will return empty string
""
instead ofnull
or0
.Instances of
AddressNumber
include: