comment grouper les paramètres avec JSDoc comme lodash ?

Question

Je veux savoir comment lodash peut regrouper les suggestions de paramètres en fonction de leurs fonctions, selon le type ou le nombre de paramètres que les utilisateurs saisissent, comme indiqué ci-dessous :

dans l'image ci-dessus, on peut voir qu'il y a 8 groupements de suggestions sur le each fonction dans lodash . et ci-dessous un exemple de code dans mon cas :

Exemple de fonction :

function filter(allowSize, max) {
  //do Something
}

Si filter n'ont qu'un seul paramètre, utilisez la jsdoc ci-dessous :

/**
 * @param {object} allowSize
 * @param {number} allowSize.min
 * @param {number} allowSize.max
 */

Je veux supprimer max paramètre de la suggestion, mais je ne sais pas comment le faire

Si filter La fonction a 2 paramètres, utilisez le jsdoc ci-dessous :

/**
 * @param {number} allowSize
 * @param {number} max
 */

Je veux renommer allowSize pour min dans la suggestion, mais je ne comment le faire

comment puis-je faire ce qui précède en utilisant jsdoc ?

Answer 1

Vous pouvez utiliser surcharge de la fonction mais javascript ne prend pas en charge cette méthode. lodash ?

la réponse est lodash Typescript vous permet d'écrire des fonctions en utilisant la méthode de surcharge. Typescript générera un fichier avec l'extension .d.ts qui contient des informations relatives au code écrit.

Exemple :

function filter(allowSize: object): any;
function filter(min: number, max: number): any;
function filter(arg1: object | number, arg2?: number): any {
    if (typeof arg1 === "object") {
        // do something when the function only have 1 parameter
    } else if (typeof arg1 === "number" && typeof arg2 === "number") {
        // do something when the function has 2 parameters
    } else {
        // default
    }
}

après cela, compilez le fichier TS avec la commande tsc -d typescript_file.ts

le site -d est utile pour indiquer au compilateur de créer un fichier de déclaration.