Constructor
new OptionsExporter()
Creates an instance of the OptionsExporter class.
Source
Methods
export(optionsResponse, outputConfigopt) → {Map.<String, {base: String, extending: String}>}
Parameters
-
optionsResponse
ResponseThe response to an
OptionsRequest. -
outputConfig
Object<optional>
Configuration options for writing results to a directory.
Returns
-
Map.<String, {base: String, extending: String}>
Source
makePropertyJSDoc(property, definition, indentLevelopt, indentFirstLineopt) → {String}
Creates a string representation of the property definition object.
Parameters
-
property
StringThe property name.
-
definition
Modeling.PropertyDefinitionThe property definition object.
-
indentLevel
Number<optional>
0The level of indent applied to contents (4-spaces per level).
-
indentFirstLine
Boolean<optional>
falseEnable or disable indenting the first line of the returned string.
Returns
-
String
Source
toJavascriptPropertyDefaultReference(className, propertyName, definition) → {String}
Creates a string representation of the property definition object.
Parameters
-
className
StringThe name of the model class.
-
propertyName
StringThe name of the property we are creating a default value for.
-
definition
Modeling.PropertyDefinitionThe StashKu property definition.
Returns
-
String
Source
toJavaScriptString(value, indentLevelopt, indentFirstLineopt) → {String}
Converts a supported StashKu model property value to a string representation.
Parameters
-
value
*The value to be converted to a string.
-
indentLevel
Number<optional>
0The level of indent applied to contents (4-spaces per level).
-
indentFirstLine
Boolean<optional>
falseEnable or disable indenting the first line of the returned string.
Returns
-
String