valueData typedef
Data related to a value in a type expression.
Object
Options
-
types
{Array<typeData>}
:The allowed types of the value. Multiple types can be specified like:
{Boolean|Array}
-
name
{String}
:Set if the value is given a name. This property is set by record type expressions like:
{{PROPERTY_NAME: TYPE, PROPERTY_NAME: TYPE}}
Or by name expressions like:
method(arg1, arg2)
-
description
{String}
:A description associated with the value. This is commonly provided by the @option or @param tag.
-
optional
{Boolean}
:If the type does not need to exist. This can be specified in the type like:
{String=}
Or more commonly in a name expression like:
[NAME]
-
nullable
{Boolean}
:If the type can be null. It is specified with
?
like:{?TYPE}
-
nonnull
{Boolean}
:If the type can not be null. It is specified with
!
like:{!TYPE}
-
variable
{Boolean}
:If multiple values of the type can be provided. This can be specified in the type with
...
like:{function(...Number)}
or:
{function(Number...)}
-
defaultValue
{typeData}
:The default value of the object if it is not provided. This is commonly specified by a name expression like:
[foo="bar"]