JSDoc inline return type with anonymous functions

[Hochhaus, Andy]

Hello,

How do you write a JSDoc inline return type with an anonymous function? Neither of the following seem to work?

goog.module('example');

exports.foo = /** boolean */ function() { return true; };

exports.bar = function /** boolean */ () { return true; };

-Andy

[Erik Neumann]

Try this:

exports.foo = /** @type function(): boolean */ (function() { return true; });

The @type might be optional so this might also work:

exports.foo = /** function(): boolean */ (function() { return true; });

The parens around the value (in this case the function) are required for any type cast.

See the section "Type Expressions" near the end of this page:

https://github.com/google/closure-compiler/wiki/Annotating-JavaScript-for-the-Closure-Compiler

or this:

https://github.com/google/closure-compiler/wiki/Types-in-the-Closure-Type-System

The latter page has a section about "Type Casts".

--ErikN

--

---
You received this message because you are subscribed to the Google Groups "Closure Compiler Discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to closure-compiler-discuss+unsub...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/closure-compiler-discuss/CAAhqAFp1T87%3DPTz3tQPzgLx0sFG5p61f_TA6bV1T%2Bx8Ek5hD9A%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

[John Munro]

exports.foo = /** @return {boolean} */ function() { return true; };

[Hochhaus, Andy]

Thanks.

Type casting the function seems minorly excessive to document the return type.

Using '@return' works but seems overly verbose given that function params can be annotated inline without using '@param' or '@type'.

According to the docs, named functions can document their return type as follows:

function /** number */ foo(x) { return x - 1; }

Does any corresponding syntax exist for anonymous functions (i.e. without requiring explicitly stating '@return')?

-Andy

[Tyler Breisacher]

I don't think so. One approach would be to give it a short name such as perhaps "_" :

function /** number */ _(x) { return x - 1; }

--

---
You received this message because you are subscribed to the Google Groups "Closure Compiler Discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to closure-compiler-discuss+unsub...@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/closure-compiler-discuss/CAAhqAFr25HviphAjKFW_rOYqRnjL%2BcKn-r1a0SUu2n1OjOYWyA%40mail.gmail.com.

[Hochhaus, Andy]

On Mon, Dec 5, 2016 at 10:20 AM, 'Tyler Breisacher' via Closure
Compiler Discuss <closure-comp...@googlegroups.com> wrote:
> I don't think so. One approach would be to give it a short name such as perhaps "_" :

Sounds like the best work around. Thanks.