Skip to content

Commit 38a5299

Browse files
committed
chore(docs): add ModuleOptions JSDoc
1 parent e7e61fe commit 38a5299

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

src/options.ts

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,49 @@ import { ComponentsDir, ComponentsOptions } from '@nuxt/schema'
33
import { HookData } from './types'
44

55
export interface ModuleOptions {
6+
/**
7+
* Directory where files metas are outputed upon parsing.
8+
*
9+
* It will create `component-meta.d.ts` and `component-meta.mjs` files.
10+
*/
611
outputDir?: string
12+
/**
13+
* Nuxt root directory.
14+
*
15+
* Should be auto-filled by the module/process.
16+
*/
717
rootDir?: string
18+
/**
19+
* Debug level: true, false or 2.
20+
*
21+
* 2 will log every timings for components parsing.
22+
*/
823
debug?: boolean | 2
24+
/**
25+
* Components directories pushed in the include list.
26+
*/
927
componentDirs: (string | ComponentsDir)[]
28+
/**
29+
* Components options pushed in include list.
30+
*/
1031
components?: ComponentsOptions[]
32+
/**
33+
* Component paths and/or path regexps to be excluded.
34+
*/
1135
exclude?: (string | RegExp | ((component: any) => boolean))[]
36+
/**
37+
* vue-component-meta checker options.
38+
*/
1239
checkerOptions?: MetaCheckerOptions
40+
/**
41+
* Extra transformers to be run on top of each component code.
42+
*
43+
* `component` will be the Nuxt component options for this component and `code` the code of the component.
44+
*/
1345
transformers?: ((component: any, code: string) => ({ component: any; code: string }))[]
46+
/**
47+
* Filter all components that are not global.
48+
*/
1449
globalsOnly?: boolean
1550
}
1651

0 commit comments

Comments
 (0)