Skip to content

Class: CRDStore#

Hierarchy#

↳ KubeObjectStore‹CustomResourceDefinition›

↳ CRDStore

Index#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

+ new CRDStore(): CRDStore

Overrides KubeObjectStore.constructor

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

Returns: CRDStore

Properties#

api#

• api: KubeApi‹CustomResourceDefinition‹›› = crdApi

Overrides KubeObjectStore.api

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

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>([], { deep: false })

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([], { deep: false })

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#

context#

• get context(): ClusterContext

Inherited from KubeObjectStore.context

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

Returns: ClusterContext

contextItems#

• get contextItems(): CustomResourceDefinition[]

Inherited from KubeObjectStore.contextItems

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

Returns: CustomResourceDefinition[]

groups#

• get groups(): object

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

Returns: object

query#

• get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

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

Returns: IKubeApiQueryParams

selectedItems#

• get selectedItems(): CustomResourceDefinition[]

Inherited from KubeObjectStore.selectedItems

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

Returns: CustomResourceDefinition[]

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‹CustomResourceDefinition›): Promise‹CustomResourceDefinition›

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‹CustomResourceDefinition›

Returns: Promise‹CustomResourceDefinition›

Protected createItem#

▸ createItem(params: object, data?: Partial‹CustomResourceDefinition›): Promise‹CustomResourceDefinition›

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‹CustomResourceDefinition›

Returns: Promise‹CustomResourceDefinition›

Protected defaultSorting#

▸ defaultSorting(item: CustomResourceDefinition): string

Inherited from KubeObjectStore.defaultSorting

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

Parameters:

Name Type
item CustomResourceDefinition

Returns: string

Protected filterItemsOnLoad#

▸ filterItemsOnLoad(items: CustomResourceDefinition[]): T[]

Inherited from KubeObjectStore.filterItemsOnLoad

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

Parameters:

Name Type
items CustomResourceDefinition[]

Returns: T[]

getAllByNs#

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

Inherited from KubeObjectStore.getAllByNs

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

Parameters:

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

Returns: CustomResourceDefinition[]

getByGroup#

▸ getByGroup(group: string, pluralName: string): CustomResourceDefinition‹›

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

Parameters:

Name Type
group string
pluralName string

Returns: CustomResourceDefinition‹›

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): CustomResourceDefinition[]

Inherited from KubeObjectStore.getByLabel

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

Parameters:

Name Type
labels string[] | object

Returns: CustomResourceDefinition[]

getByName#

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

Inherited from KubeObjectStore.getByName

Overrides void

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

Parameters:

Name Type
name string
namespace? string

Returns: CustomResourceDefinition

getByObject#

▸ getByObject(obj: KubeObject): CustomResourceDefinition‹›

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

Parameters:

Name Type
obj KubeObject

Returns: CustomResourceDefinition‹›

getByPath#

▸ getByPath(path: string): CustomResourceDefinition

Inherited from KubeObjectStore.getByPath

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

Parameters:

Name Type
path string

Returns: CustomResourceDefinition

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(): CustomResourceDefinition[]

Inherited from KubeObjectStore.getItems

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

Returns: CustomResourceDefinition[]

Optional getStatuses#

▸ getStatuses(items: CustomResourceDefinition[]): Record‹string, number›

Inherited from KubeObjectStore.getStatuses

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

Parameters:

Name Type
items CustomResourceDefinition[]

Returns: Record‹string, number›

getSubscribeApis#

▸ getSubscribeApis(): KubeApi[]

Inherited from KubeObjectStore.getSubscribeApis

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

Returns: KubeApi[]

getTotalCount#

▸ getTotalCount(): number

Inherited from KubeObjectStore.getTotalCount

Overrides void

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

Returns: number

isSelected#

▸ isSelected(item: CustomResourceDefinition): boolean

Inherited from KubeObjectStore.isSelected

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

Parameters:

Name Type
item CustomResourceDefinition

Returns: boolean

isSelectedAll#

▸ isSelectedAll(visibleItems: CustomResourceDefinition[]): boolean

Inherited from KubeObjectStore.isSelectedAll

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

Parameters:

Name Type Default
visibleItems CustomResourceDefinition[] this.items

Returns: boolean

load#

▸ load(params: object): Promise‹CustomResourceDefinition›

Inherited from KubeObjectStore.load

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

Parameters:

▪ params: object

Name Type
name string
namespace? string

Returns: Promise‹CustomResourceDefinition›

loadAll#

▸ loadAll(options: object): Promise‹void | CustomResourceDefinition[]›

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

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‹CustomResourceDefinition›

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‹CustomResourceDefinition›

Protected loadItems#

▸ loadItems(__namedParameters: object): Promise‹CustomResourceDefinition[]›

Inherited from KubeObjectStore.loadItems

Overrides void

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

Parameters:

▪ __namedParameters: object

Name Type
api KubeApi‹any›
namespaces string[]

Returns: Promise‹CustomResourceDefinition[]›

Protected mergeItems#

▸ mergeItems(partialItems: CustomResourceDefinition[], __namedParameters: object): CustomResourceDefinition[]

Inherited from KubeObjectStore.mergeItems

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

Parameters:

▪ partialItems: CustomResourceDefinition[]

▪Default value __namedParameters: object= {}

Name Type Default
filter boolean true
replace boolean false
sort boolean true
updateStore boolean true

Returns: CustomResourceDefinition[]

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: CustomResourceDefinition): Promise‹void›

Inherited from KubeObjectStore.remove

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

Parameters:

Name Type
item CustomResourceDefinition

Returns: Promise‹void›

Protected removeItem#

▸ removeItem(item: CustomResourceDefinition, request: function): Promise‹void›

Inherited from KubeObjectStore.removeItem

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

Parameters:

▪ item: CustomResourceDefinition

▪ 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

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: CustomResourceDefinition): void

Inherited from KubeObjectStore.select

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

Parameters:

Name Type
item CustomResourceDefinition

Returns: void

Protected sortItems#

▸ sortItems(items: CustomResourceDefinition[]): CustomResourceDefinition‹›[]

Overrides KubeObjectStore.sortItems

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

Parameters:

Name Type
items CustomResourceDefinition[]

Returns: CustomResourceDefinition‹›[]

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)

toggleSelection#

▸ toggleSelection(item: CustomResourceDefinition): void

Inherited from KubeObjectStore.toggleSelection

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

Parameters:

Name Type
item CustomResourceDefinition

Returns: void

toggleSelectionAll#

▸ toggleSelectionAll(visibleItems: CustomResourceDefinition[]): void

Inherited from KubeObjectStore.toggleSelectionAll

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

Parameters:

Name Type Default
visibleItems CustomResourceDefinition[] this.items

Returns: void

unselect#

▸ unselect(item: CustomResourceDefinition): void

Inherited from KubeObjectStore.unselect

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

Parameters:

Name Type
item CustomResourceDefinition

Returns: void

update#

▸ update(item: CustomResourceDefinition, data: Partial‹CustomResourceDefinition›): Promise‹CustomResourceDefinition›

Inherited from KubeObjectStore.update

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

Parameters:

Name Type
item CustomResourceDefinition
data Partial‹CustomResourceDefinition›

Returns: Promise‹CustomResourceDefinition›

Protected updateFromEventsBuffer#

▸ updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

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

Returns: void

Protected updateItem#

▸ updateItem(item: CustomResourceDefinition, request: function): Promise‹T›

Inherited from KubeObjectStore.updateItem

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

Parameters:

▪ item: CustomResourceDefinition

▪ request: function

▸ (): Promise‹CustomResourceDefinition›

Returns: Promise‹T›