Ideal Postcodes API Typings
This repository contains Typescript typings for the Ideal Postcodes API (api.ideal-postcodes.co.uk).
It specifies typings that define:
- The basic JSON objects returned by our APIs (e.g. addresses
Address, autocomplete suggestions
AddressSuggestion, API key status
- The overall shape of JSON responses returned by the API (e.g. postcode lookups
PostcodesResponse, address autocomplete queries
AddressSuggestionResponse, address search queries
Typings are exported to
index.d.ts when published to npm. The typings in this repository are defined in
npm install --save-dev @ideal-postcodes/api-typings
Import interfaces and other definitions
// Import Address type;;
Benefits of Typings
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.
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.