# simple-realurl

> A simple node module to convert short url's to the original url.

Latest version **1.1.2** (published 2016-08-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install simple-realurl
pnpm add simple-realurl
yarn add simple-realurl
bun add simple-realurl
```

## 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 | 2016-08-09 |
| First published | 2013-04-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Luke Karrys |
| Maintainers | lukekarrys |
| Keywords | realurl, url, url lengthener |

## Links

- npm: https://www.npmjs.com/package/simple-realurl
- Repository: https://github.com/lukekarrys/simple-node-realurl
- Homepage: https://lukekarrys.github.io/simple-node-realurl
- Issues: https://github.com/lukekarrys/simple-node-realurl/issues
- npm.io page: https://npm.io/package/simple-realurl

## Dependencies (1)

- [lodash.merge](https://npm.io/package/lodash.merge.md) ^4.5.1

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 1.1.2 (latest) — 2016-08-09
- 1.1.1 — 2015-06-06
- 1.1.0 — 2015-06-06
- 1.0.3 — 2015-06-06
- 1.0.1 — 2014-10-08
- 1.0.0 — 2014-08-02
- 0.1.5 — 2014-02-27
- 0.1.4 — 2013-04-30

## README

# simple-realurl

[![NPM](https://nodei.co/npm/simple-realurl.png)](https://nodei.co/npm/simple-realurl/)
[![Build Status](https://travis-ci.org/lukekarrys/simple-realurl.png?branch=master)](https://travis-ci.org/lukekarrys/simple-realurl)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)

A simple node module to convert short url's to the original url.

Based off [Manuel van Rijn's original realurl](https://github.com/manuelvanrijn/node-realurl), I created this to remove some dependencies (copypaste) and any global bin files.

## Getting Started

Install the module with: `npm install simple-realurl --save`

### Within your NodeJS project

```javascript
var realurl = require('simple-realurl');
realurl.get('http://goo.gl/BGV9x', function(error, result) {
   // error = null;
   // result = "http://github.com/manuelvanrijn/node-realurl";
});

realurl.get('http://this-is-not-a-real-url.com/at-all', function(error, result) {
   // error = Error('URL resulted in a 404');
   // result = null;
});

realurl.get('', function(error, result) {
   // error = Error('Please specify a short url');
   // result = null;
});

realurl.get('url', {agent: false}, function(error, result) {
  // bypasses Node's http/s client pool
});
```

## License

Copyright (c) 2012 Manuel van Rijn - Licensed under the MIT license.
Copyright (c) 2012-2016 Luke Karrys - Licensed under the MIT license.

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