Urbanup
Table of Contents
Introduction
Urbanup is an up-to-date API wrapper for urban dictionary with the aid of axios and ECMAScript 2017's async/await.
Installation
With npm:
$ npm install urbanup
With yarn:
$ yarn add urbanup
Usage
Try me on RunKit
Simply import the library and use whatever endpoint directly:
const urbanup = require('urbanup')
import * as urbanup from "urbanup"
urbanup(query[, options]).then(r => )
Query
To request a page of definitons from urban dictionary:
const urbanup = require('urbanup')
import * as urbanup from "urbanup"
var query = 'javascript'
var options
urbanup(query, options).then(definitions => console.log(definitions[0]))
urbanup.query(query, options)
If you would like the API to return only one definition, you can do:
urbanup.one(query, options).then(r => )
Random
To request a random page of defintions:
const urbanup = require('urbanup')
import * as urbanup from "urbanup"
urbanup.random(options).then(def => console.log(def))
urbanup.random.one(options).then(def => console.log(def.permalink))
API Options
Additionally, each method allows you to pass in API options to customise your experience a tad more.
var options = {
page: 2,
cb: (result) => { return result.data.list },
agent: 'My Progamme, contact@example.com',
axiosOptions: {
timeout: 1000
}
}