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

@virgodev/bazaar

v1.1.30

Published

This package contains various functions that can be used in any JavaScript project. It also has some Vue-specific code.

Downloads

302

Readme

Virgo Development Bazaar

This package contains various functions that can be used in any JavaScript project. It also has some Vue-specific code.

Some of the functions have documentation written, which will show up in some code editors by hovering over the name of the function.

The most frequently used function in this package is api, so that function has special attention in this README.

The api Function

The api function is a wrapper for fetch. We will now go through various things it can do.

GET Request

import api from "@virgodev/bazaar/functions/api";

async function fetchDogBreeds() {
  const responseData = await api({
    url: "https://dog.ceo/api/breeds/list/all",
  });

  if (responseData.status === 200) {
    console.log(responseData.body);
  } else {
    console.log(`Request failed (status code: ${responseData.status})`);
  }
}

fetchDogBreeds();

POST Request (JSON)

import api from "@virgodev/bazaar/functions/api";

async function postJSON() {
  const responseData = await api({
    url: "https://jsonplaceholder.typicode.com/posts",
    method: "POST",
    json: {
      title: "foo",
      body: "bar",
      userId: 1,
    },
  });

  if (responseData.status === 201) {
    console.log(responseData.body);
  } else {
    console.log(`Request failed (status code: ${responseData.status})`);
  }
}

postJSON();

POST Request (FormData)

import api from "@virgodev/bazaar/functions/api";

async function postFormData() {
  const body = new FormData();
  body.append("title", "foo");
  body.append("body", "bar");
  body.append("userId", "1");

  const responseData = await api({
    url: "https://httpbin.org/post",
    method: "POST",
    body,
  });

  if (responseData.status === 200) {
    console.log(responseData.body);
  } else {
    console.log(`Request failed (status code: ${responseData.status})`);
  }
}

postFormData();

Setting a Base URL

There is a good chance that most or all of the requests your project will be making will have the same base URL (e.g. https://dog.ceo/api/). If you are using Vite or Vue CLI, you can specify a base URL in your .env and .env.production files.

Vite:

VITE_APP_API_URL=https://www.example.com/api/

Vue CLI:

VUE_APP_API_URL=https://www.example.com/api/

Setting a Global Request Header

This allows you to always have a header present in the requests you make:

import { setGlobalRequestHeader } from "@virgodev/bazaar/functions/api";

setGlobalRequestHeader("Authorization", "Token 1234abcd");

Adding a Request Handler

This allows you to run a function before each request is made. An example of when this could be useful is if you are developing locally with your front end and back end on different ports and need cookies to work. In that scenario, you could do something like this:

import { addRequestHandler } from "@virgodev/bazaar/functions/api";

addRequestHandler(({ options }) => {
  options.credentials = "include";
});

Adding a Response Handler

This allows you to run a function after each request is made. You can limit it so that your function runs only if the request resulted in a specific status code or you can have your function run after all requests.

import { addResponseHandler } from "@virgodev/bazaar/functions/api";

addResponseHandler(403, () => {
  console.log("A request that resulted in a 403 finished.");
});

addResponseHandler("all", () => {
  console.log("A request finished.");
});