@k8slens/extensions

Globals / "src/renderer/components/+custom-resources/crd-resource.store" / CRDResourceStore

Class: CRDResourceStore\

Type parameters

Name	Type	Default
T	KubeObject	any

Hierarchy

• KubeObjectStore\

↳ CRDResourceStore

Index

Constructors

• constructor

Properties

• api
• eventsBuffer
• isLoaded
• isLoading
• items
• limit
• selectedItemsIds

Accessors

• selectedItems

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 CRDResourceStore(api: KubeApi\): CRDResourceStore

Overrides KubeObjectStore.constructor

Defined in src/renderer/components/+custom-resources/crd-resource.store.ts:8

Parameters:

Name	Type
api	KubeApi\

Returns: CRDResourceStore

Properties

api

• api: KubeApi

Overrides KubeObjectStore.api

Defined in src/renderer/components/+custom-resources/crd-resource.store.ts:8

---

eventsBuffer

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

Inherited from KubeObjectStore.eventsBuffer

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

Inherited from KubeObjectStore.limit

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

Inherited from KubeObjectStore.bindWatchEventsUpdater

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\

Inherited from KubeObjectStore.create

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\

Inherited from KubeObjectStore.createItem

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[]

Inherited from KubeObjectStore.filterItemsOnLoad

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

Parameters:

Name	Type
items	T[]

Returns: T[]

---

getAllByNs

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

Inherited from KubeObjectStore.getAllByNs

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[]

Inherited from KubeObjectStore.getByLabel

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

Inherited from KubeObjectStore.getByName

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

Inherited from KubeObjectStore.getByPath

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

Parameters:

Name	Type
path	string

Returns: T

---

getStatuses

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

Inherited from KubeObjectStore.getStatuses

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\

Inherited from KubeObjectStore.load

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

Parameters:

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

Returns: Promise\

---

loadAll

▸ loadAll(): Promise\

Inherited from KubeObjectStore.loadAll

Overrides ItemStore.loadAll

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

Returns: Promise\

---

loadFromPath

▸ loadFromPath(resourcePath: string): Promise\

Inherited from KubeObjectStore.loadFromPath

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

Parameters:

Name	Type
resourcePath	string

Returns: Promise\

---

loadItem

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

Inherited from KubeObjectStore.loadItem

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\

Inherited from KubeObjectStore.loadItems

Overrides ItemStore.loadItems

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

Parameters:

Name	Type
allowedNamespaces?	string[]

Returns: Promise\

---

onWatchApiEvent

▸ ProtectedonWatchApiEvent(evt: IKubeWatchEvent): void

Inherited from KubeObjectStore.onWatchApiEvent

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

Parameters:

Name	Type
evt	IKubeWatchEvent

Returns: void

---

remove

▸ remove(item: T): Promise\

Inherited from KubeObjectStore.remove

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\

Inherited from KubeObjectStore.removeSelectedItems

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)

Inherited from KubeObjectStore.subscribe

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\

Inherited from KubeObjectStore.update

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

Parameters:

Name	Type
item	T
data	Partial\

Returns: Promise\

---

updateFromEventsBuffer

▸ ProtectedupdateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

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