fix: Fix anonymous function types in params table

typedoc2md · Jul 15, 2021 · 0047faf · 0047faf
1 parent 35d8966
commit 0047faf
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 4 deletions.
diff --git a/packages/typedoc-plugin-markdown/src/resources/helpers/parameter-table.ts b/packages/typedoc-plugin-markdown/src/resources/helpers/parameter-table.ts
@@ -2,7 +2,7 @@ import { ParameterReflection, ReflectionKind } from 'typedoc';
 
 import { comment } from './comment';
 import { stripLineBreaks } from './strip-line-breaks';
-import { type } from './type';
+import { getReflectionType, type } from './type';
 
 export function parameterTable(this: ParameterReflection[]) {
   const flattenParams = (current: any) => {
@@ -60,7 +60,11 @@ function table(parameters: any) {
       }\``,
     );
 
-    row.push(type.call(parameter.type, 'object'));
+    row.push(
+      parameter.type
+        ? type.call(parameter.type, 'object')
+        : getReflectionType(parameter, 'object'),
+    );
 
     if (showDefaults) {
       row.push(getDefaultValue(parameter));

diff --git a/packages/typedoc-plugin-markdown/src/resources/helpers/type.ts b/packages/typedoc-plugin-markdown/src/resources/helpers/type.ts
@@ -17,6 +17,7 @@ import {
   UnionType,
   UnknownType,
 } from 'typedoc/dist/lib/models/types';
+
 import MarkdownTheme from '../../theme';
 import { escape } from './escape';
 
@@ -39,6 +40,7 @@ export function type(
     | IndexedAccessType
     | UnknownType
     | InferredType,
+
   collapse: Collapse = 'none',
   emphasis = true,
 ) {
@@ -116,7 +118,10 @@ function getLiteralType(model: LiteralType) {
   return `\`\`${JSON.stringify(model.value)}\`\``;
 }
 
-function getReflectionType(model: DeclarationReflection, collapse: Collapse) {
+export function getReflectionType(
+  model: DeclarationReflection,
+  collapse: Collapse,
+) {
   if (model.signatures) {
     return collapse === 'function' || collapse === 'all'
       ? `\`fn\``

diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/signatures.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/signatures.spec.ts.snap
@@ -84,7 +84,7 @@ Some nested params.
 | \`params.nestedObj\` | \`Object\` | A nested object. |
 | \`params.nestedObj.name\` | \`string\` | - |
 | \`params.nestedObj.obj\` | \`Object\` | - |
-| \`params.nestedObj.obj.name\` |  | - |
+| \`params.nestedObj.obj.name\` | () => \`void\` | - |
 | \`params.nestedObj.value\` | \`number\` | - |
 | \`params.parent?\` | \`number\` | - |
 | \`context\` | \`any\` | The context of the method call. |