Browser Client

CircleCI codecov Dependency Status npm version npm bundle size

Ideal Postcodes Javascript Client

JavaScript browser client for api.ideal-postcodes.co.uk

As of June 2019, we've released a modern, revamped Browser client at @ideal-postcodes/core-browser. Documentation for the legacy client ideal-postcodes-core can be found here.

@ideal-postcodes/core-browser is the JavaScript browser client for api.ideal-postcodes.co.uk

Our JavaScript client implements a common interface defined at @ideal-postcodes/core-interface.

High level client documentation can be found at core-interface.

In depth client documentation can be found at core-interface.ideal-postcodes.dev.

Tested against a suite of modern and legacy, mobile and desktop browsers.

@ideal-postcodes/core-browsershould be consumed by a bundler or transpiler (e.g. webpack, parcel, rollup) for minification, module resolution and specific browser support.

core-browser-bundled provides pre-bundled versions of core-browser, which can be immediately dropped into a page.

Links