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

node-brewerydb

v0.1.0

Published

Service library for www.brewerydb.com

Downloads

3

Readme

Node BreweryDB wrapper

Build Status

This is a node package (WIP) wrapper for the http://www.brewerydb.com/ service API.

Setup

Install the library.

npm instal https://github.com/DanielOchoa/node-brewery-db

Import the library.

var BreweryDb = require('node-brewerydb');

Create a new instance by passing an object with the apiKey.

var client = new BreweryDb({apiKey: yourApiKey});

How to use

You can access the restful resources from BreweryDB as follows:

For Beers

For the beers endpoint, just call the beers method and pass in any extra parameters from the BreweryDB docs. For example, to get a beer by name:

client.beers({name: 'Tecate'}, function(err, res) {
  if (err) {
    // handle errors
  }
  console.log(res);
});

Or with promises:

return client.beers({name: 'Tecate'}).then(function(res) {
  console.log(res);
}, function(err) {
  // in case an error happens.
});

To get a single beer, you need to pass the beer id as follows:

client.beer('IPhAuu', function(err, res) {
  console.log(res);
});

You can also get nested resources for any given resource that allows it, see the BreweryDB docs. For example, beers take a nested resource:

client.beer('IPhAuu', 'breweries', function(err, res) {
  // here are the breweries for this particular beer.
  console.log(res);
});

You can also access any other nested resource for a beer, such as adjunt, event and fermentable.

TODO

So far we can access beer/beers, nested resources for beer, styles and brewery/breweries. Work needs to be done to access other resources.