Module: rosetta-converter-config

Methods

(inner) getAllowPassthrough() → {boolean}

Get passthorugh allowed or not in converter configuration.

Source: rosetta-converters/dist/src/config.js, line 90

Returns:

whether passthrough is allowed or not.
Type:
boolean
true = non-recognized formula will be passed through.
false = non-recognized formula will retrun error.

(inner) getCustomAPIDef() → {array}

Get custom API definition JSON array.

Source: rosetta-converters/dist/src/config.js, line 148

Returns:

custom API definition JSON array.

Type:: array

(inner) getNativeness(formula) → {boolean}

Get whether registered formula converted to native or not

Parameters:

Name	Type	Description
`formula`	string	the formula name to check. ('if', 'true', 'false', 'length')

Source: rosetta-converters/dist/src/config.js, line 167

Returns:

whether formula is converted to native or not. For example, if getNativeness('if') true then, formula '@If' will be converted to 'if' instead of 'rosettajs.Logical.if'.

Type:: boolean

(inner) getParamAsFieldName() → {boolean}

Get paramAsFieldName setting in converter configuration.

Source: rosetta-converters/dist/src/config.js, line 130

Returns:

whether paramAsFieldName is allowed or not.
Type:
boolean
true = treat undefined parameter as field name and convert to getField.
false = treat undefined parameter as variable name.

(inner) getReturnFinal() → {boolean}

Get return final statement or not in converter configuration.

Source: rosetta-converters/dist/src/config.js, line 208

Returns:

whether to return final statement or not.
Type:
boolean
true = final statement will return.
false = no return statement.

(inner) getRosettaGateHost() → {string}

Get rosetta gate url for converter to use.

Source: rosetta-converters/dist/src/config.js, line 226

Returns:

the rosetta host url string currently set.

Type:: string

(inner) getRosettaJSname() → {string}

Get rosettajs name for converter to use.

Source: rosetta-converters/dist/src/config.js, line 70

Returns:

the default rosettajs object name string currently set.

Type:: string

(inner) getStripNumbers() → {boolean}

Get stripNumbers setting in converter configuration.

Source: rosetta-converters/dist/src/config.js, line 110

Returns:

whether stripNumbers is allowed or not.
Type:
boolean
true = leading 0 on the number literal will be stripped.
false = leading 0 on the number literal will not be stripped.

(inner) setAllowPassthrough(allow) → {boolean}

Set passthorugh allowed or not in converter configuration.

Parameters:

Name	Type	Description
`allow`	boolean	whether passthrough is allowed or not.

Source: rosetta-converters/dist/src/config.js, line 99

Returns:

setting updated in converter configuration.

Type:: boolean

(inner) setCustomAPIDef(custom) → {array}

Set custom API definition JSON array

Parameters:

Name	Type	Description
`custom`	array	custom API definition JSON array to set.

Source: rosetta-converters/dist/src/config.js, line 157

Returns:

custom API definition JSON array in converter configuration.

Type:: array

(inner) setNativeness(formula, native) → {boolean}

Set registered formula converted to native or not

Parameters:

Name	Type	Description
`formula`	string	the formula name to set. ('if', 'true', 'false', 'length')
`native`	boolean	to set whether formula is converted to native or not.

Source: rosetta-converters/dist/src/config.js, line 180

Returns:

setting updated in converter configuration.

Type:: boolean

(inner) setParamAsFieldName(convert) → {boolean}

Set whether parameter will be converted to getField or not.

Parameters:

Name	Type	Description
`convert`	boolean	whether paramAsFieldName is allowed or not.

Source: rosetta-converters/dist/src/config.js, line 139

Returns:

setting updated in converter configuration.

Type:: boolean

(inner) setReturnFinal(whether) → {boolean}

Set return final statement or not in converter configuration.

Parameters:

Name	Type	Description
`whether`	boolean	to return final statement or not.

Source: rosetta-converters/dist/src/config.js, line 217

Returns:

setting updated in converter configuration.

Type:: boolean

(inner) setRosettaGateHost(_rosettaGateHost) → {string}

Set rosetta gate url for converter to use.

Parameters:

Name	Type	Description
`_rosettaGateHost`	string	rosetta gate url string to set.

Source: rosetta-converters/dist/src/config.js, line 235

Returns:

the rosetta host url string currently set.

Type:: string

(inner) setRosettaJSname(_rosettajs) → {string}

Set rosettajs name for converter to use.

Parameters:

Name	Type	Description
`_rosettajs`	string	the default rosettajs object name string to set.

Source: rosetta-converters/dist/src/config.js, line 79

Returns:

the default rosettajs object name string currently set.

Type:: string

(inner) setStripNumbers(strip) → {boolean}

Set stripNumbers to strip leading 0 on the number literal or not in converter configuration.

Parameters:

Name	Type	Description
`strip`	boolean	whether stripNumbers is allowed or not.

Source: rosetta-converters/dist/src/config.js, line 119

Returns:

setting updated in converter configuration.

Type:: boolean