IntelliSense not working with @typedef

[tnorlund]

I'd like to use IntelliSense to use @typedef or be able to show given parameters.

• VSCode Version: 1.51.1
• OS Version: Mac OS 11.0.1

/**
 * @typedef {Object} ParsedUser
 * @param {String} name The name of the user.
 * @param {String} email The email of the user.
 * @param {Number|String} userNumber The number of the user.
 */

/**
 * Gets the useful user data from the current Cognito user session.
 * @param {Object} CognitoUserSession The current cognito user session.
 * @returns {ParsedUser} The parsed user data.
 */
export function parseUser( CognitoUserSession ) {
  const { name, email, ...restOfUser } = CognitoUserSession.idToken.payload
  return {
    name: name, email: email, userNumber: restOfUser[`custom:UserNumber`]
  }
}

[mjbvz]

What is the issue?

[tnorlund]

The issue is that the returns from Intellisense does not show the information in the type definition.

Is there a better way to document this? I'd like to do something similar with a function that uses an object as a parameter.

/**
 * User library
 */
class User {
  /**
   * A user object.
   * @param {object} options
   * @param {String} options.name The name of the user.
   * @param {Number|String} [options.userNumber=`0`] The number of the user.
   */
  constructor( {
    name, email, userNumber = `0`, dateJoined = new Date(), numberTOS = `0`,
    numberFollows = `0`
  } ) {
    if ( !name ) throw Error( `Must give the user's name` )
    this.name = name
...

[mjbvz]

It has the correct type so this is the currently the designed behavior .

Expanding typedefs like you want is tracked by microsoft/TypeScript#25784