Class: Param

eclairjs/ml/param.Param

new Param(parent, name, doc)

:: Experimental :: A param with self-contained documentation and optionally default value. Primitive-typed param should use the specialized versions, which are more friendly to Java users.param: parent parent object param: name param name param: doc documentation param: isValid optional validation method which indicates if a value is valid. See ParamValidators for factory methods for common validation functions.
Parameters:
Name Type Description
parent string
name string
doc string
Source:

Methods

doc() → {Promise.<string>}

Source:
Returns:
Type
Promise.<string>

equals(obj) → {Promise.<boolean>}

Parameters:
Name Type Description
obj module:eclairjs/ml/param.Param
Source:
Returns:
Type
Promise.<boolean>

hashCode() → {Promise.<Number>}

Source:
Returns:
Type
Promise.<Number>

jsonDecode(json) → {Promise.<object>}

Decodes a param value from JSON.
Parameters:
Name Type Description
json string
Source:
Returns:
Type
Promise.<object>

jsonEncode(value) → {Promise.<string>}

Encodes a param value into JSON, which can be decoded by jsonDecode().
Parameters:
Name Type Description
value object
Source:
Returns:
Type
Promise.<string>

name() → {Promise.<string>}

Source:
Returns:
Type
Promise.<string>

parent() → {Promise.<string>}

Source:
Returns:
Type
Promise.<string>

toString() → {Promise.<string>}

Source:
Returns:
Type
Promise.<string>

w(value) → {module:eclairjs/ml/param.ParamPair}

Creates a param pair with the given value
Parameters:
Name Type Description
value object
Source:
Returns:
Type
module:eclairjs/ml/param.ParamPair