VSCode zeigt nicht die richtige params in Objekt

Question

Ich habe meine Funktion wie diese jsdoc'ed:

/** 
* @typedef {Object} SearchTerms 
* @property {string} what 
* @property {string} where 
* @property {boolean} online 
*/ 

/** 
* From react-router params, which are URL encoded, it figures out the "what", "where", and "online" terms. 
* 
* @export 
* @param {Object} params The `params` field from react-router component props. 
* @param {string} [params.what="Everything"] The subject of users search. 
* @param {string} [params.where] The location of users search. 
* @returns {SearchTerms} 
*/ 
export function getSearchTerms(params) { 

jedoch die params Schlüssel nicht richtig auf schweben der Funktion erweitert wird:

Gibt es trotzdem dafür params Argument richtig zu erweitern? Ich hatte gehofft, für sie zu zeigen:

Abgesehen davon, dass es auch zeigen sollte, dass es mit Fragezeichen ist optional. Und als ich das Argument geben, sollte es die Bezeichnung jenes Argument wie folgt zeigen:

Answer 1

Das Problem ist, dass Sie die Art Ihrer params param als Object angegeben haben. Sie sollten Ihren params als zweite @typedef ausbricht:

/** 
* @typedef SearchOptions 
* @property {String} [what="Everything"] The thing 
* @property {String} [where] A place 
*/ 

/** 
* @param {SearchOptions} params 
*/ 
function getSearchTerms(params){ ... } 

Mit Hilfe einer Schnittstelle namens wie diese, VSCode die Argumente in Intellisense zeigen sollten, wie Sie suchen.