Skip to content

vixt / core / defineVitePlugin

defineVitePlugin() ​

defineVitePlugin<Options>(pluginFn): (options?) => PluginOption

A helper function for creating Vite plugins.

Type Parameters ​

Options ​

Options = any

Parameters ​

pluginFn ​

(options?) => PluginOption

Returns ​

(options?) => PluginOption

Example ​

ts
import { defineVitePlugin } from 'vixt'

interface PluginOptions {
  enabled?: boolean
}

export const myVitePlugin = defineVitePlugin<PluginOptions>((options) => {
  console.log(options)
  return {
    name: 'my-vite-plugin',
    configResolved(config) {
      console.log(config)
    }
  }
})