fix(core): add '?' for optional type declarations in tables

typedoc2md · Sep 1, 2024 · c0744f0 · c0744f0
1 parent ba8956c
commit c0744f0
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 16 deletions.
diff --git a/.changeset/silent-starfishes-build.md b/.changeset/silent-starfishes-build.md
@@ -0,0 +1,5 @@
+---
+'typedoc-plugin-markdown': patch
+---
+
+- Add '?' for optional type declarations in tables
diff --git a/packages/typedoc-plugin-markdown/test/fixtures/src/reflections/types.ts b/packages/typedoc-plugin-markdown/test/fixtures/src/reflections/types.ts
@@ -103,7 +103,7 @@ export type LiteralType = {
   /**
    * comment for x
    */
-  x: string;
+  x?: string;
   /**
    * comment for y
    */
@@ -115,7 +115,7 @@ export type LiteralType = {
     /**
      * comment for y.y
      */
-    y: boolean | string;
+    y?: boolean | string;
     /**
      * comment for y.z
      */

diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/objects-and-params.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/objects-and-params.spec.ts.snap
@@ -504,9 +504,9 @@ Comments for someFunctionWithArrow
 
 \`string\`
 
-### x
+### x?
 
-> **x**: \`string\`
+> \`optional\` **x**: \`string\`
 
 comment for x
 
@@ -522,9 +522,9 @@ comment for y
 
 comment for y.x
 
-### y.y
+### y.y?
 
-> **y**: \`boolean\` \\| \`string\`
+> \`optional\` **y**: \`boolean\` \\| \`string\`
 
 comment for y.y
 
@@ -635,10 +635,10 @@ Comments for someFunctionWithArrow
 
 \`string\`
 
-### x
+### x?
 
 \`\`\`ts
-x: string;
+optional x: string;
 \`\`\`
 
 comment for x
@@ -663,10 +663,10 @@ x: string;
 
 comment for y.x
 
-### y.y
+### y.y?
 
 \`\`\`ts
-y: boolean | string;
+optional y: boolean | string;
 \`\`\`
 
 comment for y.y

diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.type-alias.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.type-alias.spec.ts.snap
@@ -113,9 +113,9 @@ Comments for someFunctionWithArrow
 
 \`string\`
 
-### x
+### x?
 
-> **x**: \`string\`
+> \`optional\` **x**: \`string\`
 
 comment for x
 
@@ -131,9 +131,9 @@ comment for y
 
 comment for y.x
 
-### y.y
+### y.y?
 
-> **y**: \`boolean\` \\| \`string\`
+> \`optional\` **y**: \`boolean\` \\| \`string\`
 
 comment for y.y
 
@@ -227,10 +227,10 @@ Comments for LiteralType
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | \`someFunctionWithArrow\` | () => \`string\` | Comments for someFunctionWithArrow |
-| \`x\` | \`string\` | comment for x |
+| \`x\`? | \`string\` | comment for x |
 | \`y\` | \`object\` | comment for y |
 | \`y.x\` | \`string\` | comment for y.x |
-| \`y.y\` | \`boolean\` \\| \`string\` | comment for y.y |
+| \`y.y\`? | \`boolean\` \\| \`string\` | comment for y.y |
 | \`y.z\` | (\`x\`: \`string\`) => \`string\` | comment for y.z |
 | \`z\` | (\`x\`: \`string\`) => \`string\` | - |
 | \`get accessorA\` | [\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`string\`\\> | Comments for accessorA getter |