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

@radya/nuxt-proxy-party

v1.3.2

Published

Nuxt HTTP proxy based on H3

Downloads

393

Readme

Nuxt Proxy Party

Nuxt Proxy Party is a module designed to simplify the process of creating proxies using h3 in your Nuxt application. This module allows you to easily define and manage proxy routes with custom handlers.

Installation

To install Nuxt Proxy Party, run the following command:

yarn add -D @radya/nuxt-proxy-party

After installation, add the module to your nuxt.config.ts:

export default defineNuxtConfig({
  modules: ['@radya/nuxt-proxy-party'],
})

Configuration

To initialize the configuration file, run:

npx nuxt-proxy-party --init

This will create a default configuration file that you can modify to suit your needs.

Usage

To use Nuxt Proxy Party, you need to define your proxy routes within the server.config.ts file:

Simple

import { getCookie } from 'h3'
import { defineProxyParty } from '#nuxt-proxy-party'

export default defineProxyParty([
  {
    name: 'bin',
    baseUrl: '/api/bin',
    target: 'https://httpbin.org',
  },
])

With custom handler

import { getCookie } from 'h3'
import { defineProxyParty } from '#nuxt-proxy-party'

export default defineProxyParty([
  {
    name: 'bin',
    baseUrl: '/api/bin',
    target: 'https://httpbin.org',
    handler: (event) => {
      const token = getCookie(event, 'oauth/token')

      if (token) {
        event.node.req.headers.authorization = `Bearer ${token}`
      }
    },
  },
])

Using Runtime Config

If you need to use runtime configuration, import it from #imports:

import { useRuntimeConfig } from '#imports'

This allows you to access and use runtime configuration values in your proxy handler.

Contributing

We welcome contributions to Nuxt Proxy Party. If you’d like to contribute, please follow these steps:

  1. Enable Corepack: Ensure Corepack is enabled by running:

    corepack enable
  2. Install Dependencies: Install all necessary dependencies by running:

    yarn install
  3. Generate Type Stubs: Run the following command to generate type stubs:

    yarn dev:prepare
  4. Start Development Mode: Use the following command to start the playground in development mode:

    yarn dev

This will set up your environment to develop and test Nuxt Proxy Party.

License

This project is licensed under the MIT License. See the LICENSE file for more details.