# moira

> Most Outstanding IP Reporting Assistant

Latest version **1.1.2** (published 2014-06-10) · 0 weekly downloads

## Install

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

## 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.1.2 |
| Published | 2014-06-10 |
| First published | 2014-01-13 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Matthew Hasbach |
| Maintainers | mjhasbach |
| Keywords | external, IP, address, retrieve, fetch, utility |

## Links

- npm: https://www.npmjs.com/package/moira
- Repository: https://github.com/mjhasbach/MOIRA
- Issues: https://github.com/mjhasbach/MOIRA/issues
- npm.io page: https://npm.io/package/moira

## Dependencies (1)

- [request](https://npm.io/package/request.md) >= 2.34.0

## Recent versions

- 1.1.2 (latest) — 2014-06-10
- 1.1.1 — 2014-06-03
- 1.1.0 — 2014-05-22
- 1.0.9 — 2014-05-22
- 1.0.8 — 2014-05-12
- 1.0.7 — 2014-05-12
- 1.0.6 — 2014-05-12
- 1.0.5 — 2014-04-12
- 1.0.4 — 2014-04-12
- 1.0.3 — 2014-03-25
- 1.0.2 — 2014-03-25
- 1.0.1 — 2014-01-27
- 1.0.0 — 2014-01-13

## README

# MOIRA
##### Most Outstanding IP Reporting Assistant

### Installation

You may install MOIRA via NPM as follows:

    npm install moira

The source code is available on [GitHub](https://github.com/mjhasbach/MOIRA).

### Command

#### moira.getIP( callback( ```err```, ```ip```, ```service``` ))

Retrieve your external IP address asynchronously by requesting it from several different IP-fetching services simultaneously. ```moira.getIP()``` reports the quickest result after verifying that it is a valid IP address and terminating all other requests. ```err``` is null if an IP address was found. ```ip``` is an IPv4 address. ```service``` is the URL of the IP-reporting service that returned ```ip``` (e.g. http://whatismyip.akamai.com/).

Example:

    var moira = require( 'moira' );
    
    moira.getIP( function( err, ip, service ){
        if( err ) throw err;
    
        console.log( 'Your external IP address is ' + ip );
        console.log( 'The fastest service to return your IP address was ' + service );
    });

### Test

    npm test

### Improving MOIRA

If you would like to contribute code or simply add an IP reporting service, feel free to submit a pull request. Please report issues [here](https://github.com/mjhasbach/MOIRA/issues).

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