⚠️

@netlify/vite-plugin
TypeScript icon, indicating that this package has built-in type declarations

2.7.15 • Public • Published

@netlify/vite-plugin

Vite plugin that emulates Netlify's platform features within your Vite dev server.

Feature Support

Feature Supported
Functions ✅ Yes
Edge Functions ✅ Yes
Blobs ✅ Yes
Cache API ✅ Yes
Redirects and Rewrites ✅ Yes
Headers ✅ Yes
Environment Variables ✅ Yes
Image CDN ✅ Yes

This module is not intended to be a full replacement for the Netlify CLI.

Installation

npm install @netlify/vite-plugin

Configuration options

The plugin accepts the following options:

  • middleware (boolean, default: true): Attach a Vite middleware that intercepts requests and handles them in the same way as the Netlify production environment
  • blobs: Configure blob storage functionality
  • edgeFunctions: Configure edge functions
  • functions: Configure serverless functions
  • headers: Configure response headers
  • images: Configure Image CDN functionality
  • redirects: Configure URL redirects
  • staticFiles: Configure static file serving

Usage

Add the plugin to your vite.config.js or vite.config.ts:

import { defineConfig } from 'vite'
import netlify from '@netlify/vite-plugin'

export default defineConfig({
  plugins: [netlify()],
})

Readme

Keywords