How to use @template with destructured arguments in JSDoc/Typescript





.everyoneloves__top-leaderboard:empty,.everyoneloves__mid-leaderboard:empty,.everyoneloves__bot-mid-leaderboard:empty{ height:90px;width:728px;box-sizing:border-box;
}







0















in typescript i can do something like this:



const foo = <T>({ someArg }: { someArg: T }) => someArg

foo({ someArg: 4 }) // returns a number
foo({ someArg: "cool" }) // returns a string


how do i do the equivalent with jsdoc / checkjs? i assumed it would look like:



/**
* @template T
*
* @param {object} props
* @param {T} props.someArg
* @returns {T}
*/
const foo = ({ someArg }) => someArg

foo({ someArg: 4 })
foo({ someArg: 'cool' })


but i get an error that looks like this:



src/components/example.js:10:7 - error TS2322: Type 'number' is not assignable to type 'T'.

10 foo({ someArg: 4 })
~~~~~~~

src/components/example.js:5:4
5 * @param {T} props.someArg
~~~~~~~~~~~~~~~~~~~~~~~~
6 * @returns {T}
~~~
The expected type comes from property 'someArg' which is declared here on type '{ someArg: T; }'

src/components/example.js:11:7 - error TS2322: Type 'string' is not assignable to type 'T'.

11 foo({ someArg: 'cool' })
~~~~~~~

src/components/example.js:5:4
5 * @param {T} props.someArg
~~~~~~~~~~~~~~~~~~~~~~~~
6 * @returns {T}
~~~
The expected type comes from property 'someArg' which is declared here on type '{ someArg: T; }'
~~~~~~~


not destructuring the args seems to work a-ok:



/**
* @template T
*
* @param {object} props
* @param {T} props.someArg
* @returns {T}
*/
const foo = props => props.someArg


update - i think it's likely this issue:
Generic types from JSDoc aren't really generic










