parameter type emitted as object instead of inline type

[techfg]

What package is the bug related to?

typedoc-plugin-markdown

Describe the issue

In certain scenarios, the type emitted for a function parameter that is a type is emitted as object instead of the inline type.

A few notes:

1. This is very similar to the issues mentioned in property emits object for its type instead of inlined typed #733 & Unioned type for function param emits object instead of inline type for type that is based on a typedef #720.
2. None of the issues occur when generating html (typedoc-plugin-markdown is not used)
3. There are three scenarios outlined in the repro:
   1. type based on typedef - all doesNotWork* functions emit object for the opts param type
   2. explicit type - No issues, everything works as expected
   3. explicit type with @inline tag - all doesNotWork* functions emit object for the opts param type
4. Adding strict=true to tsconfig.json changes the behavior:
   1. type based on typedef - doesNotWorkDefault and doesNotWork2 emit correctly but doesNotWork1 does not
   2. explicit type - No change, everything still works
   3. explicit type with @inline tag - doesNotWorkDefault and doesNotWork2 emit correctly but doesNotWork1 does not

Repro: https://stackblitz.com/edit/vitejs-vite-cwwnqznq

npm run docs:md && npm run docs:html

TypeDoc configuration

    "typedoc": "^0.27.5",
    "typedoc-plugin-markdown": "^4.3.3",
    "typescript": "^5.7.2",

Expected behavior

full type should emit inline in all cases for scenario 1 & 3.

[tgreyuk]

thanks @techfg - i will go through each of these use-cases.

[techfg]

thanks @tgreyuk! Very odd about why strict changes the behavior in 2 of the 3 scenarios, looking forward to hearing what you find 😄

[tgreyuk]

@techfg fixes for above in typedoc-plugin-markdown@4.4.0.

Tested against both strict: true|false (not entirely sure what causes the side effects here).

[techfg]

Thanks for the update @tgreyuk! Unfortunately, it appears that some situations are still not working as expected.

1. type based on typedef
   1. When strict is enabled, all works as expected
   2. When strict is NOT enabled, doesNotWorkDefault and doesNotWork2 emit object. I ran this a few times and I believe I also saw doesNotWork1 emit object but am not able to reproduce it currently so possibly I mid-read the output.
2. explicit type - No issues, everything works as expected
3. explicit type with @inline tag
   1. When strict is enabled, all works as expected
   2. When strict is NOT enabled, doesNotWorkDefault and doesNotWork2 emit object.

Repro: https://stackblitz.com/edit/vitejs-vite-xdy13sac?file=src%2Findex.ts

[tgreyuk]

@techfg - sorry - not sure what happened with my testing there. I understand now though. When strict=false, the type is parsed as an OptionalType, which wasn't correctly handling the object expansion. However, when strict=true, the type is parsed as a UnionType that includes a null item which was being handled correctly.

I do have a fix. I will plan to release a.s.a.p - probably tomorrow.

[techfg]

No worries, thank you! And good to better understand why strict makes a difference 😄

[tgreyuk]

Hopefully resolved in typedoc-plugin-markdown@4.4.1

[techfg]

all 3 scenarios look good in v4.4.1 regardless of strict setting.

Thank you @tgreyuk!