Class ComponentsDataWrapper

constructor

• new ComponentsDataWrapper(state: DeploymentStateSchema): ComponentsDataWrapper

  Parameters

  • state: DeploymentStateSchema

  Returns ComponentsDataWrapper

state

addNewComponent

• addNewComponent(component: BaseStateSchema, type: ComponentTypes): void

  Used to add new component to their respective group.

  Parameters

  • component: BaseStateSchema
  • type: ComponentTypes

  Returns void

changeNodePhase

• changeNodePhase(componentId: number, phase: DeploymentPhase): void

  Parameters

  • componentId: number
  • phase: DeploymentPhase

  Returns void

getComponent

• getComponent<T extends BaseStateSchema>(
      type: ComponentTypes,
      componentId: number,
  ): T

  Type Parameters

  • T extends BaseStateSchema

  Parameters

  • type: ComponentTypes
  • componentId: number

  Returns T

getComponentById

• getComponentById<T extends BaseStateSchema>(type: ComponentTypes, id: number): T

  Type Parameters

  • T extends BaseStateSchema

  Parameters

  • type: ComponentTypes
  • id: number

  Returns T

getComponentsByClusterReference

• getComponentsByClusterReference<T extends BaseStateSchema>(
      type: ComponentTypes,
      clusterReference: string,
  ): T[]

  Type Parameters

  • T extends BaseStateSchema

  Parameters

  • type: ComponentTypes
  • clusterReference: string

  Returns T[]

getNewComponentId

• getNewComponentId(componentType: ComponentTypes): number

  Checks all existing components of specified type and gives you a new unique index

  Parameters

  • componentType: ComponentTypes

  Returns number

removeComponent

• removeComponent(componentId: number, type: ComponentTypes): void

  Used to remove specific component from their respective group.

  Parameters

  • componentId: number
  • type: ComponentTypes

  Returns void