Class: KubeObjectStore ‹T›#
Type parameters#
▪ T: KubeObject
Hierarchy#
- ItemStore‹T›
↳ KubeObjectStore
↳ JobStore
↳ HPAStore
↳ CRDStore
Index#
Constructors#
Properties#
- api
- bufferSize
- eventsBuffer
- failedLoading
- isLoaded
- isLoading
- items
- limit
- selectedItemsIds
- defaultContext
Accessors#
Methods#
- [Symbol.iterator]
- bindWatchEventsUpdater
- create
- createItem
- defaultSorting
- filterItemsOnLoad
- getAllByNs
- getById
- getByLabel
- getByName
- getByPath
- getIndexById
- getItems
- getStatuses
- getSubscribeApis
- getTotalCount
- isSelected
- isSelectedAll
- load
- loadAll
- loadFromPath
- loadItem
- loadItems
- mergeItems
- reloadAll
- remove
- removeItem
- removeSelectedItems
- reset
- resetOnError
- resetSelection
- select
- sortItems
- subscribe
- toggleSelection
- toggleSelectionAll
- unselect
- update
- updateFromEventsBuffer
- updateItem
Constructors#
constructor#
+ new KubeObjectStore(): KubeObjectStore
Overrides void
Defined in src/renderer/kube-object.store.ts:54
Returns: KubeObjectStore
Properties#
Abstract api#
• api: KubeApi‹T›
Defined in src/renderer/kube-object.store.ts:43
bufferSize#
• bufferSize: number = 50000
Defined in src/renderer/kube-object.store.ts:45
Protected eventsBuffer#
• eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array
Defined in src/renderer/kube-object.store.ts:301
failedLoading#
• failedLoading: boolean = false
Inherited from KubeObjectStore.failedLoading
Defined in src/renderer/item.store.ts:36
isLoaded#
• isLoaded: boolean = false
Inherited from KubeObjectStore.isLoaded
Defined in src/renderer/item.store.ts:38
isLoading#
• isLoading: boolean = false
Inherited from KubeObjectStore.isLoading
Defined in src/renderer/item.store.ts:37
items#
• items: IObservableArray‹T› = observable.array
Inherited from KubeObjectStore.items
Defined in src/renderer/item.store.ts:39
Optional limit#
• limit? : number
Defined in src/renderer/kube-object.store.ts:44
selectedItemsIds#
• selectedItemsIds: ObservableMap‹string, boolean› = observable.map
Inherited from KubeObjectStore.selectedItemsIds
Defined in src/renderer/item.store.ts:40
Static defaultContext#
▪ defaultContext: IObservableValue‹ClusterContext› = observable.box
Defined in src/renderer/kube-object.store.ts:41
Accessors#
context#
• get context(): ClusterContext
Defined in src/renderer/kube-object.store.ts:63
Returns: ClusterContext
contextItems#
• get contextItems(): T[]
Defined in src/renderer/kube-object.store.ts:67
Returns: T[]
contextReady#
• get contextReady(): Promise‹void› & object
Defined in src/renderer/kube-object.store.ts:48
Returns: Promise‹void› & object
namespacesReady#
• get namespacesReady(): Promise‹void› & object
Defined in src/renderer/kube-object.store.ts:52
Returns: Promise‹void› & object
query#
• get query(): IKubeApiQueryParams
Defined in src/renderer/kube-object.store.ts:81
Returns: IKubeApiQueryParams
selectedItems#
• get selectedItems(): T[]
Inherited from KubeObjectStore.selectedItems
Defined in src/renderer/item.store.ts:47
Returns: T[]
Methods#
[Symbol.iterator]#
▸ [Symbol.iterator](): Generator‹T, void, undefined›
Inherited from KubeObjectStore.[Symbol.iterator]
Defined in src/renderer/item.store.ts:221
Returns: Generator‹T, void, undefined›
Protected bindWatchEventsUpdater#
▸ bindWatchEventsUpdater(delay: number): void
Defined in src/renderer/kube-object.store.ts:303
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:272
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:268
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:34
Parameters:
| Name | Type |
|---|---|
item |
T |
Returns: string
Protected filterItemsOnLoad#
▸ filterItemsOnLoad(items: T[]): T[]
Defined in src/renderer/kube-object.store.ts:166
Parameters:
| Name | Type |
|---|---|
items |
T[] |
Returns: T[]
getAllByNs#
▸ getAllByNs(namespace: string | string[], strict: boolean): T[]
Defined in src/renderer/kube-object.store.ts:93
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:107
Parameters:
| Name | Type |
|---|---|
id |
string |
Returns: T
getByLabel#
▸ getByLabel(labels: string[] | object): T[]
Defined in src/renderer/kube-object.store.ts:123
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:111
Parameters:
| Name | Type |
|---|---|
name |
string |
namespace? |
string |
Returns: T
getByPath#
▸ getByPath(path: string): T
Defined in src/renderer/kube-object.store.ts:119
Parameters:
| Name | Type |
|---|---|
path |
string |
Returns: T
getIndexById#
▸ getIndexById(id: string): number
Inherited from KubeObjectStore.getIndexById
Defined in src/renderer/item.store.ts:64
Parameters:
| Name | Type |
|---|---|
id |
string |
Returns: number
getItems#
▸ getItems(): T[]
Inherited from KubeObjectStore.getItems
Defined in src/renderer/item.store.ts:51
Returns: T[]
Optional getStatuses#
▸ getStatuses(items: T[]): Record‹string, number›
Defined in src/renderer/kube-object.store.ts:91
Parameters:
| Name | Type |
|---|---|
items |
T[] |
Returns: Record‹string, number›
getSubscribeApis#
▸ getSubscribeApis(): KubeApi[]
Defined in src/renderer/kube-object.store.ts:309
Returns: KubeApi[]
getTotalCount#
▸ getTotalCount(): number
Overrides void
Defined in src/renderer/kube-object.store.ts:77
Returns: number
isSelected#
▸ isSelected(item: T): boolean
Inherited from KubeObjectStore.isSelected
Defined in src/renderer/item.store.ts:160
Parameters:
| Name | Type |
|---|---|
item |
T |
Returns: boolean
isSelectedAll#
▸ isSelectedAll(visibleItems: T[]): boolean
Inherited from KubeObjectStore.isSelectedAll
Defined in src/renderer/item.store.ts:194
Parameters:
| Name | Type | Default |
|---|---|---|
visibleItems |
T[] | this.items |
Returns: boolean
load#
▸ load(params: object): Promise‹T›
Defined in src/renderer/kube-object.store.ts:247
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:171
Parameters:
▪Default value options: object= {}
| Name | Type |
|---|---|
merge? |
boolean |
namespaces? |
string[] |
reqInit? |
RequestInit |
Returns: Promise‹void | T[]›
loadFromPath#
▸ loadFromPath(resourcePath: string): Promise‹T›
Defined in src/renderer/kube-object.store.ts:262
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:242
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:140
Parameters:
▪ __namedParameters: object
| Name | Type |
|---|---|
api |
KubeApi‹any› |
namespaces |
string[] |
reqInit |
RequestInit |
Returns: Promise‹T[]›
Protected mergeItems#
▸ mergeItems(partialItems: T[], __namedParameters: object): T[]
Defined in src/renderer/kube-object.store.ts:218
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:207
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:290
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:154
Parameters:
▪ item: T
▪ request: function
▸ (): Promise‹any›
Returns: Promise‹void›
removeSelectedItems#
▸ removeSelectedItems(): Promise‹void[]›
Overrides void
Defined in src/renderer/kube-object.store.ts:296
Returns: Promise‹void[]›
reset#
▸ reset(): void
Inherited from KubeObjectStore.reset
Defined in src/renderer/item.store.ts:206
Returns: void
Protected resetOnError#
▸ resetOnError(error: any): void
Defined in src/renderer/kube-object.store.ts:238
Parameters:
| Name | Type |
|---|---|
error |
any |
Returns: void
resetSelection#
▸ resetSelection(): void
Inherited from KubeObjectStore.resetSelection
Defined in src/renderer/item.store.ts:201
Returns: void
select#
▸ select(item: T): void
Inherited from KubeObjectStore.select
Defined in src/renderer/item.store.ts:165
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:78
Return items sorted by the given ordering functions. If two elements of
items are sorted to the same "index" then the next sorting function is used
to determine where to place them relative to each other. Once the sorting
functions have been all exhausted then the order is unchanged (ie a stable sort).
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
items |
T[] | this.items | the items to be sorted (default: the current items in this store) |
sorting |
function[] | [this.defaultSorting] | list of functions to determine sort order (default: sorting by name) |
order? |
"asc" | "desc" | - | whether to sort from least to greatest ("asc" (default)) or vice-versa ("desc") |
Returns: T[]
subscribe#
▸ subscribe(apis: KubeApi‹any›[]): (Anonymous function)
Overrides void
Defined in src/renderer/kube-object.store.ts:313
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:175
Parameters:
| Name | Type |
|---|---|
item |
T |
Returns: void
toggleSelectionAll#
▸ toggleSelectionAll(visibleItems: T[]): void
Inherited from KubeObjectStore.toggleSelectionAll
Defined in src/renderer/item.store.ts:184
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:170
Parameters:
| Name | Type |
|---|---|
item |
T |
Returns: void
update#
▸ update(item: T, data: Partial‹T›): Promise‹T›
Defined in src/renderer/kube-object.store.ts:281
Parameters:
| Name | Type |
|---|---|
item |
T |
data |
Partial‹T› |
Returns: Promise‹T›
Protected updateFromEventsBuffer#
▸ updateFromEventsBuffer(): void
Defined in src/renderer/kube-object.store.ts:398
Returns: void
Protected updateItem#
▸ updateItem(item: T, request: function): Promise‹T›
Inherited from KubeObjectStore.updateItem
Defined in src/renderer/item.store.ts:144
Parameters:
▪ item: T
▪ request: function
▸ (): Promise‹T›
Returns: Promise‹T›