Browser Client

CircleCI Cross Browser Testing codecov Dependency Status

npm version npm bundle size Release

Ideal Postcodes Javascript Client

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

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

Our JavaScript clients implement 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.

core-axios is an Axios-backed client. Axios is a promised based library that can be used on both the browser and server. It is ideal for frameworks that utilise server side rendering (Angular, Next.js, React, etc) and isomorphic code (runs on browser and server).

Links

Example Setup

Webpack Status

Parcel Status

Rollup Status

Polymer Status

Legacy Client

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.