Як боротися з трьома невирішеними змінними, що попереджають у Веб-штурмі?

У мене є функція, яка бере дані з сервера:

function getData(data){
    console.log(data.someVar);
}

Веб-штурм каже, що someVar- це невирішена змінна. Що я можу позбутися від таких попереджень?

Я бачу кілька варіантів:

• Придушити попередження в налаштуваннях іде;
• Додайте вихідний файл json з полями ( деталі );
• Використовуйте масиви-як синтаксис: data['some_unres_var'];

Також веб-штурм пропонує мені створити простір імен для "даних" (додати анотацію на зразок /** @namespace data.some_unres_var*/), створити таке поле або перейменувати його.

Використовуйте JSDoc:

/**
 * @param {{some_unres_var:string}} data
 */
function getData(data){
    console.log(data.some_unres_var);
}

JSDoc об'єкт. Тоді її члени.

/**
 * @param data          Information about the object.
 * @param data.member   Information about the object's members.
 */
function getData(data){
    console.log(data.member);
}

• @property для локальних змінних (не параметри)
• Тестували в PyCharm. @Nicholi підтверджує, що це працює в Webstorm.
• У {{ member:type }}синтаксичних Андреас запропонував може конфліктувати з шаблонами Django.
• Завдяки Jonny Б'юкенена відповідь з посиланням на @param вікі .

Для документування масивів об'єктів використовуйте []дужки, як пропонує JSDoc :

/**
 * @param data
 * @param data.array_member[].foo
 */

Усі інші відповіді неправильні для загального випадку. Що робити, якщо ви не отримаєте dataпараметр? У вас тоді немає JSDoc:

function niceApiCall(parameters) {
  const result = await ...  // HTTP call to the API here
  for (const e of result.entries) {
    .. // decorate each entry in the result
  }
  return result;
}

WebStorm попередить, що "result.entries" є невирішеною змінною (полем).

Загальне рішення - додати @namespaceдекларацію:

function niceApiCall(parameters) {
  /** @namespace result.entries **/
  const result = await ...  // HTTP call to the API here
  for (const e of result.entries) {
    .. // decorate each entry in the result
  }
  return result;
}

використання фіктивного js-файлу з анонімним виразом функції, що повертає буквар json, як написано на http://devnet.jetbrains.com/message/5366907 , може бути рішенням. Я також можу запропонувати створити підроблену змінну, яка буде містити це значення json, і використовувати цей var як значення анотації @param, щоб WebStorm дізнався, що таке фактичний тип. Подібно до:

var jsontext = {"some_unres_var":"val"};
/** @param {jsontext} data */
function getData(data){
    console.log(data.some_unres_var);
}

Дивіться також http://devnet.jetbrains.com/message/5504337#5504337

Використання руйнування, Лука.

function getData(data){
    const {member} = data;
    console.log(member);
}

Щоб видалити попередження з веб-IDE WebStorm, ви можете просто зняти параметри перевірки для:

• Невирішена функція Javascript
• Невирішена змінна Javascript

пс . це видалить попередження про IDE, але я не думаю, що це найкраща ідея, оскільки ми втратимо одну з найкращих утиліт в IDE, як Webstorm, що може погіршити якість нашого коду.

Тим не менш, якщо ви хочете дотримуватися в меню: Файл > Налаштування > Редактор > Інспекції, ми можемо відключити попередження Javascript.

Подобається наступний малюнок: