Skip to content

Class: KubeObjectStore ‹T›#

Type parameters#

▪ T: KubeObject

Hierarchy#

  • ItemStore‹T›

↳ KubeObjectStore

↳ EventStore

↳ PodsStore

↳ NodesStore

↳ DeploymentStore

↳ DaemonSetStore

↳ StatefulSetStore

↳ JobStore

↳ CronJobStore

↳ ConfigMapsStore

↳ SecretsStore

↳ ReplicaSetStore

↳ ResourceQuotasStore

↳ LimitRangesStore

↳ HPAStore

↳ PodDisruptionBudgetsStore

↳ ServiceStore

↳ EndpointStore

↳ IngressStore

↳ NetworkPolicyStore

↳ PersistentVolumesStore

↳ VolumeClaimStore

↳ StorageClassStore

↳ NamespaceStore

↳ ServiceAccountsStore

↳ RolesStore

↳ RoleBindingsStore

↳ CRDStore

↳ CRDResourceStore

Index#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

+ new KubeObjectStore(): KubeObjectStore

Defined in src/renderer/kube-object.store.ts:26

Returns: KubeObjectStore

Properties#

Abstract api#

• api: KubeApi‹T›

Defined in src/renderer/kube-object.store.ts:21

bufferSize#

• bufferSize: number = 50000

Defined in src/renderer/kube-object.store.ts:23

contextReady#

• contextReady: Promise‹void› & object = when(() => Boolean(this.context))

Defined in src/renderer/kube-object.store.ts:26

Protected eventsBuffer#

• eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

Defined in src/renderer/kube-object.store.ts:261

isLoaded#

• isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

Defined in src/renderer/item.store.ts:17

isLoading#

• isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

Defined in src/renderer/item.store.ts:16

items#

• items: IObservableArray‹T› = observable.array([], { deep: false })

Inherited from KubeObjectStore.items

Defined in src/renderer/item.store.ts:18

Optional limit#

• limit? : number

Defined in src/renderer/kube-object.store.ts:22

selectedItemsIds#

• selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

Defined in src/renderer/item.store.ts:19

Static defaultContext#

▪ defaultContext: ClusterContext

Defined in src/renderer/kube-object.store.ts:19

Accessors#

context#

• get context(): ClusterContext

Defined in src/renderer/kube-object.store.ts:33

Returns: ClusterContext

contextItems#

• get contextItems(): T[]

Defined in src/renderer/kube-object.store.ts:37

Returns: T[]

query#

• get query(): IKubeApiQueryParams

Defined in src/renderer/kube-object.store.ts:51

Returns: IKubeApiQueryParams

selectedItems#

• get selectedItems(): T[]

Inherited from KubeObjectStore.selectedItems

Defined in src/renderer/item.store.ts:21

Returns: T[]

Methods#

[Symbol.iterator]#

