@hashgraph/solo
Preparing search index...
src/core/config/remote/api/components-data-wrapper-api
ComponentsDataWrapperApi
Interface ComponentsDataWrapperApi
interface
ComponentsDataWrapperApi
{
state
:
DeploymentStateSchema
;
addNewComponent
(
component
:
BaseStateSchema
,
type
:
ComponentTypes
)
:
void
;
changeNodePhase
(
componentId
:
number
,
phase
:
DeploymentPhase
)
:
void
;
getComponent
<
T
extends
BaseStateSchema
>
(
type
:
ComponentTypes
,
componentId
:
number
,
)
:
T
;
getComponentById
<
T
extends
BaseStateSchema
>
(
type
:
ComponentTypes
,
id
:
number
,
)
:
T
;
getComponentsByClusterReference
<
T
extends
BaseStateSchema
>
(
type
:
ComponentTypes
,
clusterReference
:
string
,
)
:
T
[]
;
getNewComponentId
(
componentType
:
ComponentTypes
)
:
number
;
removeComponent
(
componentId
:
number
,
type
:
ComponentTypes
)
:
void
;
}
Implemented by
ComponentsDataWrapper
Index
Properties
state
Methods
add
New
Component
change
Node
Phase
get
Component
get
Component
By
Id
get
Components
By
Cluster
Reference
get
New
Component
Id
remove
Component
Properties
state
state
:
DeploymentStateSchema
Methods
add
New
Component
addNewComponent
(
component
:
BaseStateSchema
,
type
:
ComponentTypes
)
:
void
Parameters
component
:
BaseStateSchema
type
:
ComponentTypes
Returns
void
change
Node
Phase
changeNodePhase
(
componentId
:
number
,
phase
:
DeploymentPhase
)
:
void
Parameters
componentId
:
number
phase
:
DeploymentPhase
Returns
void
get
Component
getComponent
<
T
extends
BaseStateSchema
>
(
type
:
ComponentTypes
,
componentId
:
number
,
)
:
T
Type Parameters
T
extends
BaseStateSchema
Parameters
type
:
ComponentTypes
componentId
:
number
Returns
T
get
Component
By
Id
getComponentById
<
T
extends
BaseStateSchema
>
(
type
:
ComponentTypes
,
id
:
number
)
:
T
Type Parameters
T
extends
BaseStateSchema
Parameters
type
:
ComponentTypes
id
:
number
Returns
T
get
Components
By
Cluster
Reference
getComponentsByClusterReference
<
T
extends
BaseStateSchema
>
(
type
:
ComponentTypes
,
clusterReference
:
string
,
)
:
T
[]
Type Parameters
T
extends
BaseStateSchema
Parameters
type
:
ComponentTypes
clusterReference
:
string
Returns
T
[]
get
New
Component
Id
getNewComponentId
(
componentType
:
ComponentTypes
)
:
number
Parameters
componentType
:
ComponentTypes
Returns
number
remove
Component
removeComponent
(
componentId
:
number
,
type
:
ComponentTypes
)
:
void
Parameters
componentId
:
number
type
:
ComponentTypes
Returns
void
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Properties
state
Methods
add
New
Component
change
Node
Phase
get
Component
get
Component
By
Id
get
Components
By
Cluster
Reference
get
New
Component
Id
remove
Component
@hashgraph/solo
Loading...