How to inline type generics?

[LekoArts]

Hello!

I have this example, I uploaded it also to Stackblitz: https://stackblitz.com/edit/sb1-a2gvdqm6

/**
 * The optional options object.
 */
export type UseExampleOptions = {
  /**
   * foobar
   */
  onCancel?: () => void;
  /**
   * foobar 2
   */
  throwOnCancel?: boolean;
};

type UseExampleResult = string;

/**
 * Some description
 */
type UseExample = <Options extends UseExampleOptions>(
  options?: Options
) => UseExampleResult;

/**
 * Some description
 *
 * @returns Return description
 *
 * @example
 * ### foobar
 *
 * Some description
 *
 * ```tsx {{ filename: 'src/components/MyButton.tsx' }}
 * // Foobar
 * ```
 */
export const useExample: UseExample = (options) => {
  const optionStuff = options;
  console.log(optionStuff);

  return 'hello world';
};

I want to inline the UseExampleOptions for the options parameters, but using a combination of @interface or @inline isn't working for me. Alternatively inlining them into "Type Parameters" would also work for me.

Do I need a custom plugin for that?

[Gerrit0]

What does it even mean to inline a type parameter? By definition, that type could be any number of types that isn't known at the declaration site, only when calling the function.

You could put the inline tag on UseExampleOptions which should do some inlining.

[LekoArts]

Maybe "inline" was the wrong word choice then and you're correct that something that is only declared at runtime can't be documented.

My intention is to somehow surface the UseExampleOptions type as for most end users this will be the relevant piece of information. While technically they can pass in more they probably don't need to.

I forgot to set the stackblitz to "public" -- I did add the @inline to UseExampleOptions but that didn't change anything as far as I can see.

[Gerrit0]

Ah, you're running an old version of TypeDoc from before @inline was supported In 0.27, this renders as:

In 0.28, as your useExample variable explicitly specifies a type, and TypeDoc is more conservative about rewriting the types of your members, you have to specify @function for it to render as a function. When doing that, it renders as:

[LekoArts]

Thank you, I'll try that next week!

[suhaotian]

Or similar like this?:

[LekoArts]

Yes, this could be an option 👍 I'm not using the default HTML output so I can implement it myself, too.

[suhaotian]

I already wrote the code, you can check here:

https://github.com/suhaotian/xior/tree/main/typedoc

Usage:

# pnpm typedoc && node typedoc/write-popover.mjs
pnpm typedoc --customJs typedoc/popover.js