Расширение документации для объекта - PullRequest
1 голос
/ 26 апреля 2019

Я пишу немного Cypress и javascript для некоторого тестирования, и у меня есть Объект cy.Этот объект задокументирован, и я получаю некоторую интеллигентность для него, однако я хочу расширить его с помощью некоторых своих собственных свойств, и мне интересно, могу ли я также расширить документацию.

Код, который я имею, является добрымпримерно так

cy.bo = {
    header: {
        get: () => header()
    }
}

Какой вид работ.Я могу получить доступ к cy.bo.header.get из моих тестов, и все работает, но моя IDE (vscode), конечно, скажет, что cy.bo имеет тип any.

Поэтому у меня есть вопрос: могу ли я расширитьдокументация этого объекта, чтобы также покрыть мои собственные взломанные свойства?

1 Ответ

0 голосов
/ 26 апреля 2019

Да, вы можете.Просто добавьте свой JSDoc , как обычно для дополнительных элементов, добавляемых в литерал объекта.

См. Скриншот ниже.

enter image description here

...