Skip to content

Commit

Permalink
chore: improve jsdoc of library options (#8381)
Browse files Browse the repository at this point in the history
  • Loading branch information
pd4d10 authored May 29, 2022
1 parent 356b896 commit 44dc27d
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions packages/vite/src/node/build.ts
Original file line number Diff line number Diff line change
Expand Up @@ -203,9 +203,25 @@ export interface BuildOptions {
}

export interface LibraryOptions {
/**
* Path of library entry
*/
entry: string
/**
* The name of the exposed global variable. Required when the `formats` option includes
* `umd` or `iife`
*/
name?: string
/**
* Output bundle formats
* @default ['es', 'umd']
*/
formats?: LibraryFormats[]
/**
* The name of the package file output. The default file name is the name option
* of the project package.json. It can also be defined as a function taking the
* format as an argument.
*/
fileName?: string | ((format: ModuleFormat) => string)
}

Expand Down

0 comments on commit 44dc27d

Please sign in to comment.