Question: tsdoc for function param type

[xiaoxiangmoe]

/**
 * doc for `a`,`b`, and `c` here:
 */
function foo({
  a,
  b,
  c
}:{
  a: string,
  b: number,
  c: string
}){

}

[octogonz]

The docs would be like this:

/**
 * doc for `a`,`b`, and `c` here:
 * @param a - the first parameter
 * @param b - the second parameter
 * @param c - the third parameter
 * @returns the return value
 */
function foo({
  a,
  b,
  c
}:{
  a: string,
  b: number,
  c: string
}): boolean {

}

The type of the parameters is not specified in TSDoc, because it is already expressed by the TypeScript language.

[smeijer]

The type of the parameters is not specified in TSDoc, because it is already expressed by the TypeScript language.

But wouldn't it be nice to have it regardless? Imagine building documentation systems on top of this library. That won't be possible without having type info.

[nbouvrette]

This is a bit annoying, especially for React props, right now if you implement functional components like this:

type LoginScreenProps = {
  isAuthenticated: boolean
  redirectTo?: string
}

export const LoginScreen: React.FC<LogInScreenProps> = ({ isAuthenticated, redirectTo }) => { ...

This is the type you will see in Visual Studio Code when implementing the component:

(alias) const LoginScreen: FC<LogInScreenProps>
import LoginScreen

If you want to see the expanded "props" values, other than adding the type inline, an alternative would be to use TSDoc. But it seems that it's unable to see the props argument and it's typed to any:

/**
 * Login screen component.
 *
 * @param props - The component props.
 * @param props.isAuthenticated - Is the user authenticated?
 * @param props.redirectTo - The URL to redirect to after login.
 *
 * @returns The login screen component.
 */