Class: KubeObjectStore ‹T›#
Type parameters#
▪ T: KubeObject
Hierarchy#
- ItemStore‹T›
↳ KubeObjectStore
↳ JobStore
↳ HPAStore
↳ CRDStore
Index#
Constructors#
Properties#
Accessors#
Methods#
- [Symbol.iterator]
- bindWatchEventsUpdater
- create
- createItem
- defaultSorting
- filterItemsOnLoad
- getAllByNs
- getByLabel
- getByName
- getByPath
- getStatuses
- isSelected
- isSelectedAll
- load
- loadAll
- loadFromPath
- loadItem
- loadItems
- onWatchApiEvent
- remove
- removeItem
- removeSelectedItems
- reset
- resetSelection
- select
- sortItems
- subscribe
- toggleSelection
- toggleSelectionAll
- unselect
- update
- updateFromEventsBuffer
- updateItem
Constructors#
constructor#
+ new KubeObjectStore(): KubeObjectStore
Defined in src/renderer/kube-object.store.ts:15
Returns: KubeObjectStore
Properties#
Abstract
api#
• api: KubeApi‹T›
Defined in src/renderer/kube-object.store.ts:13
bufferSize#
• bufferSize: number = 50000
Defined in src/renderer/kube-object.store.ts:15
Protected
eventsBuffer#
• eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable
Defined in src/renderer/kube-object.store.ts:172
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
Inherited from KubeObjectStore.items
Defined in src/renderer/item.store.ts:18
Optional
limit#
• limit? : number
Defined in src/renderer/kube-object.store.ts:14
selectedItemsIds#
• selectedItemsIds: ObservableMap‹string, boolean› = observable.map
Inherited from KubeObjectStore.selectedItemsIds
Defined in src/renderer/item.store.ts:19
Accessors#
query#
• get query(): IKubeApiQueryParams
Defined in src/renderer/kube-object.store.ts:23
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:178
Returns: Generator‹T, void, undefined›
Protected
bindWatchEventsUpdater#
▸ bindWatchEventsUpdater(delay
: number): IReactionDisposer
Defined in src/renderer/kube-object.store.ts:174
Parameters:
Name | Type | Default |
---|---|---|
delay |
number | 1000 |
Returns: IReactionDisposer
create#
▸ create(params
: object, data?
: Partial‹T›): Promise‹T›
Defined in src/renderer/kube-object.store.ts:143
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:139
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:84
Parameters:
Name | Type |
---|---|
items |
T[] |
Returns: T[]
getAllByNs#
▸ getAllByNs(namespace
: string | string[], strict
: boolean): T[]
Defined in src/renderer/kube-object.store.ts:35
Parameters:
Name | Type | Default |
---|---|---|
namespace |
string | string[] | - |
strict |
boolean | false |
Returns: T[]
getByLabel#
▸ getByLabel(labels
: string[] | object): T[]
Defined in src/renderer/kube-object.store.ts:57
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:45
Parameters:
Name | Type |
---|---|
name |
string |
namespace? |
string |
Returns: T
getByPath#
▸ getByPath(path
: string): T
Defined in src/renderer/kube-object.store.ts:53
Parameters:
Name | Type |
---|---|
path |
string |
Returns: T
Optional
getStatuses#
▸ getStatuses(items
: T[]): Record‹string, number›
Defined in src/renderer/kube-object.store.ts:33
Parameters:
Name | Type |
---|---|
items |
T[] |
Returns: Record‹string, number›
isSelected#
▸ isSelected(item
: T): boolean
Inherited from KubeObjectStore.isSelected
Defined in src/renderer/item.store.ts:115
Parameters:
Name | Type |
---|---|
item |
T |
Returns: boolean
isSelectedAll#
▸ isSelectedAll(visibleItems
: T[]): boolean
Inherited from KubeObjectStore.isSelectedAll
Defined in src/renderer/item.store.ts:151
Parameters:
Name | Type | Default |
---|---|---|
visibleItems |
T[] | this.items |
Returns: boolean
load#
▸ load(params
: object): Promise‹T›
Defined in src/renderer/kube-object.store.ts:118
Parameters:
▪ params: object
Name | Type |
---|---|
name |
string |
namespace? |
string |
Returns: Promise‹T›
loadAll#
▸ loadAll(): Promise‹void›
Overrides void
Defined in src/renderer/kube-object.store.ts:89
Returns: Promise‹void›
loadFromPath#
▸ loadFromPath(resourcePath
: string): Promise‹T›
Defined in src/renderer/kube-object.store.ts:133
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:113
Parameters:
▪ params: object
Name | Type |
---|---|
name |
string |
namespace? |
string |
Returns: Promise‹T›
Protected
loadItems#
▸ loadItems(allowedNamespaces?
: string[]): Promise‹T[]›
Overrides void
Defined in src/renderer/kube-object.store.ts:74
Parameters:
Name | Type |
---|---|
allowedNamespaces? |
string[] |
Returns: Promise‹T[]›
Protected
onWatchApiEvent#
▸ onWatchApiEvent(evt
: IKubeWatchEvent): void
Defined in src/renderer/kube-object.store.ts:184
Parameters:
Name | Type |
---|---|
evt |
IKubeWatchEvent |
Returns: void
remove#
▸ remove(item
: T): Promise‹void›
Defined in src/renderer/kube-object.store.ts:161
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:109
Parameters:
▪ item: T
▪ request: function
▸ (): Promise‹any›
Returns: Promise‹void›
removeSelectedItems#
▸ removeSelectedItems(): Promise‹void[]›
Overrides void
Defined in src/renderer/kube-object.store.ts:167
Returns: Promise‹void[]›
reset#
▸ reset(): void
Inherited from KubeObjectStore.reset
Defined in src/renderer/item.store.ts:163
Returns: void
resetSelection#
▸ resetSelection(): void
Inherited from KubeObjectStore.resetSelection
Defined in src/renderer/item.store.ts:158
Returns: void
select#
▸ select(item
: T): void
Inherited from KubeObjectStore.select
Defined in src/renderer/item.store.ts:120
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:31
Parameters:
Name | Type | Default |
---|---|---|
items |
T[] | this.items |
sorting? |
function[] | - |
order? |
"asc" | "desc" | - |
Returns: T[]
subscribe#
▸ subscribe(apis
: KubeApi‹T›[]): (Anonymous function)
Overrides void
Defined in src/renderer/kube-object.store.ts:180
Parameters:
Name | Type | Default |
---|---|---|
apis |
KubeApi‹T›[] | [this.api] |
Returns: (Anonymous function)
toggleSelection#
▸ toggleSelection(item
: T): void
Inherited from KubeObjectStore.toggleSelection
Defined in src/renderer/item.store.ts:130
Parameters:
Name | Type |
---|---|
item |
T |
Returns: void
toggleSelectionAll#
▸ toggleSelectionAll(visibleItems
: T[]): void
Inherited from KubeObjectStore.toggleSelectionAll
Defined in src/renderer/item.store.ts:140
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:125
Parameters:
Name | Type |
---|---|
item |
T |
Returns: void
update#
▸ update(item
: T, data
: Partial‹T›): Promise‹T›
Defined in src/renderer/kube-object.store.ts:152
Parameters:
Name | Type |
---|---|
item |
T |
data |
Partial‹T› |
Returns: Promise‹T›
Protected
updateFromEventsBuffer#
▸ updateFromEventsBuffer(): void
Defined in src/renderer/kube-object.store.ts:190
Returns: void
Protected
updateItem#
▸ updateItem(item
: T, request
: function): Promise‹T›
Inherited from KubeObjectStore.updateItem
Defined in src/renderer/item.store.ts:99
Parameters:
▪ item: T
▪ request: function
▸ (): Promise‹T›
Returns: Promise‹T›