Напишите объявление класса для jsdoc

Я пишу простой класс и объявление для него. Затем я использую jsdoc, чтобы указать тип библиотеки.

// index.ts
class VjsccXX {
  el: HTMLElement
  text: string
  show: boolean

  constructor(el: HTMLElement, text: string, show = true) {
    this.el = el
    this.text = text
    this.show = show

    this.el.classList.add('vjsscc-xx')

    if (!show) {
      this.el.style.display = 'none'
    }

    console.info('xx is ready')
  }
  hide() {
    this.el.style.display = 'none'
  }
  tex() {
    this.el.innerHTML = this.text
  }
}

export default VjsccXX
// index.d.ts
declare class VjsccXX {
  el: HTMLElement
  text: string
  show: boolean
  hide(): void
  tex(): void
  constructor(el: HTMLElement, text: string, show?: boolean)
}

export = VjsccXX
// test.js
/** @type {import('..')} */
const VjsccXX = window.VjsccXX

Напишите объявление класса для jsdoc

Но, как показано на фото выше, VjsccXX становится экземпляром, а не классом. Итак, как с этим бороться?


======================= Некоторые обновления ========================= знак равно

Изображение, показанное выше, использует window.VjsccXX, потому что его html-файл включает пакет umd. И его тип неправильный, потому что VjsccXX должен быть конструктором класса, а не экземпляром класса, который имеет свойства прототипа.

Затем я пишу еще один файл ts, чтобы увидеть его тип:

Напишите объявление класса для jsdoc

Может быть, я мог бы написать так?

======================= Еще одно обновление ========================= ===

Также работайте с cjs:

Напишите объявление класса для jsdoc

Напишите объявление класса для jsdoc

Напишите объявление класса для jsdoc

Может быть, это проблема jsdoc?

Что вы ожидаете получить? Вы создаете переменную с тем же именем, что и определение вашего класса, и указываете с помощью @type, что она имеет тип вашего класса. Кажется, здесь все работает так, как ожидалось.

Ben 16.03.2022 11:19

Потому что после сборки umdVjsccXX будет добавлен к window. И я объявляю, что новая переменная с тем же именем не конфликтует. Затем я использую jsdoc, чтобы указать его тип, чтобы получить правильный тип. И его тип неправильный, VjsccXX должен быть конструктором, а не экземпляром, который имеет свойства в прототипе класса.

GuangWu 17.03.2022 02:58
Зод: сила проверки и преобразования данных
Зод: сила проверки и преобразования данных
Сегодня я хочу познакомить вас с библиотекой 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
2
32
1
Перейти к ответу Данный вопрос помечен как решенный

Ответы 1

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

Я думаю, вам нужно использовать typeof здесь:

// test.js
/** @type {typeof import('..')} */
const VjsccXX = window.VjsccXX

Да, это то, чего я хочу. Большое спасибо!!

GuangWu 21.03.2022 11:35

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