types(vite): add JSDoc documentation and examples to Vite PluginOptions
This commit is contained in:
parent
fa81d697fe
commit
ce0bb58124
1 changed files with 16 additions and 0 deletions
|
|
@ -22,6 +22,22 @@ const INLINE_STYLE_ID_RE = /[?&]index=\d+\.css$/
|
|||
export type PluginOptions = {
|
||||
/**
|
||||
* Optimize and minify the output CSS.
|
||||
*
|
||||
* @default true in production build, false in development
|
||||
*
|
||||
* @example
|
||||
* ```ts
|
||||
* import tailwindcss from '@tailwindcss/vite'
|
||||
* import { defineConfig } from 'vite'
|
||||
*
|
||||
* export default defineConfig({
|
||||
* plugins: [
|
||||
* tailwindcss({
|
||||
* optimize: { minify: true },
|
||||
* }),
|
||||
* ],
|
||||
* })
|
||||
* ```
|
||||
*/
|
||||
optimize?: boolean | { minify?: boolean }
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue