docs(schema): add example and description for imports.dirs (#9346)

This commit is contained in:
Rami Menai 2022-11-28 14:00:26 +03:00 committed by GitHub
parent 538ba11804
commit 73bbae3308
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -31,6 +31,18 @@ export default defineUntypedSchema({
*/ */
imports: { imports: {
global: false, global: false,
/**
* An array of custom directories that will be auto-imported.
* Note that this option will not override the default directories (~/composables, ~/utils).
* @example
* ```js
* imports: {
* // Auto-import pinia stores defined in `~/stores`
* dirs: ['stores']
* }
* ```
*/
dirs: [] dirs: []
}, },