Class: NamespaceStore#
Hierarchy#
↳ NamespaceStore
Index#
Constructors#
Properties#
- api
- bufferSize
- contextReady
- 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
- hasContext
- isSelected
- isSelectedAll
- load
- loadAll
- loadFromPath
- loadItem
- loadItems
- mergeItems
- onContextChange
- reloadAll
- remove
- removeItem
- removeSelectedItems
- reset
- resetContext
- resetOnError
- resetSelection
- select
- setContext
- sortItems
- subscribe
- toggleAll
- toggleContext
- toggleSelection
- toggleSelectionAll
- unselect
- update
- updateFromEventsBuffer
- updateItem
Constructors#
constructor#
+ new NamespaceStore(): NamespaceStore
Overrides KubeObjectStore.constructor
Defined in src/renderer/components/+namespaces/namespace.store.ts:34
Returns: NamespaceStore
Properties#
api#
• api: KubeApi‹Namespace‹›› = namespacesApi
Overrides KubeObjectStore.api
Defined in src/renderer/components/+namespaces/namespace.store.ts:32
bufferSize#
• bufferSize: number = 50000
Inherited from KubeObjectStore.bufferSize
Defined in src/renderer/kube-object.store.ts:23
contextReady#
• contextReady: Promise‹void› & object = when(() => Boolean(this.context))
Inherited from KubeObjectStore.contextReady
Defined in src/renderer/kube-object.store.ts:26
Protected eventsBuffer#
• eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array
Inherited from KubeObjectStore.eventsBuffer
Defined in src/renderer/kube-object.store.ts:263
failedLoading#
• failedLoading: boolean = false
Inherited from KubeObjectStore.failedLoading
Defined in src/renderer/item.store.ts:16
isLoaded#
• isLoaded: boolean = false
Inherited from KubeObjectStore.isLoaded
Defined in src/renderer/item.store.ts:18
isLoading#
• isLoading: boolean = false
Inherited from KubeObjectStore.isLoading
Defined in src/renderer/item.store.ts:17
items#
• items: IObservableArray‹T› = observable.array
Inherited from KubeObjectStore.items
Defined in src/renderer/item.store.ts:19
Optional limit#
• limit? : number
Inherited from KubeObjectStore.limit
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:20
Static defaultContext#
▪ defaultContext: ClusterContext
Inherited from KubeObjectStore.defaultContext
Defined in src/renderer/kube-object.store.ts:19
Accessors#
allowedNamespaces#
• get allowedNamespaces(): string[]
Defined in src/renderer/components/+namespaces/namespace.store.ts:92
Returns: string[]
context#
• get context(): ClusterContext
Inherited from KubeObjectStore.context
Defined in src/renderer/kube-object.store.ts:33
Returns: ClusterContext
contextItems#
• get contextItems(): Namespace[]
Inherited from KubeObjectStore.contextItems
Defined in src/renderer/kube-object.store.ts:37
Returns: Namespace[]
contextNamespaces#
• get contextNamespaces(): string[]
Defined in src/renderer/components/+namespaces/namespace.store.ts:99
Returns: string[]
hasAllContexts#
• get hasAllContexts(): boolean
Defined in src/renderer/components/+namespaces/namespace.store.ts:148
Returns: boolean
query#
• get query(): IKubeApiQueryParams
Inherited from KubeObjectStore.query
Defined in src/renderer/kube-object.store.ts:51
Returns: IKubeApiQueryParams
selectedItems#
• get selectedItems(): Namespace[]
Inherited from KubeObjectStore.selectedItems
Defined in src/renderer/item.store.ts:22
Returns: Namespace[]
Methods#
[Symbol.iterator]#
▸ [Symbol.iterator](): Generator‹T, void, undefined›
Inherited from KubeObjectStore.[Symbol.iterator]
Defined in src/renderer/item.store.ts:187
Returns: Generator‹T, void, undefined›
Protected bindWatchEventsUpdater#
▸ bindWatchEventsUpdater(delay: number): void
Inherited from KubeObjectStore.bindWatchEventsUpdater
Defined in src/renderer/kube-object.store.ts:265
Parameters:
| Name | Type | Default |
|---|---|---|
delay |
number | 1000 |
Returns: void
create#
▸ create(params: object, data?: Partial‹Namespace›): Promise‹Namespace›
Inherited from KubeObjectStore.create
Defined in src/renderer/kube-object.store.ts:234
Parameters:
▪ params: object
| Name | Type |
|---|---|
name |
string |
namespace? |
string |
▪Optional data: Partial‹Namespace›
Returns: Promise‹Namespace›
Protected createItem#
▸ createItem(params: object, data?: Partial‹Namespace›): Promise‹Namespace›
Inherited from KubeObjectStore.createItem
Overrides void
Defined in src/renderer/kube-object.store.ts:230
Parameters:
▪ params: object
| Name | Type |
|---|---|
name |
string |
namespace? |
string |
▪Optional data: Partial‹Namespace›
Returns: Promise‹Namespace›
Protected defaultSorting#
▸ defaultSorting(item: Namespace): string
Inherited from KubeObjectStore.defaultSorting
Defined in src/renderer/item.store.ts:14
Parameters:
| Name | Type |
|---|---|
item |
Namespace |
Returns: string
Protected filterItemsOnLoad#
▸ filterItemsOnLoad(items: Namespace[]): T[]
Inherited from KubeObjectStore.filterItemsOnLoad
Defined in src/renderer/kube-object.store.ts:132
Parameters:
| Name | Type |
|---|---|
items |
Namespace[] |
Returns: T[]
getAllByNs#
▸ getAllByNs(namespace: string | string[], strict: boolean): Namespace[]
Inherited from KubeObjectStore.getAllByNs
Defined in src/renderer/kube-object.store.ts:63
Parameters:
| Name | Type | Default |
|---|---|---|
namespace |
string | string[] | - |
strict |
boolean | false |
Returns: Namespace[]
getById#
▸ getById(id: string): T
Inherited from KubeObjectStore.getById
Defined in src/renderer/kube-object.store.ts:73
Parameters:
| Name | Type |
|---|---|
id |
string |
Returns: T
getByLabel#
▸ getByLabel(labels: string[] | object): Namespace[]
Inherited from KubeObjectStore.getByLabel
Defined in src/renderer/kube-object.store.ts:89
Parameters:
| Name | Type |
|---|---|
labels |
string[] | object |
Returns: Namespace[]
getByName#
▸ getByName(name: string, namespace?: string): Namespace
Inherited from KubeObjectStore.getByName
Overrides void
Defined in src/renderer/kube-object.store.ts:77
Parameters:
| Name | Type |
|---|---|
name |
string |
namespace? |
string |
Returns: Namespace
getByPath#
▸ getByPath(path: string): Namespace
Inherited from KubeObjectStore.getByPath
Defined in src/renderer/kube-object.store.ts:85
Parameters:
| Name | Type |
|---|---|
path |
string |
Returns: Namespace
getIndexById#
▸ getIndexById(id: string): number
Inherited from KubeObjectStore.getIndexById
Defined in src/renderer/item.store.ts:39
Parameters:
| Name | Type |
|---|---|
id |
string |
Returns: number
getItems#
▸ getItems(): Namespace[]
Inherited from KubeObjectStore.getItems
Defined in src/renderer/item.store.ts:26
Returns: Namespace[]
Optional getStatuses#
▸ getStatuses(items: Namespace[]): Record‹string, number›
Inherited from KubeObjectStore.getStatuses
Defined in src/renderer/kube-object.store.ts:61
Parameters:
| Name | Type |
|---|---|
items |
Namespace[] |
Returns: Record‹string, number›
getSubscribeApis#
▸ getSubscribeApis(): KubeApi‹any›[]
Overrides KubeObjectStore.getSubscribeApis
Defined in src/renderer/components/+namespaces/namespace.store.ts:109
Returns: KubeApi‹any›[]
getTotalCount#
▸ getTotalCount(): number
Inherited from KubeObjectStore.getTotalCount
Overrides void
Defined in src/renderer/kube-object.store.ts:47
Returns: number
hasContext#
▸ hasContext(namespaces: string | string[]): boolean
Defined in src/renderer/components/+namespaces/namespace.store.ts:144
Parameters:
| Name | Type |
|---|---|
namespaces |
string | string[] |
Returns: boolean
isSelected#
▸ isSelected(item: Namespace): boolean
Inherited from KubeObjectStore.isSelected
Defined in src/renderer/item.store.ts:126
Parameters:
| Name | Type |
|---|---|
item |
Namespace |
Returns: boolean
isSelectedAll#
▸ isSelectedAll(visibleItems: Namespace[]): boolean
Inherited from KubeObjectStore.isSelectedAll
Defined in src/renderer/item.store.ts:160
Parameters:
| Name | Type | Default |
|---|---|---|
visibleItems |
Namespace[] | this.items |
Returns: boolean
load#
▸ load(params: object): Promise‹Namespace›
Inherited from KubeObjectStore.load
Defined in src/renderer/kube-object.store.ts:209
Parameters:
▪ params: object
| Name | Type |
|---|---|
name |
string |
namespace? |
string |
Returns: Promise‹Namespace›
loadAll#
▸ loadAll(options: object): Promise‹void | Namespace[]›
Inherited from KubeObjectStore.loadAll
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 | Namespace[]›
loadFromPath#
▸ loadFromPath(resourcePath: string): Promise‹T›
Inherited from KubeObjectStore.loadFromPath
Defined in src/renderer/kube-object.store.ts:224
Parameters:
| Name | Type |
|---|---|
resourcePath |
string |
Returns: Promise‹T›
Protected loadItem#
▸ loadItem(params: object): Promise‹Namespace›
Inherited from KubeObjectStore.loadItem
Overrides void
Defined in src/renderer/kube-object.store.ts:204
Parameters:
▪ params: object
| Name | Type |
|---|---|
name |
string |
namespace? |
string |
Returns: Promise‹Namespace›
Protected loadItems#
▸ loadItems(params: KubeObjectStoreLoadingParams): Promise‹Namespace‹›[]›
Overrides KubeObjectStore.loadItems
Defined in src/renderer/components/+namespaces/namespace.store.ts:118
Parameters:
| Name | Type |
|---|---|
params |
KubeObjectStoreLoadingParams |
Returns: Promise‹Namespace‹›[]›
Protected mergeItems#
▸ mergeItems(partialItems: Namespace[], __namedParameters: object): Namespace[]
Inherited from KubeObjectStore.mergeItems
Defined in src/renderer/kube-object.store.ts:180
Parameters:
▪ partialItems: Namespace[]
▪Default value __namedParameters: object= {}
| Name | Type | Default |
|---|---|---|
filter |
boolean | true |
replace |
boolean | false |
sort |
boolean | true |
updateStore |
boolean | true |
Returns: Namespace[]
onContextChange#
▸ onContextChange(callback: function, opts: IReactionOptions): IReactionDisposer
Defined in src/renderer/components/+namespaces/namespace.store.ts:50
Parameters:
▪ callback: function
▸ (contextNamespaces: string[]): void
Parameters:
| Name | Type |
|---|---|
contextNamespaces |
string[] |
▪Default value opts: IReactionOptions= {}
Returns: IReactionDisposer
reloadAll#
▸ reloadAll(opts: object): Promise‹void | T[]›
Inherited from KubeObjectStore.reloadAll
Defined in src/renderer/kube-object.store.ts:169
Parameters:
▪Default value opts: object= {}
| Name | Type |
|---|---|
force? |
boolean |
merge? |
boolean |
namespaces? |
string[] |
Returns: Promise‹void | T[]›
remove#
▸ remove(item: Namespace): Promise‹void›
Overrides KubeObjectStore.remove
Defined in src/renderer/components/+namespaces/namespace.store.ts:175
Parameters:
| Name | Type |
|---|---|
item |
Namespace |
Returns: Promise‹void›
Protected removeItem#
▸ removeItem(item: Namespace, request: function): Promise‹void›
Inherited from KubeObjectStore.removeItem
Defined in src/renderer/item.store.ts:120
Parameters:
▪ item: Namespace
▪ request: function
▸ (): Promise‹any›
Returns: Promise‹void›
removeSelectedItems#
▸ removeSelectedItems(): Promise‹void[]›
Inherited from KubeObjectStore.removeSelectedItems
Overrides void
Defined in src/renderer/kube-object.store.ts:258
Returns: Promise‹void[]›
reset#
▸ reset(): void
Inherited from KubeObjectStore.reset
Defined in src/renderer/item.store.ts:172
Returns: void
resetContext#
▸ resetContext(): void
Defined in src/renderer/components/+namespaces/namespace.store.ts:140
Returns: void
Protected resetOnError#
▸ resetOnError(error: any): void
Inherited from KubeObjectStore.resetOnError
Defined in src/renderer/kube-object.store.ts:200
Parameters:
| Name | Type |
|---|---|
error |
any |
Returns: void
resetSelection#
▸ resetSelection(): void
Inherited from KubeObjectStore.resetSelection
Defined in src/renderer/item.store.ts:167
Returns: void
select#
▸ select(item: Namespace): void
Inherited from KubeObjectStore.select
Defined in src/renderer/item.store.ts:131
Parameters:
| Name | Type |
|---|---|
item |
Namespace |
Returns: void
setContext#
▸ setContext(namespace: string | string[]): void
Defined in src/renderer/components/+namespaces/namespace.store.ts:133
Parameters:
| Name | Type |
|---|---|
namespace |
string | string[] |
Returns: void
Protected sortItems#
▸ sortItems(items: Namespace[], sorting?: function[], order?: "asc" | "desc"): Namespace[]
Inherited from KubeObjectStore.sortItems
Defined in src/renderer/item.store.ts:44
Parameters:
| Name | Type | Default |
|---|---|---|
items |
Namespace[] | this.items |
sorting? |
function[] | - |
order? |
"asc" | "desc" | - |
Returns: Namespace[]
subscribe#
▸ subscribe(apis: KubeApi‹any›[]): (Anonymous function)
Inherited from KubeObjectStore.subscribe
Overrides void
Defined in src/renderer/kube-object.store.ts:275
Parameters:
| Name | Type | Default |
|---|---|---|
apis |
KubeApi‹any›[] | this.getSubscribeApis() |
Returns: (Anonymous function)
toggleAll#
▸ toggleAll(showAll?: boolean): void
Defined in src/renderer/components/+namespaces/namespace.store.ts:162
Parameters:
| Name | Type |
|---|---|
showAll? |
boolean |
Returns: void
toggleContext#
▸ toggleContext(namespace: string): void
Defined in src/renderer/components/+namespaces/namespace.store.ts:153
Parameters:
| Name | Type |
|---|---|
namespace |
string |
Returns: void
toggleSelection#
▸ toggleSelection(item: Namespace): void
Inherited from KubeObjectStore.toggleSelection
Defined in src/renderer/item.store.ts:141
Parameters:
| Name | Type |
|---|---|
item |
Namespace |
Returns: void
toggleSelectionAll#
▸ toggleSelectionAll(visibleItems: Namespace[]): void
Inherited from KubeObjectStore.toggleSelectionAll
Defined in src/renderer/item.store.ts:150
Parameters:
| Name | Type | Default |
|---|---|---|
visibleItems |
Namespace[] | this.items |
Returns: void
unselect#
▸ unselect(item: Namespace): void
Inherited from KubeObjectStore.unselect
Defined in src/renderer/item.store.ts:136
Parameters:
| Name | Type |
|---|---|
item |
Namespace |
Returns: void
update#
▸ update(item: Namespace, data: Partial‹Namespace›): Promise‹Namespace›
Inherited from KubeObjectStore.update
Defined in src/renderer/kube-object.store.ts:243
Parameters:
| Name | Type |
|---|---|
item |
Namespace |
data |
Partial‹Namespace› |
Returns: Promise‹Namespace›
Protected updateFromEventsBuffer#
▸ updateFromEventsBuffer(): void
Inherited from KubeObjectStore.updateFromEventsBuffer
Defined in src/renderer/kube-object.store.ts:353
Returns: void
Protected updateItem#
▸ updateItem(item: Namespace, request: function): Promise‹T›
Inherited from KubeObjectStore.updateItem
Defined in src/renderer/item.store.ts:110
Parameters:
▪ item: Namespace
▪ request: function
▸ (): Promise‹Namespace›
Returns: Promise‹T›