Как добавить описание к возвращаемым реквизитам объекта с помощью JSDoc или TypeScript?

У меня есть проект TypeScript и специальный крючок, который возвращает кучу переменных isMobile | isDesktop | ..., и я хотел бы добавить описание к каждой из этих переменных, чтобы где-нибудь в проекте я мог навести курсор на переменную и получить описание (аннотация типа будет пришел из ТС). Как мне это сделать или возможно ли это?

Крюк:

export const useDeviceType = ({ between = [0, 0] } = {}) => {
  const theme = useTheme();
  const isMobile = useMediaQuery(theme.breakpoints.between(0, 'tablet'));
  const isDesktop = useMediaQuery(theme.breakpoints.up('desktop'));
  const isScreenWidthBetween = useMediaQuery(theme.breakpoints.between(between[0], between[1]));

  return useMemo(
    () => ({
      isMobile,
      isDesktop,
      isScreenWidthBetween,
    }),
    [isDesktop, isMobile, isScreenWidthBetween],
  );
};

Где-то в проекте:

  const { isDesktop, isMobile } = useDeviceType();

  if (isMobile) {
    // do something
  }

Прямо сейчас при наведении курсора на isMobile я получаю const isMobile: boolean, но я бы хотел добавить описание и к isMobile, чтобы оно выглядело так:

const isMobile: boolean
description: isMobile — from 0 to 768px
Зод: сила проверки и преобразования данных
Зод: сила проверки и преобразования данных
Сегодня я хочу познакомить вас с библиотекой Zod и раскрыть некоторые ее особенности, например, возможности валидации и трансформации данных, а также...
Как заставить Remix работать с Mantine и Cloudflare Pages/Workers
Как заставить Remix работать с Mantine и Cloudflare Pages/Workers
Мне нравится библиотека Mantine Component , но заставить ее работать без проблем с Remix бывает непросто.
Угловой продивер
Угловой продивер
Оригинал этой статьи на турецком языке. ChatGPT используется только для перевода на английский язык.
TypeScript против JavaScript
TypeScript против JavaScript
TypeScript vs JavaScript - в чем различия и какой из них выбрать?
Синхронизация localStorage в масштабах всего приложения с помощью пользовательского реактивного хука useLocalStorage
Синхронизация localStorage в масштабах всего приложения с помощью пользовательского реактивного хука useLocalStorage
Не все нужно хранить на стороне сервера. Иногда все, что вам нужно, это постоянное хранилище на стороне клиента для хранения уникальных для клиента...
Что такое ленивая загрузка в Angular и как ее применять
Что такое ленивая загрузка в Angular и как ее применять
Ленивая загрузка - это техника, используемая в Angular для повышения производительности приложения путем загрузки модулей только тогда, когда они...
0
0
57
1
Перейти к ответу Данный вопрос помечен как решенный

Ответы 1

Ответ принят как подходящий

Вы можете создать тип, а затем определить свою функцию, возвращающую экземпляр этого типа. И при определении типа вы можете добавить соответствующие комментарии.

/**
 * your type-description
 */
type Foo = {
  /** your property-description */
  isMobile: boolean;
  ...
}


export const useDeviceType = ({ between = [0, 0] } = {}) => {
  const theme = useTheme();
  const isMobile = useMediaQuery(theme.breakpoints.between(0, 'tablet'));
  const isDesktop = useMediaQuery(theme.breakpoints.up('desktop'));
  const isScreenWidthBetween = useMediaQuery(theme.breakpoints.between(between[0], between[1]));

  return useMemo(
    () => ({
      isMobile,
      isDesktop,
      isScreenWidthBetween,
    } as Foo),
    [isDesktop, isMobile, isScreenWidthBetween],
  );
};
      

    

Другие вопросы по теме