share|improve this question































    0















    in typescript i can do something like this:



    const foo = <T>({ someArg }: { someArg: T }) => someArg

    foo({ someArg: 4 }) // returns a number
    foo({ someArg: "cool" }) // returns a string


    how do i do the equivalent with jsdoc / checkjs? i assumed it would look like:



    /**
    * @template T
    *
    * @param {object} props
    * @param {T} props.someArg
    * @returns {T}
    */
    const foo = ({ someArg }) => someArg

    foo({ someArg: 4 })
    foo({ someArg: 'cool' })


    but i get an error that looks like this:



    src/components/example.js:10:7 - error TS2322: Type 'number' is not assignable to type 'T'.

    10 foo({ someArg: 4 })
    ~~~~~~~

    src/components/example.js:5:4
    5 * @param {T} props.someArg
    ~~~~~~~~~~~~~~~~~~~~~~~~
    6 * @returns {T}
    ~~~
    The expected type comes from property 'someArg' which is declared here on type '{ someArg: T; }'

    src/components/example.js:11:7 - error TS2322: Type 'string' is not assignable to type 'T'.

    11 foo({ someArg: 'cool' })
    ~~~~~~~

    src/components/example.js:5:4
    5 * @param {T} props.someArg
    ~~~~~~~~~~~~~~~~~~~~~~~~
    6 * @returns {T}
    ~~~
    The expected type comes from property 'someArg' which is declared here on type '{ someArg: T; }'
    ~~~~~~~


    not destructuring the args seems to work a-ok:



    /**
    * @template T
    *
    * @param {object} props
    * @param {T} props.someArg
    * @returns {T}
    */
    const foo = props => props.someArg


    update - i think it's likely this issue:
    Generic types from JSDoc aren't really generic










    share|improve this question



























      0












      0








      0








      in typescript i can do something like this:



      const foo = <T>({ someArg }: { someArg: T }) => someArg

      foo({ someArg: 4 }) // returns a number
      foo({ someArg: "cool" }) // returns a string


      how do i do the equivalent with jsdoc / checkjs? i assumed it would look like:



      /**
      * @template T
      *
      * @param {object} props
      * @param {T} props.someArg
      * @returns {T}
      */
      const foo = ({ someArg }) => someArg

      foo({ someArg: 4 })
      foo({ someArg: 'cool' })


      but i get an error that looks like this:



      src/components/example.js:10:7 - error TS2322: Type 'number' is not assignable to type 'T'.

      10 foo({ someArg: 4 })
      ~~~~~~~

      src/components/example.js:5:4
      5 * @param {T} props.someArg
      ~~~~~~~~~~~~~~~~~~~~~~~~
      6 * @returns {T}
      ~~~
      The expected type comes from property 'someArg' which is declared here on type '{ someArg: T; }'

      src/components/example.js:11:7 - error TS2322: Type 'string' is not assignable to type 'T'.

      11 foo({ someArg: 'cool' })
      ~~~~~~~

      src/components/example.js:5:4
      5 * @param {T} props.someArg
      ~~~~~~~~~~~~~~~~~~~~~~~~
      6 * @returns {T}
      ~~~
      The expected type comes from property 'someArg' which is declared here on type '{ someArg: T; }'
      ~~~~~~~


      not destructuring the args seems to work a-ok:



      /**
      * @template T
      *
      * @param {object} props
      * @param {T} props.someArg
      * @returns {T}
      */
      const foo = props => props.someArg


      update - i think it's likely this issue:
      Generic types from JSDoc aren't really generic










      share|improve this question
















      in typescript i can do something like this:



      const foo = <T>({ someArg }: { someArg: T }) => someArg

      foo({ someArg: 4 }) // returns a number
      foo({ someArg: "cool" }) // returns a string


      how do i do the equivalent with jsdoc / checkjs? i assumed it would look like:



      /**
      * @template T
      *
      * @param {object} props
      * @param {T} props.someArg
      * @returns {T}
      */
      const foo = ({ someArg }) => someArg

      foo({ someArg: 4 })
      foo({ someArg: 'cool' })


      but i get an error that looks like this:



      src/components/example.js:10:7 - error TS2322: Type 'number' is not assignable to type 'T'.

      10 foo({ someArg: 4 })
      ~~~~~~~

      src/components/example.js:5:4
      5 * @param {T} props.someArg
      ~~~~~~~~~~~~~~~~~~~~~~~~
      6 * @returns {T}
      ~~~
      The expected type comes from property 'someArg' which is declared here on type '{ someArg: T; }'

      src/components/example.js:11:7 - error TS2322: Type 'string' is not assignable to type 'T'.

      11 foo({ someArg: 'cool' })
      ~~~~~~~

      src/components/example.js:5:4
      5 * @param {T} props.someArg
      ~~~~~~~~~~~~~~~~~~~~~~~~
      6 * @returns {T}
      ~~~
      The expected type comes from property 'someArg' which is declared here on type '{ someArg: T; }'
      ~~~~~~~


      not destructuring the args seems to work a-ok:



      /**
      * @template T
      *
      * @param {object} props
      * @param {T} props.someArg
      * @returns {T}
      */
      const foo = props => props.someArg


      update - i think it's likely this issue:
      Generic types from JSDoc aren't really generic







      typescript jsdoc checkjs






      share|improve this question















      share|improve this question













      share|improve this question




      share|improve this question








      edited Nov 29 '18 at 22:52







      schpet

















      asked Nov 26 '18 at 21:24









      schpetschpet

      3,00411929




      3,00411929
























          0






          active

          oldest

          votes












          Your Answer






          StackExchange.ifUsing("editor", function () {
          StackExchange.using("externalEditor", function () {
          StackExchange.using("snippets", function () {
          StackExchange.snippets.init();
          });
          });
          }, "code-snippets");

          StackExchange.ready(function() {
          var channelOptions = {
          tags: "".split(" "),
          id: "1"
          };
          initTagRenderer("".split(" "), "".split(" "), channelOptions);

          StackExchange.using("externalEditor", function() {
          // Have to fire editor after snippets, if snippets enabled
          if (StackExchange.settings.snippets.snippetsEnabled) {
          StackExchange.using("snippets", function() {
          createEditor();
          });
          }
          else {
          createEditor();
          }
          });

          function createEditor() {
          StackExchange.prepareEditor({
          heartbeatType: 'answer',
          autoActivateHeartbeat: false,
          convertImagesToLinks: true,
          noModals: true,
          showLowRepImageUploadWarning: true,
          reputationToPostImages: 10,
          bindNavPrevention: true,
          postfix: "",
          imageUploader: {
          brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
          contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
          allowUrls: true
          },
          onDemand: true,
          discardSelector: ".discard-answer"
          ,immediatelyShowMarkdownHelp:true
          });


          }
          });














          draft saved

          draft discarded


















          StackExchange.ready(
          function () {
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53489296%2fhow-to-use-template-with-destructured-arguments-in-jsdoc-typescript%23new-answer', 'question_page');
          }
          );

          Post as a guest















          Required, but never shown

























          0






          active

          oldest

          votes








          0






          active

          oldest

          votes









          active

          oldest

          votes






          active

          oldest

          votes
















          draft saved

          draft discarded




















































          Thanks for contributing an answer to Stack Overflow!


          • Please be sure to answer the question. Provide details and share your research!

          But avoid



          • Asking for help, clarification, or responding to other answers.

          • Making statements based on opinion; back them up with references or personal experience.


          To learn more, see our tips on writing great answers.




          draft saved


          draft discarded














          StackExchange.ready(
          function () {
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53489296%2fhow-to-use-template-with-destructured-arguments-in-jsdoc-typescript%23new-answer', 'question_page');
          }
          );

          Post as a guest















          Required, but never shown





















































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown

































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown







          Popular posts from this blog

          To store a contact into the json file from server.js file using a class in NodeJS

          Redirect URL with Chrome Remote Debugging Android Devices

          Dieringhausen