# ideal-postcodes-core

> Ideal Postcodes core frontend javascript library

Latest version **1.0.0** (published 2017-11-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install ideal-postcodes-core
pnpm add ideal-postcodes-core
yarn add ideal-postcodes-core
bun add ideal-postcodes-core
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-11-23 |
| First published | 2016-07-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ideal Postcodes |
| Maintainers | cablanchard |
| Keywords | UK, Address, Postcode, Search, Ideal Postcodes |

## Links

- npm: https://www.npmjs.com/package/ideal-postcodes-core
- Repository: https://github.com/ideal-postcodes/ideal-postcodes-core
- Homepage: https://ideal-postcodes.co.uk/
- Issues: https://github.com/ideal-postcodes/ideal-postcodes-core/issues
- npm.io page: https://npm.io/package/ideal-postcodes-core

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2017-11-23
- 0.3.5 — 2017-03-21
- 0.3.4 — 2017-02-15
- 0.3.3 — 2017-02-15
- 0.3.2 — 2017-02-13
- 0.3.1 — 2017-02-08
- 0.3.0 — 2017-02-07
- 0.2.0 — 2016-09-19
- 0.1.3 — 2016-09-15
- 0.1.2 — 2016-08-18
- 0.1.1 — 2016-07-14
- 0.1.0 — 2016-07-13

## README

![BrowserStack Status](https://www.browserstack.com/automate/badge.svg?badge_key=RlN3VXIwTzJqcFhXaUFVb1pvc1lRTkFvc0d2VDJwS1lyL0R6VUpVbTJxWT0tLXRFaG9vbUI1c1NybmxSZG5kc2h0NGc9PQ==--90b7bb2059049ace502b49913e2b650d9f9a2c6b) [![Build Status](https://travis-ci.org/ideal-postcodes/ideal-postcodes-core.svg?branch=master)](https://travis-ci.org/ideal-postcodes/ideal-postcodes-core) [![npm version](https://badge.fury.io/js/ideal-postcodes-core.svg)](https://badge.fury.io/js/ideal-postcodes-core) ![gzip file size](http://img.badgesize.io/ideal-postcodes/ideal-postcodes-core/master/dist/ideal-postcodes-core.min.js.svg?compression=gzip) ![file size](http://img.badgesize.io/ideal-postcodes/ideal-postcodes-core/master/dist/ideal-postcodes-core.min.js.svg)

# Ideal Postcodes - Frontend Client

## Introduction

This library provides a core set of API's to interact with the Ideal Postcodes API on the browser. 

You may accomplish the following jobs using this library:

- Query addresses for a postcode
- Query for an address with an address fragment
- Autocomplete an address
- Lookup an address by ID
- Check key useability

## Build Status & Browser Compatibility Information

This library is tested across modern desktop and mobile browers

Internet Explorer 9 and above is supported. Internet Explorer 6, 7 and 8 are not supported

## Methods

Please see our [documentation](https://ideal-postcodes.co.uk/documentation/ideal-postcodes-core)

## Installation

You may install it via npm with,

```bash
npm install ideal-postcodes-core --save
```

You may also use Bower with,

```bash
bower install ideal-postcodes-core --save
```

Finally you can install it manually by copying the minified build from `/dist/`

## Testing

Run the test suite with,

```bash
gulp test
```

You may test the library manually in a browser console with,

```bash
gulp webserver
```

## License

MIT

---
_Source: https://npm.io/package/ideal-postcodes-core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._