Constructor
new Parameter(name, schema, description, defaultValue)
Creates a new process parameter.
Parameters:
Name | Type | Description |
---|---|---|
name |
string | Name of the parameter. |
schema |
object.<string, *> | string | The schema for the parameter. Can be either an object compliant to JSON Schema or a string with a JSON Schema compliant data type, e.g. |
description |
string | A description for the parameter |
defaultValue |
* | An optional default Value for the parameter. If set, make the parameter optional. If not set, the parameter is required. Defaults to |
- Source:
Methods
ref() → {FromParameter}
Returns the reference object for this parameter.
- Source:
Returns:
- Type
- FromParameter
toJSON() → {object.<string, *>}
Returns a JSON serializable representation of the data that is API compliant.
- Source:
Returns:
- Type
- object.<string, *>
(static) create(builder, parameterName) → {Proxy.<Parameter>}
Creates a new parameter instance, but proxies calls to it so that array access is possible (see class description).
Parameters:
Name | Type | Description |
---|---|---|
builder |
Builder | |
parameterName |
string |
- Source:
Returns:
- Type
- Proxy.<Parameter>