Skip to content

@k8slens/extensions

Globals / "src/common/cluster-store" / ClusterStore

Class: ClusterStore#

Hierarchy#

ClusterStore

Index#

Properties#

Accessors#

Methods#

Properties#

activeCluster#

activeCluster: ClusterId

Defined in src/common/cluster-store.ts:77


clusters#

clusters: ObservableMap\Cluster> = observable.map\()

Defined in src/common/cluster-store.ts:79


data#

data: T = {} as T

Inherited from BaseStore.data

Defined in src/common/base-store.ts:24


isLoaded#

isLoaded: boolean = false

Inherited from BaseStore.isLoaded

Defined in src/common/base-store.ts:23


params#

Protected params: BaseStoreParams

Inherited from BaseStore.params

Defined in src/common/base-store.ts:26


removedClusters#

removedClusters: ObservableMap\Cluster> = observable.map\()

Defined in src/common/cluster-store.ts:78


storeConfig#

Protected storeConfig: Config\<ClusterStoreModel>

Inherited from BaseStore.storeConfig

Defined in src/common/base-store.ts:19


syncDisposers#

Protected syncDisposers: Function[] = []

Inherited from BaseStore.syncDisposers

Defined in src/common/base-store.ts:20


whenLoaded#

whenLoaded: Promise\ & { cancel: () => void } = when(() => this.isLoaded)

Inherited from BaseStore.whenLoaded

Defined in src/common/base-store.ts:22

Accessors#

active#

• get active(): Cluster | null

Defined in src/common/cluster-store.ts:131

Returns: Cluster | null


activeClusterId#

• get activeClusterId(): string

Defined in src/common/cluster-store.ts:119

Returns: string


clustersList#

• get clustersList(): Cluster[]

Defined in src/common/cluster-store.ts:123

Returns: Cluster[]


enabledClustersList#

• get enabledClustersList(): Cluster[]

Defined in src/common/cluster-store.ts:127

Returns: Cluster[]


name#

• get name(): string

Inherited from BaseStore.name

Defined in src/common/base-store.ts:36

Returns: string


path#

• get path(): string

Inherited from BaseStore.path

Defined in src/common/base-store.ts:40

Returns: string


syncChannel#

• get syncChannel(): string

Inherited from BaseStore.syncChannel

Defined in src/common/base-store.ts:44

Returns: string

Methods#

addCluster#

addCluster(model: ClusterModel | Cluster): Cluster

Defined in src/common/cluster-store.ts:183

Parameters:

Name Type
model ClusterModel | Cluster

Returns: Cluster


addClusters#

addClusters(...models: ClusterModel[]): Cluster[]

Defined in src/common/cluster-store.ts:173

Parameters:

Name Type
...models ClusterModel[]

Returns: Cluster[]


applyWithoutSync#

ProtectedapplyWithoutSync(callback: () => void): void

Inherited from BaseStore.applyWithoutSync

Defined in src/common/base-store.ts:120

Parameters:

Name Type
callback () => void

Returns: void


cwd#

Protectedcwd(): string

Inherited from BaseStore.cwd

Defined in src/common/base-store.ts:71

Returns: string


disableSync#

disableSync(): void

Inherited from BaseStore.disableSync

Defined in src/common/base-store.ts:115

Returns: void


enableSync#

enableSync(): void

Inherited from BaseStore.enableSync

Defined in src/common/base-store.ts:83

Returns: void


fromStore#

ProtectedfromStore(__namedParameters?: { activeCluster: string ; clusters: ClusterModel[] = [] }): void

Overrides BaseStore.fromStore

Defined in src/common/cluster-store.ts:221

Parameters:

Name Type Default value
__namedParameters { activeCluster: string ; clusters: ClusterModel[] = [] } {}

Returns: void


getById#

getById(id: ClusterId): Cluster

Defined in src/common/cluster-store.ts:162

Parameters:

Name Type
id ClusterId

Returns: Cluster


getByWorkspaceId#

getByWorkspaceId(workspaceId: string): Cluster[]

Defined in src/common/cluster-store.ts:166

Parameters:

Name Type
workspaceId string

Returns: Cluster[]


getSubFrames#

ProtectedgetSubFrames(): Promise\

Inherited from BaseStore.getSubFrames

Defined in src/common/base-store.ts:164

Returns: Promise\


hasClusters#

hasClusters(): boolean

Defined in src/common/cluster-store.ts:158