▸ [Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

Defined in src/renderer/item.store.ts:186

Returns: Generator‹T, void, undefined›

Protected bindWatchEventsUpdater#

▸ bindWatchEventsUpdater(delay: number): void

Defined in src/renderer/kube-object.store.ts:263

Parameters:

Name Type Default
delay number 1000

Returns: void

create#

▸ create(params: object, data?: Partial‹T›): Promise‹T›

Defined in src/renderer/kube-object.store.ts:232

Parameters:

▪ params: object

Name Type
name string
namespace? string

▪Optional data: Partial‹T›

Returns: Promise‹T›

Protected createItem#

▸ createItem(params: object, data?: Partial‹T›): Promise‹T›

Overrides void

Defined in src/renderer/kube-object.store.ts:228

Parameters:

▪ params: object

Name Type
name string
namespace? string

▪Optional data: Partial‹T›

Returns: Promise‹T›

Protected defaultSorting#

▸ defaultSorting(item: T): string

Inherited from KubeObjectStore.defaultSorting

Defined in src/renderer/item.store.ts:14

Parameters:

Name Type
item T

Returns: string

Protected filterItemsOnLoad#

▸ filterItemsOnLoad(items: T[]): T[]

Defined in src/renderer/kube-object.store.ts:132

Parameters:

Name Type
items T[]

Returns: T[]

getAllByNs#

▸ getAllByNs(namespace: string | string[], strict: boolean): T[]

Defined in src/renderer/kube-object.store.ts:63

Parameters:

Name Type Default
namespace string | string[] -
strict boolean false

Returns: T[]

getById#

▸ getById(id: string): T

Defined in src/renderer/kube-object.store.ts:73

Parameters:

Name Type
id string

Returns: T

getByLabel#

▸ getByLabel(labels: string[] | object): T[]

Defined in src/renderer/kube-object.store.ts:89

Parameters:

Name Type
labels string[] | object

Returns: T[]

getByName#

▸ getByName(name: string, namespace?: string): T

Overrides void

Defined in src/renderer/kube-object.store.ts:77

Parameters:

Name Type
name string
namespace? string

Returns: T

getByPath#

▸ getByPath(path: string): T

Defined in src/renderer/kube-object.store.ts:85

Parameters:

Name Type
path string

Returns: T

getIndexById#

▸ getIndexById(id: string): number

Inherited from KubeObjectStore.getIndexById

Defined in src/renderer/item.store.ts:38

Parameters:

Name Type
id string

Returns: number

getItems#

▸ getItems(): T[]

Inherited from KubeObjectStore.getItems

Defined in src/renderer/item.store.ts:25

Returns: T[]

Optional getStatuses#

▸ getStatuses(items: T[]): Record‹string, number›

Defined in src/renderer/kube-object.store.ts:61

Parameters:

Name Type
items T[]

Returns: Record‹string, number›

getSubscribeApis#

▸ getSubscribeApis(): KubeApi[]

Defined in src/renderer/kube-object.store.ts:269

Returns: KubeApi[]

getTotalCount#

▸ getTotalCount(): number

Overrides void

Defined in src/renderer/kube-object.store.ts:47

Returns: number

isSelected#

▸ isSelected(item: T): boolean

Inherited from KubeObjectStore.isSelected

Defined in src/renderer/item.store.ts:125

Parameters:

Name Type
item T

Returns: boolean

isSelectedAll#

▸ isSelectedAll(visibleItems: T[]): boolean

Inherited from KubeObjectStore.isSelectedAll

Defined in src/renderer/item.store.ts:159

Parameters:

Name Type Default
visibleItems T[] this.items

Returns: boolean

load#

▸ load(params: object): Promise‹T›

Defined in src/renderer/kube-object.store.ts:207

Parameters:

▪ params: object

Name Type
name string
namespace? string

Returns: Promise‹T›

loadAll#

▸ loadAll(options: object): Promise‹void | T[]›

Overrides void

Defined in src/renderer/kube-object.store.ts:137

Parameters:

▪Default value options: object= {}

Name Type
merge? boolean
namespaces? string[]

Returns: Promise‹void | T[]›

loadFromPath#

▸ loadFromPath(resourcePath: string): Promise‹T›

Defined in src/renderer/kube-object.store.ts:222

Parameters:

Name Type
resourcePath string

Returns: Promise‹T›

Protected loadItem#

▸ loadItem(params: object): Promise‹T›

Overrides void

Defined in src/renderer/kube-object.store.ts:202

Parameters:

▪ params: object

Name Type
name string
namespace? string

Returns: Promise‹T›

Protected loadItems#

▸ loadItems(__namedParameters: object): Promise‹T[]›

Overrides void

Defined in src/renderer/kube-object.store.ts:106

Parameters:

▪ __namedParameters: object

Name Type
api KubeApi‹any›
namespaces string[]

Returns: Promise‹T[]›

Protected mergeItems#

▸ mergeItems(partialItems: T[], __namedParameters: object): T[]

Defined in src/renderer/kube-object.store.ts:178

Parameters:

▪ partialItems: T[]

▪Default value __namedParameters: object= {}

Name Type Default
filter boolean true
replace boolean false
sort boolean true
updateStore boolean true

Returns: T[]

reloadAll#

▸ reloadAll(opts: object): Promise‹void | T[]›

Defined in src/renderer/kube-object.store.ts:167

Parameters:

▪Default value opts: object= {}

Name Type
force? boolean
merge? boolean
namespaces? string[]

Returns: Promise‹void | T[]›

remove#

▸ remove(item: T): Promise‹void›

Defined in src/renderer/kube-object.store.ts:250

Parameters:

Name Type
item T

Returns: Promise‹void›

Protected removeItem#

▸ removeItem(item: T, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

Defined in src/renderer/item.store.ts:119

Parameters:

▪ item: T

▪ request: function

▸ (): Promise‹any›

Returns: Promise‹void›

removeSelectedItems#

▸ removeSelectedItems(): Promise‹void[]›

Overrides void

Defined in src/renderer/kube-object.store.ts:256

Returns: Promise‹void[]›

reset#

▸ reset(): void

Inherited from KubeObjectStore.reset

Defined in src/renderer/item.store.ts:171

Returns: void

Protected resetOnError#

▸ resetOnError(error: any): void

Defined in src/renderer/kube-object.store.ts:198

Parameters:

Name Type
error any

Returns: void

resetSelection#

▸ resetSelection(): void

Inherited from KubeObjectStore.resetSelection

Defined in src/renderer/item.store.ts:166

Returns: void

select#

▸ select(item: T): void

Inherited from KubeObjectStore.select

Defined in src/renderer/item.store.ts:130

Parameters:

Name Type
item T

Returns: void

Protected sortItems#

▸ sortItems(items: T[], sorting?: function[], order?: "asc" | "desc"): T[]

Inherited from KubeObjectStore.sortItems

Defined in src/renderer/item.store.ts:43

Parameters:

Name Type Default
items T[] this.items
sorting? function[] -
order? "asc" | "desc" -

Returns: T[]

subscribe#

▸ subscribe(apis: KubeApi‹any›[]): (Anonymous function)

Overrides void

Defined in src/renderer/kube-object.store.ts:273

Parameters:

Name Type Default
apis KubeApi‹any›[] this.getSubscribeApis()

Returns: (Anonymous function)

toggleSelection#

▸ toggleSelection(item: T): void

Inherited from KubeObjectStore.toggleSelection

Defined in src/renderer/item.store.ts:140

Parameters:

Name Type
item T

Returns: void

toggleSelectionAll#

▸ toggleSelectionAll(visibleItems: T[]): void

Inherited from KubeObjectStore.toggleSelectionAll

Defined in src/renderer/item.store.ts:149

Parameters:

Name Type Default
visibleItems T[] this.items

Returns: void

unselect#

▸ unselect(item: T): void

Inherited from KubeObjectStore.unselect

Defined in src/renderer/item.store.ts:135

Parameters:

Name Type
item T

Returns: void

update#

▸ update(item: T, data: Partial‹T›): Promise‹T›

Defined in src/renderer/kube-object.store.ts:241

Parameters:

Name Type
item T
data Partial‹T›

Returns: Promise‹T›

Protected updateFromEventsBuffer#

▸ updateFromEventsBuffer(): void

Defined in src/renderer/kube-object.store.ts:351

Returns: void

Protected updateItem#

▸ updateItem(item: T, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

Defined in src/renderer/item.store.ts:109

Parameters:

▪ item: T

▪ request: function

▸ (): Promise‹T›

Returns: Promise‹T›