JSPM

  • Created
  • Published
  • Downloads 687
  • Score
    100M100P100Q100638F
  • License MIT

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

Package Exports

  • nuxt-proxy-request

Readme


nuxt-proxy-request

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

Features

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': ''
        }
      }
    ]
  }
})

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

⚠️ TIPS: More proxy.options please see h3-proxy's Options

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