Returns: boolean


init#

Protectedinit(): Promise\

Inherited from BaseStore.init

Defined in src/common/base-store.ts:48

Returns: Promise\


isActive#

isActive(id: ClusterId): boolean

Defined in src/common/cluster-store.ts:135

Parameters:

Name Type
id ClusterId

Returns: boolean


load#

load(): Promise\

Inherited from BaseStore.load

Defined in src/common/base-store.ts:58

Returns: Promise\


onModelChange#

ProtectedonModelChange(model: ClusterStoreModel): Promise\

Inherited from BaseStore.onModelChange

Defined in src/common/base-store.ts:135

Parameters:

Name Type
model ClusterStoreModel

Returns: Promise\


onSync#

ProtectedonSync(model: ClusterStoreModel): void

Inherited from BaseStore.onSync

Defined in src/common/base-store.ts:128

Parameters:

Name Type
model ClusterStoreModel

Returns: void


onSyncFromMain#

ProtectedonSyncFromMain(model: ClusterStoreModel): void

Inherited from BaseStore.onSyncFromMain

Defined in src/common/base-store.ts:105

Parameters:

Name Type
model ClusterStoreModel

Returns: void


pushState#

pushState(): void

Defined in src/common/cluster-store.ts:113

Returns: void


pushStateToViewsPeriodically#

ProtectedpushStateToViewsPeriodically(): void

Defined in src/common/cluster-store.ts:91

Returns: void


registerIpcListener#

registerIpcListener(): void

Defined in src/common/cluster-store.ts:100

Returns: void


removeById#

removeById(clusterId: ClusterId): Promise\

Defined in src/common/cluster-store.ts:198

Parameters:

Name Type
clusterId ClusterId

Returns: Promise\


removeByWorkspaceId#

removeByWorkspaceId(workspaceId: string): void

Defined in src/common/cluster-store.ts:214

Parameters:

Name Type
workspaceId string

Returns: void


removeCluster#

removeCluster(model: ClusterModel): Promise\

Defined in src/common/cluster-store.ts:193

Parameters:

Name Type
model ClusterModel

Returns: Promise\


saveToFile#

ProtectedsaveToFile(model: ClusterStoreModel): Promise\

Inherited from BaseStore.saveToFile

Defined in src/common/base-store.ts:75

Parameters:

Name Type
model ClusterStoreModel

Returns: Promise\


setActive#

setActive(id: ClusterId): void

Defined in src/common/cluster-store.ts:140

Parameters:

Name Type
id ClusterId

Returns: void


swapIconOrders#

swapIconOrders(workspace: WorkspaceId, from: number, to: number): void

Defined in src/common/cluster-store.ts:145

Parameters:

Name Type
workspace WorkspaceId
from number
to number

Returns: void


syncToWebViews#

ProtectedsyncToWebViews(model: ClusterStoreModel): Promise\

Inherited from BaseStore.syncToWebViews

Defined in src/common/base-store.ts:146

Parameters:

Name Type
model ClusterStoreModel

Returns: Promise\


toJSON#

toJSON(): ClusterStoreModel

Overrides BaseStore.toJSON

Defined in src/common/cluster-store.ts:252

Returns: ClusterStoreModel


unregisterIpcListener#

unregisterIpcListener(): void

Overrides BaseStore.unregisterIpcListener

Defined in src/common/cluster-store.ts:108

Returns: void


embedCustomKubeConfig#

StaticembedCustomKubeConfig(clusterId: ClusterId, kubeConfig: KubeConfig | string): string

Defined in src/common/cluster-store.ts:70

Parameters:

Name Type
clusterId ClusterId
kubeConfig KubeConfig | string

Returns: string


getCustomKubeConfigPath#

StaticgetCustomKubeConfigPath(clusterId: ClusterId): string

Defined in src/common/cluster-store.ts:66

Parameters:

Name Type
clusterId ClusterId

Returns: string


getInstance#

StaticgetInstance\(...args: ConstructorParameters\<Constructor\>): T

Inherited from Singleton.getInstance

Defined in src/common/utils/singleton.ts:15

Type parameters:

Name
T

Parameters:

Name Type
...args ConstructorParameters\<Constructor\>

Returns: T


resetInstance#

StaticresetInstance(): void

Inherited from Singleton.resetInstance

Defined in src/common/utils/singleton.ts:22

Returns: void


Last update: November 10, 2020