chore: add docblock

MetRonnie · Aug 11, 2022 · 69ae29f · 69ae29f
1 parent c683bed
commit 69ae29f
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -8,6 +8,18 @@ type CypressPreprocessor = (file: FileObject) => string | Promise<string>
 
 const cache: Record<string, string> = {}
 
+/**
+ * Cypress preprocessor for running e2e tests using vite.
+ *
+ * @param {string} userConfigPath
+ * @example
+ * setupNodeEvents(on) {
+ *   on(
+ *     'file:preprocessor',
+ *     vitePreprocessor(path.resolve(__dirname, './vite.config.ts')),
+ *   )
+ * },
+ */
 function vitePreprocessor(userConfigPath?: string): CypressPreprocessor {
   if (userConfigPath) {
     resolveConfig(userConfigPath)