# urban

> Simple API and command line for Urban Dictionary

Latest version **0.3.4** (published 2021-08-24) · MIT license · 0 weekly downloads

## Install

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

Provides the command `urban`.

## 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.3.4 |
| Published | 2021-08-24 |
| First published | 2011-11-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=v0.4.9 |
| Dependencies | 1 |
| Unpacked size | 7.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 135 |
| Author | Murilo Santana |
| Maintainers | mvrilo |
| Keywords | urban, dictionary, api, definition |

## Links

- npm: https://www.npmjs.com/package/urban
- Repository: https://github.com/mvrilo/urban
- Homepage: https://github.com/mvrilo/urban#readme
- Issues: https://github.com/mvrilo/urban/issues
- npm.io page: https://npm.io/package/urban

## Dependencies (1)

- [commander](https://npm.io/package/commander.md) >=0.3.0

## Recent versions

- 0.3.4 (latest) — 2021-08-24
- 0.3.3 — 2021-08-24
- 0.3.2 — 2018-09-15
- 0.3.1 — 2016-03-29
- 0.3.0 — 2015-10-03
- 0.2.4 — 2015-08-13
- 0.2.3 — 2014-10-11
- 0.2.2 — 2014-08-30
- 0.2.1 — 2014-07-06
- 0.2.0 — 2011-11-13
- 0.1.1 — 2011-11-12
- 0.1.0 — 2011-11-10
- 0.0.1 — 2011-11-09

## README

# urban

The [Urban Dictionary](https://www.urbandictionary.com/) program and library for [node.js](https://nodejs.org/). The API is official, but undocumented.

### installation

    $ npm install -g urban # bin
    $ npm install urban # lib

### examples

#### bin
    $ urban facepalm
    $ urban -r // random mode

#### lib
    var urban = require('urban'),
        trollface = urban('trollface');

    trollface.first(function(json) {
        console.log(json);
    });
    
    
    // Random mode
    var urban = require('urban');
    
    urban.random().first(function(json) {
        console.log(json);
    });
    

### license

MIT

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