Définir la structure de l'objet reçu?

Question

Y a-t-il un moyen, que ce soit dans les spécifications JavaScript ou la plateforme IntelliJ, de définir la structure d'un objet que vous recevez, disons, un appel AJAX?

Exemple:

$.ajax({ 
    type: 'POST', 
    url: 'https://myapi.domain.com/apitest', 
    success: function(payload) { 
     let username = payload.userNameField; //unresolved variable "userNameField" 
    } 
}); 

Dans l'exemple ci-dessus, WebStorm rapporte que payload.userNameField est une "variable non résolue".

Y a-t-il un moyen de définir l'objet de manière à ce qu'il ne montre pas d'erreurs et peut-être aussi d'auto-complétion?

Answer 1

Merci à @chazsolo me montrant "Custom complex type" de JSDoc qui est supporté nativement par WebStorm, cette solution fonctionne très bien:

$.ajax({ 
    type: 'POST', 
    url: 'https://myapi.domain.com/apitest', 
    success: processResponse 
}); 

/** 
* Definition of the object returned by the api call 
* @typedef {Object} processResponse~payload 
* @property {string} userNameField - Username returned by API 
*/ 
/** 
* Definition of function that handles the response 
* @class 
* @param {...processResponse~payload} payload - the data returned by the call 
*/ 

function processResponse(payload) { 
     let username = payload.userNameField; //no errors now and autocomplete works! 
};