Skip to content
This repository was archived by the owner on Oct 1, 2020. It is now read-only.

Commit 7eefb7c

Browse files
committed
fix: add jsdoc for default options
1 parent 9336dde commit 7eefb7c

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

index.ts

+19
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,26 @@ type FilePreprocessor = (file: FileEvent) => Promise<FilePath>
6363

6464
type WebpackPreprocessorFn = (options: PreprocessorOptions) => FilePreprocessor
6565

66+
/**
67+
* Cypress file preprocessor that can bundle specs
68+
* using Webpack.
69+
*/
6670
interface WebpackPreprocessor extends WebpackPreprocessorFn {
71+
/**
72+
* Default options for Cypress Webpack preprocessor.
73+
* You can modify these options then pass to the preprocessor.
74+
* @example
75+
```
76+
const defaults = webpackPreprocessor.defaultOptions
77+
module.exports = (on) => {
78+
delete defaults.webpackOptions.module.rules[0].use[0].options.presets
79+
on('file:preprocessor', webpackPreprocessor(defaults))
80+
}
81+
```
82+
*
83+
* @type {Omit<PreprocessorOptions, 'additionalEntries'>}
84+
* @memberof WebpackPreprocessor
85+
*/
6786
defaultOptions: Omit<PreprocessorOptions, 'additionalEntries'>
6887
}
6988

0 commit comments

Comments
 (0)