Телеграмм чат группы frontcoder страница 5768

но лично у меня они пишутся слева, а не под кодом

21:08пожаловаться #1

не подскажете как можно описать структуру возвращаемого объекта в JsDoc?
начал писать доку к одному методу в классе

 /**
   * @function _formatSelector
   * @param {Object} format - описание
   * @param {String} title -  описание
   * @returns {Object} - не знаю как описать структуру
   */
  _formatSelector(format, title) {/*code*/}

метод возвращает объект и я хотел бы описать его структуру здесь @returns {Object} (структура). Это можно сделать?

21:36пожаловаться #2

ну смотри, в доке есть пример

/**
 * User type definition
 * @typedef {Object} User
 * @property {string} email
 * @property {string} [nickName]
 */

т.е. ты описываешь тип User с полями email и nickName. соответственно в твоем @returns будет возвращаться {User}

22:40пожаловаться #3

еще момент, старайся примитивные типы данных описывать через нижний регистр

22:41пожаловаться #4

кроч, описание типов через jsdoc мало чем отличается от TS. разве что отсутствием удобных утилит работы с типами

22:42пожаловаться #5

в @typedef ты именно описываешь те самые типы которые далее будешь использовать по приложению

22:43пожаловаться #6

этот же кусок на TS можно переписать как


type User = {
  email: string;
  nickName?: string;
}

22:44пожаловаться #7

я не знал что примитивы в нижнем нужно)) исправлю. спасибо

22:45пожаловаться #8

тут просто ориентируйся на такой момент:
string - это примитивный тип данных
String - это обертка для работы с примитивным типом данных string

22:46пожаловаться #9

т.е. все что начинается с большой буквы - это класс

22:47пожаловаться #10

у меня этих @typedef что-то много накопилось. я их в начале файла покидал. не знаю что на это скажут. хотя на работе сказали опиши струтуры параметров и что методы возвращают

22:50пожаловаться #11

Array это массив чего? строк или чисел или какого то кастомного типа?

22:52пожаловаться #12

к сожалению, я не встречал есть ли возможность как то вынести определение типов через jsdoc в какой то отдельный файл, как в TS где index.d.ts

22:53пожаловаться #13

почти всегда объектов

22:54пожаловаться #14

ага, кастомных со своими полями жеж, т.е. например User[]?

22:55пожаловаться #15

но я думаю те объекты излишне описывать, если скажут только. наверно так нужно мне Object[]

23:04пожаловаться #16

а смысл тогда от такой типизации и описалова?

23:05пожаловаться #17

описание типов нужно для 2 вещей
1) для разработчика, что бы он понимал что от него ждут
2) для статического анализатора, который будет моделировать работу JS на основании этих типов с целью поиска нарушения композиции и прав доступа

23:06пожаловаться #18

когда ты применяешь какие то общие вещи - Object[] или подобное, то ты заведомо отключаешь модуль статической провеки данного блока. а значит корректность данной системы может быть нарушена

23:07пожаловаться #19

тоже самое, если ты используешь тип any в TS