How to annotate anonymous object with optional property in JSDoc

Question

I have a JavaScript class that takes one argument of type Object with defined set of properties and the Closure Compiler is happy when I annotate it like:

@constructor
@param {{ subview:BaseView, el:(jQuery|Element), title:String }} options
var MyView = function(options){ }

I would like to make title key optional and pass title value to some instances of my class and implement fallback behavior when this key is not present, so I annotated my class with:

@constructor
@param {{ subview:BaseView, el:(jQuery|Element), title:String= }} options
var MyView = function(options){ }

and now Closure Compiler is complaining:

WARNING - Bad type annotation. expected closing }

I've checked Annotating JavaScript for the Closure Compiler, but I see no single line describing such use case.

I think the = modifier is only valid for function parameters, not for record type properties. — Bergi
– Bergi, Commented Sep 10, 2014 at 19:17

Tyler · Accepted Answer · 2014-09-11 03:13:28Z

27

@param {{ subview:BaseView, el:(jQuery|Element), title:(string|undefined) }} options

answered Sep 11, 2014 at 3:13

Tyler

22.2k11 gold badges66 silver badges92 bronze badges

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

2 Comments

Noitidart Over a year ago

Instead of |undefined shouldn't it be title?:string?

Tyler Over a year ago

Not for Closure Compiler, no.

Collectives™ on Stack Overflow

How to annotate anonymous object with optional property in JSDoc

1 Answer 1

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related