Axios backed JavaScript client for api.ideal-postcodes.co.uk
@ideal-postcodes/core-axios
is the Axios backed client for api.ideal-postcodes.co.uk. Axios is a promise based HTTP client for the browser and node.js and so is ideal for:
- Frameworks that utilise server side rendering (Angular, Next.js, React, etc)
- Isomorphic code (runs on browser and server)
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.
Links
Other JavaScript Clients
Documentation
Configuration & Usage
Install
npm install @ideal-postcodes/core-axios
Instantiate
const { Client } = require("@ideal-postcodes/core-axios");
import { Client } from "@ideal-postcodes/core-axios"
const client = new Client({ api_key: "iddqd" });
Configuration options
Use
const addresses = await client.lookupPostcode({ postcode: "SW1A2AA" });
Catch Errors
const { IdpcRequestFailedError } = Client.errors;
try {
await client.lookupAddress({ query: "10 downing street" });
} catch (error) {
if (error instanceof IdpcRequestFailedError) {
}
}
Test
npm test
Licence
MIT