PhpStorm warnings with jQuery parameters

Question

I use PhpStorm and it is giving me warnings when I define a parameter as a type jQuery with JSDoc.

I've tried to configure jQuery as a library, but it didn't seem to work.

This is my code:

/**
 * @param {jQuery} $button
 */
function setActive($button)
{
    // The code is working fine, but PhpStorm is giving the warning 
    // "Unresolved function or method addClass()" here.
    $button.addClass("active");

    // If I try to do this, no warning is displayed.
    $("#test").addClass("test");
}

EDIT:

Some methods appear in the intellisense (I'm not sure why), but unfortunately addClass isn't one of them.

@Phiter Do you have any special configuration in your PHPStorm? It seems correct, but I just can't get rid of this warning. — Everton Lenger
– Everton Lenger, Commented Dec 19, 2017 at 11:07
Nothing special. If you use $('body'). will it autocomplete with jQuery functions? — Phiter
– Phiter, Commented Dec 19, 2017 at 11:09
Yes, it works with anything inside $(). It doesn't work only with the parameter. — Everton Lenger
– Everton Lenger, Commented Dec 19, 2017 at 11:14

lena · Accepted Answer · 2017-12-19 11:42:24Z

3

Try adding JQuery typings (either via Settings | Languages & Frameworks | JavaScript | Libraries, TypeScript Community Stubs or by running npm i @types/jquery in project dir) - this should solve the issue:

answered Dec 19, 2017 at 11:42

lena

94.4k11 gold badges155 silver badges160 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Everton Lenger Over a year ago

Wow, it works, but I had to put an uppercase J in JQuery. Is it the way to go?

Mat Lipe · Accepted Answer · 2019-02-11 21:53:25Z

1

Turns out the Typescript for jQuery uses an Uppercase J so JQuery instead of jQuery.

Changing the jsdoc like so fixes this issue.

/**
 * @param {JQuery} $button
 */

Otherwise the lowercase jQuery may be enabled by creating a very simple typescript file somewhere in your project.

For example your file could be named jquery.d.ts and have the following content.

/**
 * Must have the @types/jquery typescript installed
 * either via PHPStorm -> Javascript -> Libraries
 * or `npm i @types/jquery`
 */
interface jQuery<TElement = HTMLElement> extends JQuery {}

edited Feb 11, 2019 at 21:53

answered Feb 11, 2019 at 21:39

Mat Lipe

83710 silver badges15 bronze badges

Collectives™ on Stack Overflow

PhpStorm warnings with jQuery parameters

2 Answers 2

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related