Constructors
constructor
- new ExampleShape(name, example?): ExampleShape
Parameters
- name: string
Optionalexample: ExampleObject
Properties
Protected Optionaldescription
description?: string
Protected OptionalexternalValue
externalValue?: string
Protectedname
name: string
Protected Optionalsummary
summary?: string
Protectedvalue
value: unknown
Methods
getName
- getName(): string
Returns string
ref
- ref(): ReferenceObject
Returns ReferenceObject
setDescription
- setDescription(description): this
Returns this
setExternalValue
- setExternalValue(externalValue): this
Returns this
setSummary
- setSummary(summary): this
Returns this
setValue
- setValue(value): this
Returns this
toJSON
- toJSON(): ExampleObject
Returns ExampleObject
toObject
- toObject(): ExampleObject
Returns ExampleObject