nuxt-proxy-request

nuxt-proxy-request

A http proxy module for nuxt(3) powered by h3-proxy .

• ✨  Release Notes

Why use this module?

• See this issue Error when starting a Project using "http-proxy-middleware" with "npm run start" #15608

Features

• Support for both development and production environments.
• Almost the same API as nuxt-proxy that using http-proxy-middleware, But this module using h3-proxy .
• Support Typescript.

Quick Setup

1. Add nuxt-proxy-request dependency to your project

# Using pnpm
pnpm add -D nuxt-proxy-request

# Using yarn
yarn add --dev nuxt-proxy-request

# Using npm
npm install --save-dev nuxt-proxy-request

1. Add nuxt-proxy-request to the modules section of nuxt.config.ts

export default defineNuxtConfig({
  modules: [
    'nuxt-proxy-request'
  ],
  proxy: {
    options: [
      {
        target: 'http://www.example.com',
        pathFilter: ['/api/**'],
        pathRewrite: {
          '^/api': ''
        }
      }
    ]
  }
  // OR
  // runtimeConfig: {
  //   proxy: {...}
  // }
})

That's it! You can now use nuxt-proxy-request in your Nuxt app ✨

Options

Key	Type	Default value	Description
options	object/Array<object>	[]	Configure which targets you want to proxy. :warning: TIPS: More config object please see h3-proxy's Options, You can pass an array of options for multiple targets or pass an object of options for single target.

Development

# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release

Changelog

v1.2.0

compare changes

🚀 Enhancements

• Update nuxt to 3.6, add prettier for code format, fix runtime proxy type (94c2a8e)

❤️ Contributors

• Wenqing [e-mail]