Class LocalConfigDataWrapper

constructor

• new LocalConfigDataWrapper(
      userEmailAddress: `${string}@${string}.${string}`,
      soloVersion: string,
      deployments: Deployments,
      clusterReferences: ClusterReferences,
  ): LocalConfigDataWrapper

  Parameters

  • userEmailAddress: `${string}@${string}.${string}`
  • soloVersion: string
  • deployments: Deployments
  • clusterReferences: ClusterReferences

  Returns LocalConfigDataWrapper

Static ReadonlyALLOWED_KEYS

clusterRefs

• get clusterRefs(): ClusterReferences

  Returns ClusterReferences

deployments

• get deployments(): Deployments

  Returns Deployments

soloVersion

• get soloVersion(): string

  Returns string

userEmailAddress

• get userEmailAddress(): `${string}@${string}.${string}`

  Returns `${string}@${string}.${string}`

addClusterRef

• addClusterRef(clusterReference: string, context: string): void

  Parameters

  • clusterReference: string
  • context: string

  Returns void

addClusterRefToDeployment

• addClusterRefToDeployment(clusterReference: string, deployment: string): void

  Parameters

  • clusterReference: string
  • deployment: string

  Returns void

addDeployment

• addDeployment(deployment: string, namespace: NamespaceName): void

  Parameters

  • deployment: string
  • namespace: NamespaceName

  Returns void

removeClusterRef

• removeClusterRef(clusterReference: string): void

  Parameters

  • clusterReference: string

  Returns void

removeDeployment

• removeDeployment(deployment: string): void

  Parameters

  • deployment: string

  Returns void

toObject

• toObject(): LocalConfigData

  Converts the class instance to a plain object.

  Returns LocalConfigData

  the plain object representation of the class.

validate

• validate(): void

  Validates all properties of the class and throws if data is invalid

  Returns void