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

untappd-node

v1.0.5

Published

An unofficial third party API for Untappd

Downloads

10

Readme

untappd-node

Note: This is not an official API. Breaking changes may occur at any time. Use at your own risk.

Untappd-node is a lightweight third party API used to fetch data from Untappd. The API is fully typed in typescript and requires no API credentials.

Installation

Minimum node version: 20

NPM:

npm install untappd-node

Yarn:

yarn add untappd-node

To use it simply import the functions you wish to use (Functions are documented below):

import { searchBeers } from 'untappd-node';

const results = await searchBeers('3 fonteinen');

Documentation

API

searchBeers

searchBeers(string) : Promise<SearchResult[]>

Returns a list of SearchResult that matches your search. Returns an empty list if no results were found.

Example:

import { searchBeers } from 'untappd-node';

const results = await searchBeers('3 fonteinen');

getBeer

getBeer(string) : Promise<Beer | null>

Gets information about a beer with the given ID. Returns null if no beer was found.

Example:

import { getBeer } from 'untappd-node';

const beer = await getBeer('144709');
if (beer !== null) {
  // Do something
}

Error handling

The API will throw HTTPException if the call to Untappd fails for any reason. This HTTPException includes the status code and the corresponding error message:

import { getBeer } from 'untappd-node';
import type { HTTPException } from 'untappd-node';

try {
  const beer = await getBeer('1234');
  // ...
} catch (error) {
  if (error instanceof HTTPException) {
    // You now have typed access to statusCode and message
    console.log(error.statusCode);
  }
  // Generic error handling
}

Types

SearchResult

type SearchResult = {
  id: string;
  name: string;
  brewery: string;
  style: string;
  url: string;
  abv?: number;
  rating: number;
};

Beer

type Beer = {
  id: string;
  name: string;
  brewery: string;
  style: string;
  abv?: number;
  image: string;
  rating: number;
  numRatings: number;
};