vinbudin

vinbudin

An NPM package to fetch product data from Vínbúðin.

vinbudin

Features

• ⚡ Fetch categorized product data from www.vinbudin.is
• 🏷️ Fully typed API

Setup

# pnpm
pnpm add -D vinbudin

# npm
npm i -D vinbudin

# yarn
yarn add -D vinbudin

Why?

Vínbúðin does not provide an open API. This package can be used to analyse their product data or create something else from it.

Basic Usage

import { getProducts } from 'vinbudin'

getProducts().then((products) => {
  // Handle the data
  console.log(products)
})

// You can also provide an options object to only get specific data
getProducts({
  beer: true,
  bubbly: true,
}).then((products) => {
  // Handle the data
  console.log(products)
})

[!NOTE] This package is designed to be used in a server-side environment. Due to restrictions imposed by browsers regarding cross-origin requests (CORS), attempting to use this package in a client-side (browser) environment may result in errors related to CORS policies.

Methods

getProducts(products) -> promise

Gets products from www.vinbudin.is

• products (Object) is an options object that you can optionally pass in if you want some subset of the data.

It looks like this:

{
  beer: true,
  red: true,
  white: true,
  rose: true,
  bubbly: true,
  fortified: true,
  ciderfruitandblends: true,
  sakeandmead: true,
  strong: true,
  aromatised: true,
}

Working with Client-Side Environments

While this package is primarily intended for use in server-side environments, such as Node.js applications, there are workarounds available for integrating it into client-side environments.

Both Nuxt and Next.js support API routes as an example:

• Nuxt API routes
• Next.js API routes

Example using Nuxt API routes

// server/api/vinbudin.ts
import { getProducts } from 'vinbudin'

export default defineEventHandler(async () => {
  return await getProducts({ beer: true })
)

// Component
<script setup lang="ts">
const { data } = await useFetch('/api/vinbudin')
</script>