# eircode

> Simple Node.js validation for Eircodes

Latest version **1.0.1** (published 2017-06-23) · ISC license · 0 weekly downloads

## Install

```sh
npm install eircode
pnpm add eircode
yarn add eircode
bun add eircode
```

## 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.1 |
| Published | 2017-06-23 |
| First published | 2017-06-23 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Rob Gleeson |
| Maintainers | robgleeson |
| Keywords | Eircode, Node.js, Postcodes, Irish |

## Links

- npm: https://www.npmjs.com/package/eircode
- npm.io page: https://npm.io/package/eircode

## Recent versions

- 1.0.1 (latest) — 2017-06-23
- 1.0.0 — 2017-06-23

## README

[Eircode NPM](https://www.npmjs.com/package/eircode)

Validates Eircodes (Irish postcodes).

## Install
- `npm install eircode`

## Import/require
```js
const eircode = require('eircode');
// OR
import eircode from 'eircode';
```

## Usage

```js
const isEircodeValid = eircode('A42F8G0'); // Returns true;

const isEircodeValid = eircode('A32F8G0'); // Returns error: Routing key is Invalid

const isEircodeValid = eircode('A32F8G08'); // Returns error: Eircode is too long

const isEircodeValid = eircode('A32F880'); // Returns error: Unique identifier is invalid

```

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