Skip to content

@k8slens/extensions

Globals / "src/renderer/kube-object.store" / KubeObjectStore

Class: KubeObjectStore\#

Type parameters#

Name Type Default
T KubeObject any

Hierarchy#

↳ KubeObjectStore

↳↳ CRDResourceStore

↳↳ CRDStore

↳↳ NamespaceStore

↳↳ PodsStore

↳↳ EventStore

Index#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

+ new KubeObjectStore(): KubeObjectStore

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

Returns: KubeObjectStore

Properties#

api#

• Abstract api: KubeApi\

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

eventsBuffer#

• Protected eventsBuffer: IObservableArray\<IKubeWatchEvent\<KubeJsonApiData>> = observable\>([], { deep: false })

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

isLoaded#

• isLoaded: boolean = false

Inherited from ItemStore.isLoaded

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

isLoading#

• isLoading: boolean = false

Inherited from ItemStore.isLoading

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

items#

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

Inherited from ItemStore.items

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

limit#

• limit: number

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

selectedItemsIds#

• selectedItemsIds: ObservableMap\ = observable.map\()

Inherited from ItemStore.selectedItemsIds

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

Accessors#

selectedItems#

• get selectedItems(): T[]

Inherited from ItemStore.selectedItems

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

Returns: T[]

Methods#

[Symbol.iterator]#

▸ [Symbol.iterator](): Generator\

Inherited from ItemStore.[Symbol.iterator]

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

Returns: Generator\

bindWatchEventsUpdater#

▸ ProtectedbindWatchEventsUpdater(delay?: number): IReactionDisposer

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

Parameters:

Name Type Default value
delay number 1000

Returns: IReactionDisposer

create#

▸ create(params: { name: string ; namespace?: string }, data?: Partial\): Promise\

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

Parameters:

Name Type
params { name: string ; namespace?: string }
data? Partial\

Returns: Promise\

createItem#

▸ ProtectedcreateItem(params: { name: string ; namespace?: string }, data?: Partial\): Promise\

Overrides ItemStore.createItem

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

Parameters:

Name Type
params { name: string ; namespace?: string }
data? Partial\

Returns: Promise\

defaultSorting#

▸ ProtecteddefaultSorting(item: T): string

Inherited from ItemStore.defaultSorting

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

Parameters:

Name Type
item T

Returns: string

filterItemsOnLoad#

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

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

Parameters:

Name Type
items T[]

Returns: T[]

getAllByNs#

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

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

Parameters:

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

Returns: T[]

getByLabel#

▸ getByLabel(labels: string[] | { [label:string]: string; }): T[]

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

Parameters:

Name Type
labels string[] | { [label:string]: string; }

Returns: T[]

getByName#

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

Overrides ItemStore.getByName

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

Parameters:

Name Type
name string
namespace? string

Returns: T

getByPath#

▸ getByPath(path: string): T

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

Parameters:

Name Type
path string

Returns: T

getStatuses#

▸ OptionalgetStatuses(items: T[]): Record\

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

Parameters:

Name Type
items T[]

Returns: Record\

isSelected#

▸ isSelected(item: T): boolean

Inherited from ItemStore.isSelected

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

Parameters:

Name Type
item T

Returns: boolean

isSelectedAll#

▸ isSelectedAll(visibleItems?: T[]): boolean

Inherited from ItemStore.isSelectedAll

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

Parameters:

Name Type Default value
visibleItems T[] this.items

Returns: boolean

load#

▸ load(params: { name: string ; namespace?: string }): Promise\

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

Parameters:

Name Type
params { name: string ; namespace?: string }

Returns: Promise\

loadAll#

▸ loadAll(): Promise\

Overrides ItemStore.loadAll

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

Returns: Promise\

loadFromPath#

▸ loadFromPath(resourcePath: string): Promise\

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

Parameters:

Name Type
resourcePath string

Returns: Promise\

loadItem#

▸ ProtectedloadItem(params: { name: string ; namespace?: string }): Promise\

Overrides ItemStore.loadItem

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

Parameters:

Name Type
params { name: string ; namespace?: string }

Returns: Promise\

loadItems#

▸ ProtectedloadItems(allowedNamespaces?: string[]): Promise\

Overrides ItemStore.loadItems

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

Parameters:

Name Type
allowedNamespaces? string[]

Returns: Promise\

onWatchApiEvent#

▸ ProtectedonWatchApiEvent(evt: IKubeWatchEvent): void

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

Parameters:

Name Type
evt IKubeWatchEvent

Returns: void

remove#

▸ remove(item: T): Promise\

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

Parameters:

Name Type
item T

Returns: Promise\

removeItem#

▸ ProtectedremoveItem(item: T, request: () => Promise\): Promise\

Inherited from ItemStore.removeItem

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

Parameters:

Name Type
item T
request () => Promise\

Returns: Promise\

removeSelectedItems#

▸ removeSelectedItems(): Promise\

Overrides ItemStore.removeSelectedItems

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

Returns: Promise\

reset#

▸ reset(): void

Inherited from ItemStore.reset

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

Returns: void

resetSelection#

▸ resetSelection(): void

Inherited from ItemStore.resetSelection

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

Returns: void

select#

▸ select(item: T): void

Inherited from ItemStore.select

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

Parameters:

Name Type
item T

Returns: void

sortItems#

▸ ProtectedsortItems(items?: T[], sorting?: (item: T) => any[], order?: \"asc\" | \"desc\"): T[]

Inherited from ItemStore.sortItems

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

Parameters:

Name Type Default value
items T[] this.items
sorting? (item: T) => any[] -
order? \"asc\" | \"desc\" -

Returns: T[]

subscribe#

▸ subscribe(apis?: KubeApi\[]): (Anonymous function)

Overrides ItemStore.subscribe

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

Parameters:

Name Type Default value
apis KubeApi\[] [this.api]

Returns: (Anonymous function)

toggleSelection#

▸ toggleSelection(item: T): void

Inherited from ItemStore.toggleSelection

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

Parameters:

Name Type
item T

Returns: void

toggleSelectionAll#

▸ toggleSelectionAll(visibleItems?: T[]): void

Inherited from ItemStore.toggleSelectionAll

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

Parameters:

Name Type Default value
visibleItems T[] this.items

Returns: void

unselect#

▸ unselect(item: T): void

Inherited from ItemStore.unselect

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

Parameters:

Name Type
item T

Returns: void

update#

▸ update(item: T, data: Partial\): Promise\

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

Parameters:

Name Type
item T
data Partial\

Returns: Promise\

updateFromEventsBuffer#

▸ ProtectedupdateFromEventsBuffer(): void

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

Returns: void

updateItem#

▸ ProtectedupdateItem(item: T, request: () => Promise\): Promise\

Inherited from ItemStore.updateItem

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

Parameters:

Name Type
item T
request () => Promise\

Returns: Promise\

Last update: November 10, 2020