Methods
add(value, basenameopt) → {string}
Adds a given value, optionally with a given (base) name.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
value |
* | Value to add to the component being managed. | |
basename |
string |
<optional> |
Preferred name for value in component. (getNames). |
- Source:
Returns:
Name of added value.
- Type
- string
add(value, basenameopt) → {string}
Adds a given value, optionally with a given (base) name.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
value |
* | Value to add to the component being managed. | |
basename |
string |
<optional> |
Preferred name for value in component. (ComponentManager#getNames). |
- Source:
Returns:
Name of added value.
- Type
- string
(generator) getNames(basenameopt) → {string}
Gets property names to check for a given base name.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
basename |
string |
<optional> |
Base name to use for property. |
- Source:
Yields:
Property names to check for #add().
- Type
- string
isMatch() → {boolean}
Determines if given values match such that an existing value can be used
in place of an added value.
Overridden to always return false, since values which do not have equal
keys do not match (according to this class) and keys are checked before
calling super.add().
FIXME: This optimization is useful to avoid wasting lots of cycles
for properties with many name conflicts with deep values, but it is
also a foot-gun if isMatch is called unexpectedly. Find a better fix.
- Source:
Returns:
False.
- Type
- boolean
stripClientXMsParamLoc(parameteropt) → {object}
Gets a copy of a parameter with x-ms-parameter-location removed if
its value is 'client'.
Autorest treats defined parameters as properties on the client by default.
(i.e. the same as x-ms-parameter-location:client) Therefore, remove
x-ms-parameter-location:client when comparing/keying parameters so
it doesn't affect equality.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
parameter |
object |
<optional> |
Parameter Object to strip. |
- Source:
Returns:
Copy of parameter with x-ms-parameter-location removed if
its value is 'client'. Otherwise, parameter.
- Type
- object