feat(dts): default description for values

unjs · Mar 9, 2022 · 9e2e6b4 · 9e2e6b4
1 parent 7862f3b
commit 9e2e6b4
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/generator/dts.ts b/src/generator/dts.ts
@@ -4,6 +4,7 @@ import { escapeKey, normalizeTypes } from '../utils'
 export interface GenerateTypesOptions {
  addExport?: boolean
  addDefaults?: boolean
+ defaultDescrption?: string
 }
 
 const GenerateTypesDefaults: GenerateTypesOptions = {
@@ -155,6 +156,8 @@ function generateJSDoc (schema: Schema, opts: GenerateTypesOptions): string[] {
 
   if (schema.description) {
     buff.push(schema.description)
+  } else if (opts.defaultDescrption && schema.type !== 'object') {
+    buff.push(opts.defaultDescrption)
   }
 
   if (