urban-dictionary-es6 v1.0.1

urban-dictionary-es6

Badges from Shields.io

Installing by zip

Simply download the latest zip from the Releases page. Then extract the urban-dictionary-es6.js file and place it into your Node.js project directory. Read below to see the available actions with examples on how to use it.

Installing by npm

Install Node.js with the NPM extra component. This is included by default during a default install. Then open you're command terminal and use one of the following. Local is for the current project folder. Global will install and work on all your projects that require the module.

Local Install: npm install urban-dictionary-es6

Global Install npm install urban-dictionary-es6 -g

Uninstalling by npm

Local Uninstall npm uninstall urban-dictionary-es6

Global Uninstall npm uninstall urban-dictionary-es6 -g

Note that you got to be in the root of your project folder to local uninstall.

• Actions
  • defid
  • random
  • term
• FAQ
• Object Dictionary

Actions

defid

If you know the defid of the term. You can use this to just retrieve the Definition Object of that entry only.

Arguments

• id {Number} The defid to retrieve.
• results {Object result in Promise}
  • entry {Definition Object}
  • tags {Array of String} Tags of related words.
  • sounds {Array of String} Full link addresses to .mp3 and .wav files.

E.g

const ud = require('urban-dictionary-es6')

ud.defid(2488552)
  .then((results) => {
    const {entry, tags, sounds} = results
    console.log('Urban Dictionary - DefID Method')
    console.log('Word: ' + entry.word)
    console.log('Definition: ' + entry.definition)
    console.log('--- --- ---')
  })
  .catch((error) => {
    console.log(error.message)
  })

random

Use this to obtain a random definition.

Due to the way that Urban Dictionary's API works. It will in fact retrieve 10 definitions at once. This action will store all 10 in a cache on first use and provide them 1 at a time on each use. Each entry that gets provided gets removed from the cache. Once all the entries have been provided, it will retrieve another 10 once the cache is empty. Until all the entries have been provided, all the definitions that are currently stored in the cache are provided first.

Arguments

• entry {Definition Object result in Promise}

E.g

const ud = require('urban-dictionary-es6')

ud.random()
  .then((entry) => {
    console.log('Urban Dictionary - Random Method')
    console.log('Word: ' + entry.word)
    console.log('Definition: ' + entry.definition)
    console.log('--- --- ---')
  })
  .catch((error) => {
    console.error(error.message)
  })

term

Use this to manually retrieve an already existing definition.

Arguments

• definition {String} The definition to search for.
• entry {Object result in Promise}
  • error {Error} if there's an error else {null}
  • entries {Array of Definition Object}
  • tags {Array of String} Tags of related words.
  • sounds {Array of String} Full link addresses to .mp3 and .wav files.

E.g

const ud = require('urban-dictionary-es6')

ud.term('word')
  .then((results) => {
    const {entries, tags, sounds} = results
    console.log('Urban Dictionary - Term Method')
    console.log('Word: ' + entries[0].word)
    console.log('Definition: ' + entries[0].definition)
    console.log('--- --- ---')
  })
  .catch((error) => {
    console.error(error.message)
  })

FAQ

• Q: Where did you get the URL to access Urban Dictionary's API? They hadn't got a documented page.
  • A: I just found them floating around on the web years ago. I don't have a source, sorry.
• Q: Are there any more methods?
  • A: Sorry. But these are the only URLs I'm aware of:
    • http://api.urbandictionary.com/v0/define with ?term=WORD_HERE or ?defid=DEFID_HERE
    • http://api.urbandictionary.com/v0/random
• Q: If they haven't documented it. Are we even allowed to use their site API?
  • A: I don't really know the answer. However, sites nowadays use an authorization name and password in the URL queries to restrict their API access to certain individuals. If Urban Dictionary didn't want others using it, they would had done so by now. In short: As long as we don't abuse the API to spam requests, we should be fine.
• Q: Why use standardjs coding style?
  • A: There are many different coding rules of JavaScript being used today. Since this standard is being used by many packages and is becoming common on github. I've decided to start using it myself and quickly started to like it. It saves time by not having to worry which rules to follow or finding ways around strict styles such as JSLint.

Object Dictionary

Definition Object

• author {String} Name of the poster.
• current_vote {String} Unknown. It only returns an empty string.
• defid {Number} The unique definition entry ID.
• definition {String} The definition description.
• example {String} An example use of the definition.
• permalink {String} A shortened link to Urban Dictionary page of the definition.
• thumbs_down {Number} Number of down votes.
• thumbs_up {Number} Number of up votes.
• word {String} The word of the definition. Be aware that the casing might be different.