Skip to content

Commit

Permalink
chore(docs): add ModuleOptions JSDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
Tahul committed Mar 21, 2023
1 parent e7e61fe commit 38a5299
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions src/options.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,49 @@ import { ComponentsDir, ComponentsOptions } from '@nuxt/schema'
import { HookData } from './types'

export interface ModuleOptions {
/**
* Directory where files metas are outputed upon parsing.
*
* It will create `component-meta.d.ts` and `component-meta.mjs` files.
*/
outputDir?: string
/**
* Nuxt root directory.
*
* Should be auto-filled by the module/process.
*/
rootDir?: string
/**
* Debug level: true, false or 2.
*
* 2 will log every timings for components parsing.
*/
debug?: boolean | 2
/**
* Components directories pushed in the include list.
*/
componentDirs: (string | ComponentsDir)[]
/**
* Components options pushed in include list.
*/
components?: ComponentsOptions[]
/**
* Component paths and/or path regexps to be excluded.
*/
exclude?: (string | RegExp | ((component: any) => boolean))[]
/**
* vue-component-meta checker options.
*/
checkerOptions?: MetaCheckerOptions
/**
* Extra transformers to be run on top of each component code.
*
* `component` will be the Nuxt component options for this component and `code` the code of the component.
*/
transformers?: ((component: any, code: string) => ({ component: any; code: string }))[]
/**
* Filter all components that are not global.
*/
globalsOnly?: boolean
}

Expand Down

0 comments on commit 38a5299

Please sign in to comment.