PhpStorm JS inspection - JS variable coming from backend

Question

I wanted to take some time to "clean" a personal app, to remove most of the warnings, etc.

As stated in the title I use the PhpStorm IDE and I have some warnings "Unresolved variable slug" when I use series.slug. The variable series comes from either a JSON from a PHP Class or after an Ajax call.

Is there a way to indicate an object's properties or to link a js variable to a PHP class (like in Twig)?

P.S. In my "Settings > Languages > JS > Code Quality Tools", I have nothing enabled, I just have the "basic" PhpStorm inspection.

lena · Accepted Answer · 2019-05-19 08:11:04Z

2

If you use some object with keys only known in runtime (generated, received through the ajax call, etc.) in your code, there is no way for the IDE to resolve them using static code analysis. But you can let the IDE know what your runtime data looks like. Possible solution using JSDoc annotations:

/**
 * @typedef {Object} series
 * @property {string} slug
 * ... other series props here....
 */
...

/**
 * function that uses series data
 * @param {series} data
 */
function foo (data){...}

See also https://youtrack.jetbrains.com/issue/WEB-17419#comment=27-1058451, https://intellij-support.jetbrains.com/hc/en-us/community/posts/206349469-disable-unresolved-variable-on-json-object-received-by-ajax-call for other possible workarounds

answered May 19, 2019 at 8:11

lena

94.4k11 gold badges154 silver badges160 bronze badges

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

1 Comment

Etshy Over a year ago

Thanks a lot, I'll take a look at JSDoc, but it seems it could solve the problem.

Collectives™ on Stack Overflow

PhpStorm JS inspection - JS variable coming from backend

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related