# postcodesoftware

> Node.js interface to PostcodeSoftware.net

Latest version **0.1.0** (published 2014-11-27) · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2014-11-27 |
| First published | 2014-11-27 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| Author | Jonathan Darrer |
| Maintainers | jondarrer |
| Keywords | postcodesoftware, postcode, lookup |

## Links

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

## Dependencies (2)

- [xml2js](https://npm.io/package/xml2js.md) 0.4.x
- [request](https://npm.io/package/request.md) 2.x.x

## Recent versions

- 0.1.0 (latest) — 2014-11-27

## README

postcodesoftware
================

Node.js interface to PostcodeSoftware.net

Introduction
------------

PostcodeSoftware is an asynchronous javascript client for [PostcodeSoftware.net](http://postcodesoftware.net/).

Synopsis
--------

``` js
  var assert = require('assert'); // For our demo here
  var PostcodeSoftware = require('postcodesoftware');
  var ps = new PostcodeSoftware({account: "test", password: "test"});

  ps.lookup('LS18 5NJ', function (err, res) {
      res.address1; // 'Cornmill View'
      assert.equal(res.postcode, 'LS18 5NJ');
  });

  ps.credits(function (err, res) {
      if (err) {
          // Handle error
      } else {
          // Handle success
      }
  });
```

Installation
------------

``` bash
  $ npm install postcodesoftware
```

Testing
-------

After cloning the repository and installing the dependencies, you can run all the tests using [Mocha](http://mochajs.org/).

``` bash
  $ npm test
```

or

``` bash
  $ mocha test/tests.js
```

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