JSDoc for class method, overloading, adding multiple signatures.

jsdoc-class-method-overload.js

/**
 * @typedef {(x: number) => string} NumberToStringType
 * 
 * @typedef {(x: string) => number} StringToNumberType
 * 
 * @typedef {NumberToStringType & StringToNumberType} FlipType
 */

class SampleClass {
  constructor() {
    /**
     * @type {FlipType}
     */
    this.flip = this._flip;
  }

  /**
   * @type {FlipType}
   * The @type definition will not effect here
   */
  _flip(x) {
    if (typeof x === 'string')
      return Number(x);
    else
      return String(x);
  }
}

let sample = new SampleClass();

let number1 = sample.flip(1); // string
let string1 = sample.flip("1"); // number

let number2 = sample._flip(2); // string | number
let string2 = sample._flip("2"); // string | number

/**
 * Arrow function
 * 
 * @type {FlipType}
 */
const flipper = x => {
  if (typeof x === 'string')
    return Number(x);
  else
    return String(x);
}

let number3 = flipper(3); // string
let string3 = flipper("3"); // number

This doesn't typecheck correctly in TypeScript.

@wmhilton It seems to work fine except for some warnings, you have to set the language to JS.

See https://www.typescriptlang.org/play?filetype=js#code/PQKhCgAIUgBAXAngBwKYBNUDNIG8AUAHgFyQB2ArgLYBGqATgJSQC8AfJAM7z0CWZAcwC+kAHLU69ACoB7AMo9+AqSlRQY6uEjSYcBEl0WDm7chIYiFfQbPG0GKtJs0JVuvHcmyrSx6kgAZJA+NjKeDqoiAGIANrzIfurA4OAAxjEAhpycwRlUyDGoAMKZ2XhQkKkyZNz0FKnwMvT4zLgVkJCgEB09MK5oeLHxfkLtHSDJPZDwABa8nAB0WHHIrNNziwD6y-EA3BWjFV3tfdr+uEMJkSeQUjP+Z5C6-LzwvNWQAO68MTHkMvBINgsKgGpB7vQ1L1JpBtisiK0xrwcPgzjIcIRWCwWJAAOS1JS4xhjDqQ+AUehkMTmZqERj7KaoGKcKFTSBkilUkICBEMyCjQ6FQGcPIFfw4sioT65fKFEpZTgtfbgIVmez0ACMaxFstQS3hGvpnWAhmsAhVqGFRgEWpxOrF+vi+AARBrnUbgCbKOqUqrvZIAEza0WFBZwp0Bj0mgmCSAAHzVkgtVrNQbtIb14eQLoD7t2xtNSnjiYYKWO0EgAEF6PQZNKsBQyA13mRnBX+udLiMkmlqtxIDtkGh6GtMaY2h1kZBUap0ZAx9i8TGBESxhzKdT1byKkyWWvLZzgtbt4LLSX6ABmNaD4f4C9RwuCZOPgRXnE3hgui95gv+hhAA

It would be nice to hae this feature working without hacking the class prototype....