JSdoc how to tell that a function returns the same type as a parameter











up vote
2
down vote

favorite
2












in C# you would write



T RandomFrom< T >( List< T > list ) {
return list[ ( int ) Math.Floor( new Random().Next() * list.Count ) ];
}


How should I do the same when documenting a JS function?
I tried:



/**
* @type {*} T
* @param {T} list
* @returns {T}
*/
function randomFrom ( list ) {
return list[ Math.floor( Math.random() * list.length ) ];
}


But VS Code tells me randomFrom(list: any): any and I'd like it to be something like randomFrom(list: <T>): <T>. How do I achieve that? Putting the T inside <> makes it an arrow function.










share|improve this question
























  • Have you tried combining with a @typedef JSDoc block?
    – customcommander
    Nov 13 at 12:47















up vote
2
down vote

favorite
2












in C# you would write



T RandomFrom< T >( List< T > list ) {
return list[ ( int ) Math.Floor( new Random().Next() * list.Count ) ];
}


How should I do the same when documenting a JS function?
I tried:



/**
* @type {*} T
* @param {T} list
* @returns {T}
*/
function randomFrom ( list ) {
return list[ Math.floor( Math.random() * list.length ) ];
}


But VS Code tells me randomFrom(list: any): any and I'd like it to be something like randomFrom(list: <T>): <T>. How do I achieve that? Putting the T inside <> makes it an arrow function.










share|improve this question
























  • Have you tried combining with a @typedef JSDoc block?
    – customcommander
    Nov 13 at 12:47













up vote
2
down vote

favorite
2









up vote
2
down vote

favorite
2






2





in C# you would write



T RandomFrom< T >( List< T > list ) {
return list[ ( int ) Math.Floor( new Random().Next() * list.Count ) ];
}


How should I do the same when documenting a JS function?
I tried:



/**
* @type {*} T
* @param {T} list
* @returns {T}
*/
function randomFrom ( list ) {
return list[ Math.floor( Math.random() * list.length ) ];
}


But VS Code tells me randomFrom(list: any): any and I'd like it to be something like randomFrom(list: <T>): <T>. How do I achieve that? Putting the T inside <> makes it an arrow function.










share|improve this question















in C# you would write



T RandomFrom< T >( List< T > list ) {
return list[ ( int ) Math.Floor( new Random().Next() * list.Count ) ];
}


How should I do the same when documenting a JS function?
I tried:



/**
* @type {*} T
* @param {T} list
* @returns {T}
*/
function randomFrom ( list ) {
return list[ Math.floor( Math.random() * list.length ) ];
}


But VS Code tells me randomFrom(list: any): any and I'd like it to be something like randomFrom(list: <T>): <T>. How do I achieve that? Putting the T inside <> makes it an arrow function.







jsdoc






share|improve this question















share|improve this question













share|improve this question




share|improve this question








edited Nov 11 at 20:52

























asked Nov 11 at 19:27









Flutterish

389




389












  • Have you tried combining with a @typedef JSDoc block?
    – customcommander
    Nov 13 at 12:47


















  • Have you tried combining with a @typedef JSDoc block?
    – customcommander
    Nov 13 at 12:47
















Have you tried combining with a @typedef JSDoc block?
– customcommander
Nov 13 at 12:47




Have you tried combining with a @typedef JSDoc block?
– customcommander
Nov 13 at 12:47

















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',
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%2f53252381%2fjsdoc-how-to-tell-that-a-function-returns-the-same-type-as-a-parameter%23new-answer', 'question_page');
}
);

Post as a guest















Required, but never shown






























active

oldest

votes













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.





Some of your past answers have not been well-received, and you're in danger of being blocked from answering.


Please pay close attention to the following guidance:


  • 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%2f53252381%2fjsdoc-how-to-tell-that-a-function-returns-the-same-type-as-a-parameter%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

Xamarin.iOS Cant Deploy on Iphone

Glorious Revolution

Dulmage-Mendelsohn matrix decomposition in Python