Returns representation of this example as JSON object.
This works for examples being JSON strings and YAML objects.
It -may- work for XML string examples, but is not guaranteed.
Returns any
asString
asString(): string
Returns representation of this example as a string.
This method works for any type of example.
Returns string
description
description(): string
Returns string
displayName
displayName(): string
Returns string
expandAsJSON
expandAsJSON(): any
Expands the example with what its application references can provide.
XML examples are not guaranteed to be supported. If supported, XML is convrted into JSON.
Returns null or expansion result as JSON object.
Returns any
expandAsString
expandAsString(): string
Expands the example with what its application references can provide.
XML examples are not guaranteed to be supported. If supported, XML is convrted into JSON.
Returns null or expansion result as string.
Returns string
isEmpty
isEmpty(): boolean
Returns true if the application in question does not have an example set directly.
It is still possible that while application has no direct example, references may have
example pieces, current example may be expanded with.
Returns boolean
isJSONString
isJSONString(): boolean
Whether the original example is JSON string.
Returns boolean
isSingle
isSingle(): boolean
Returns boolean
isXMLString
isXMLString(): boolean
Whether the original example is XML string.
Returns boolean
isYAML
isYAML(): boolean
Whether original example is set up as YAML.
Returns boolean
name
name(): string
Returns string
original
original(): any
Returns an original example. It is string for XML and JSON strings,
or JSON object for YAML example.
Returns representation of this example as JSON object. This works for examples being JSON strings and YAML objects. It -may- work for XML string examples, but is not guaranteed.