@novice1/frame - v0.3.1
Preparing search index...
ExampleShape
Class ExampleShape
Index
Constructors
constructor
Properties
description?
external
Value?
name
summary?
value
Methods
get
Name
ref
set
Description
set
External
Value
set
Summary
set
Value
toJSON
to
Object
Constructors
constructor
new
ExampleShape
(
name
:
string
,
example
?:
ExampleObject
)
:
ExampleShape
Parameters
name
:
string
Optional
example
:
ExampleObject
Returns
ExampleShape
Properties
Protected
Optional
description
description
?:
string
Protected
Optional
external
Value
externalValue
?:
string
Protected
name
name
:
string
Protected
Optional
summary
summary
?:
string
Protected
value
value
:
unknown
Methods
get
Name
getName
()
:
string
Returns
string
ref
ref
()
:
ReferenceObject
Returns
ReferenceObject
set
Description
setDescription
(
description
:
string
)
:
this
Parameters
description
:
string
Returns
this
set
External
Value
setExternalValue
(
externalValue
:
string
)
:
this
Parameters
externalValue
:
string
Returns
this
set
Summary
setSummary
(
summary
:
string
)
:
this
Parameters
summary
:
string
Returns
this
set
Value
setValue
(
value
:
unknown
)
:
this
Parameters
value
:
unknown
Returns
this
toJSON
toJSON
()
:
ExampleObject
Returns
ExampleObject
to
Object
toObject
()
:
ExampleObject
Returns
ExampleObject
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
description
external
Value
name
summary
value
Methods
get
Name
ref
set
Description
set
External
Value
set
Summary
set
Value
toJSON
to
Object
@novice1/frame - v0.3.1
Loading...