npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

urbanup

v0.2.0

Published

A modern API wrapper for Urban Dictionary

Downloads

1

Readme

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') // CommonJS
import * as urbanup from "urbanup" // ES6

urbanup(query[, options]).then(r => /* do something */)

Query

To request a page of definitons from urban dictionary:

const urbanup = require('urbanup') // CommonJS
import * as urbanup from "urbanup" // ES6

var query = 'javascript'

var options // Optional library options

urbanup(query, options).then(definitions => console.log(definitions[0])) // Returns an array of matching definitions
// Schema: https://api.urbandictionary.com/v0/define?page=1&term=javascript

urbanup.query(query, options) // The same as urbanup(query, options)

If you would like the API to return only one definition, you can do:

urbanup.one(query, options).then(r => /* do something */)

Random

To request a random page of defintions:

const urbanup = require('urbanup') // CommonJS
import * as urbanup from "urbanup" // ES6

urbanup.random(options).then(def => console.log(def))

// You can also get the first result only:
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 = {
    // Decide which page to get. Default is 1
    page: 2,
    // Provide your own callback function to be used instead
    cb: (result) => { return result.data.list },
    // Use your own custom user agent. User agent will always default to your Node.js version and OS name if no agent is provided
    agent: 'My Progamme, [email protected]',
    // Allows you to apply your own axios options whenever axios is used.
    axiosOptions: {
        // Sets a specific amount of time in milliseconds that axios will wait until the requested server responds.
        timeout: 1000 
        // You can find other axios options at https://github.com/axios/axios#request-config
    }
}