• function

NAME documentjs/name

 

[name(args...)=default]

[success(item)=updater]

Parameters

  1. name {String}

    Provides the name of the type.

  2. [] {String}

    Indicates that the option or param is optional.

  3. (args...) {String}

    If name is a function, () provides the names of each argument.

  4. '...' {String}

    An argument is variable. The argument can be given 0 or more times.

  5. =default {String}

    =default provides the default value for the type. For example:

    /**
     * @param {Number} [age=0]
     */

Provides the NAME of a [documentjs/tags/param @param] or [documentjs/tags/param @option].