@typedef

  • constructor
documentjs.tags.typedef  

Declares an alias for a more complex type. That alias can be used in TYPE declarations.

@typedef {TYPE} NAME [TITLE] 

/**
 * @typedef {{}} lib/componentProps props
 * @option {String} name The name of the component.
 * @option {String} title The title of the component.
 */

Parameters

  1. TYPE {TYPE-EXPRESSION}Optional

    A type expression. This is typically an object specified like: {{}}.

  2. NAME {String}

    The name of the type.

  3. TITLE {String}

    The title of the type used for display purposes.