Search code examples
javascriptjsdoc

How do you document an array of objects as a parameter in JSDoc?

I have an array that looks like this:

[{
    "name": "c917379",
    "email": "[email protected]"

},
{
    "name": "c917389",
    "email": "[email protected]"
}]

It is an array of arbitrary length with a number of repeating fields (I've reduced this to two fields for clarity). This gets passed into a JavaScript method. 

/**
 * @param {?}  data
 */
update:  function(data) {...}

I was wondering how you would document this in JSDoc. Ie. how would you document the type where the question mark is?

Solution

  • I just figured out the answer to my question :

    It would look like this :

    /**
 *
 * @param {{name:string, email:string}[]}  
 *
 */