Class: KubeObjectStore<K, A, D>#

Main.K8sApi.KubeObjectStore

Type parameters#

Name	Type
`K`	extends `KubeObject` = `KubeObject`
`A`	extends `InternalKubeApi`<`K`, `D`> = `InternalKubeApi`<`K`, `KubeJsonApiDataFor`<`K`>>
`D`	extends `KubeJsonApiDataFor`<`K`> = `KubeApiDataFrom`<`K`, `A`>

Hierarchy#

KubeObjectStore<K, A, D>

↳ KubeObjectStore

Table of contents#

Constructors#

constructor

Properties#

Accessors#

Methods#

Constructors#

constructor#

• new KubeObjectStore<K, A, D>(api, opts?)

Type parameters#

Name	Type
`K`	extends `KubeObject`<`KubeObjectMetadata`<`KubeObjectScope`>, `unknown`, `unknown`, `K`> = `KubeObject`<`KubeObjectMetadata`<`KubeObjectScope`>, `unknown`, `unknown`>
`A`	extends `KubeApi`<`K`, `D`, `A`> = `KubeApi`<`K`, `KubeJsonApiDataFor`<`K`>>
`D`	extends `KubeJsonApiData`<`KubeObjectMetadata`<`KubeObjectScope`>, `unknown`, `unknown`, `D`> = `KubeApiDataFrom`<`K`, `A`>

Parameters#

Name	Type
`api`	`A`
`opts?`	`KubeObjectStoreOptions`

Overrides#

InternalKubeObjectStore<K, A, D\>.constructor

• new KubeObjectStore<K, A, D>()

Deprecated

Supply API instance through constructor

Type parameters#

Name	Type
`K`	extends `KubeObject`<`KubeObjectMetadata`<`KubeObjectScope`>, `unknown`, `unknown`, `K`> = `KubeObject`<`KubeObjectMetadata`<`KubeObjectScope`>, `unknown`, `unknown`>
`A`	extends `KubeApi`<`K`, `D`, `A`> = `KubeApi`<`K`, `KubeJsonApiDataFor`<`K`>>
`D`	extends `KubeJsonApiData`<`KubeObjectMetadata`<`KubeObjectScope`>, `unknown`, `unknown`, `D`> = `KubeApiDataFrom`<`K`, `A`>

Overrides#

InternalKubeObjectStore<K, A, D\>.constructor

Properties#

api#

• Readonly api: A

Inherited from#

InternalKubeObjectStore.api

bufferSize#

• Readonly bufferSize: number

Inherited from#

InternalKubeObjectStore.bufferSize

defaultSorting#

• Protected defaultSorting: (item: K) => string

Type declaration#

▸ (item): string

Parameters#

Name	Type
`item`	`K`

Returns#

string

Inherited from#

InternalKubeObjectStore.defaultSorting

dependencies#

• Protected Readonly dependencies: KubeObjectStoreDependencies

Inherited from#

InternalKubeObjectStore.dependencies

eventsBuffer#

• Protected Readonly eventsBuffer: IObservableArray<IKubeWatchEvent<D>>

Inherited from#

InternalKubeObjectStore.eventsBuffer

failedLoading#

• failedLoading: boolean

Inherited from#

InternalKubeObjectStore.failedLoading

isLoaded#

• isLoaded: boolean

Inherited from#

InternalKubeObjectStore.isLoaded

isLoading#

• isLoading: boolean

Inherited from#

InternalKubeObjectStore.isLoading

items#

• items: IObservableArray<K>

Inherited from#

InternalKubeObjectStore.items

limit#

• Readonly limit: undefined | number

Inherited from#

InternalKubeObjectStore.limit

selectedItemsIds#

• selectedItemsIds: ObservableSet<string>

Inherited from#

InternalKubeObjectStore.selectedItemsIds

context#

▪ Static Readonly context: Object

Deprecated

This is no longer used and shouldn't have been every really used

Type declaration#

Name	Type
`get`	() => `ClusterContext`
`set`	(`ctx`: `ClusterContext`) => `void`

Accessors#

context#

• get context(): ClusterContext

Returns#

ClusterContext

contextItems#

• get contextItems(): K[]

Returns#

K[]

Inherited from#

InternalKubeObjectStore.contextItems

query#

• get query(): KubeApiQueryParams

Returns#

KubeApiQueryParams

Inherited from#

InternalKubeObjectStore.query

selectedItems#

• get selectedItems(): Item[]

Returns#

Item[]

Inherited from#

InternalKubeObjectStore.selectedItems

Methods#

[iterator]#

▸ [iterator](): Generator<K, void, undefined>

Returns#

Generator<K, void, undefined>

Inherited from#

InternalKubeObjectStore.__@iterator@189

bindWatchEventsUpdater#

▸ Protected bindWatchEventsUpdater(delay?): void

Parameters#

Name	Type
`delay?`	`number`

Returns#

void

Inherited from#

InternalKubeObjectStore.bindWatchEventsUpdater

create#

▸ create(params, data?): Promise<K>

Parameters#

Name	Type
`params`	`Object`
`params.name`	`string`
`params.namespace?`	`string`
`data?`	`PartialDeep`<`K`>

Returns#

Promise<K>

Inherited from#

InternalKubeObjectStore.create

createItem#

▸ Protected createItem(params, data?): Promise<null | K>

Parameters#

Name	Type
`params`	`Object`
`params.name`	`string`
`params.namespace?`	`string`
`data?`	`PartialDeep`<`K`>

Returns#

Promise<null | K>

Inherited from#

InternalKubeObjectStore.createItem

filterItemsOnLoad#

▸ Protected filterItemsOnLoad(items): K[]

Parameters#

Name	Type
`items`	`K`[]

Returns#

K[]

Inherited from#

InternalKubeObjectStore.filterItemsOnLoad

getAllByNs#

▸ getAllByNs(namespace, strict?): K[]

Parameters#

Name	Type
`namespace`	`string` \| `string`[]
`strict?`	`boolean`

Returns#

K[]

Inherited from#

InternalKubeObjectStore.getAllByNs

getById#

▸ getById(id): undefined | K

Parameters#

Name	Type
`id`	`string`

Returns#

undefined | K

Inherited from#

InternalKubeObjectStore.getById

getByLabel#

▸ getByLabel(labels): K[]

Parameters#

Name	Type
`labels`	`string`[] \| `Partial`<`Record`<`string`, `string`>>

Returns#

K[]

Inherited from#

InternalKubeObjectStore.getByLabel

getByName#

▸ getByName(name, namespace?): undefined | K

Parameters#

Name	Type
`name`	`string`
`namespace?`	`string`

Returns#

undefined | K

Inherited from#

InternalKubeObjectStore.getByName

getByPath#

▸ getByPath(path): undefined | K

Parameters#

Name	Type
`path`	`string`

Returns#

undefined | K

Inherited from#

InternalKubeObjectStore.getByPath

getIndexById#

▸ getIndexById(id): number

Parameters#

Name	Type
`id`	`string`

Returns#

number

Inherited from#

InternalKubeObjectStore.getIndexById

getItems#

▸ getItems(): K[]

Returns#

K[]

Inherited from#

InternalKubeObjectStore.getItems

getTotalCount#

▸ getTotalCount(): number

Returns#

number

Inherited from#

InternalKubeObjectStore.getTotalCount

isSelected#

▸ isSelected(item): boolean

Parameters#

Name	Type
`item`	`K`

Returns#

boolean

Inherited from#

InternalKubeObjectStore.isSelected

isSelectedAll#

▸ isSelectedAll(visibleItems?): boolean

Parameters#

Name	Type
`visibleItems?`	`K`[]

Returns#

boolean

Inherited from#

InternalKubeObjectStore.isSelectedAll

load#

▸ load(params): Promise<K>

Parameters#

Name	Type
`params`	`Object`
`params.name`	`string`
`params.namespace?`	`string`

Returns#

Promise<K>

Inherited from#

InternalKubeObjectStore.load

loadAll#

▸ loadAll(«destructured»?): Promise<undefined | K[]>

Parameters#

Name	Type
`«destructured»`	`KubeObjectStoreLoadAllParams`

Returns#

Promise<undefined | K[]>

Inherited from#

InternalKubeObjectStore.loadAll

loadFromPath#

▸ loadFromPath(resourcePath): Promise<K>

Parameters#

Name	Type
`resourcePath`	`string`

Returns#

Promise<K>

Inherited from#

InternalKubeObjectStore.loadFromPath

loadItem#

▸ Protected loadItem(params): Promise<null | K>

Parameters#

Name	Type
`params`	`Object`
`params.name`	`string`
`params.namespace?`	`string`

Returns#

Promise<null | K>

Inherited from#

InternalKubeObjectStore.loadItem

loadItems#

▸ Protected loadItems(«destructured»): Promise<K[]>

Parameters#

Name	Type
`«destructured»`	`KubeObjectStoreLoadingParams`

Returns#

Promise<K[]>

Inherited from#

InternalKubeObjectStore.loadItems

mergeItems#

▸ Protected mergeItems(partialItems, «destructured»): K[]

Parameters#

Name	Type
`partialItems`	`K`[]
`«destructured»`	`MergeItemsOptions`

Returns#

K[]

Inherited from#

InternalKubeObjectStore.mergeItems

patch#

▸ patch(item, patch): Promise<K>

Parameters#

Name	Type
`item`	`K`
`patch`	`Patch`

Returns#

Promise<K>

Inherited from#

InternalKubeObjectStore.patch

pickOnlySelected#

▸ pickOnlySelected(items): K[]

Parameters#

Name	Type
`items`	`K`[]

Returns#

K[]

Inherited from#

InternalKubeObjectStore.pickOnlySelected

reloadAll#

▸ reloadAll(opts?): Promise<undefined | K[]>

Parameters#

Name	Type
`opts?`	`Object`
`opts.force?`	`boolean`
`opts.merge?`	`boolean`
`opts.namespaces?`	`string`[]

Returns#

Promise<undefined | K[]>

Inherited from#

InternalKubeObjectStore.reloadAll

remove#

▸ remove(item): Promise<void>

Parameters#

Name	Type
`item`	`K`

Returns#

Promise<void>

Inherited from#

InternalKubeObjectStore.remove

removeItem#

▸ Protected removeItem(item, request): Promise<void>

Parameters#

Name	Type
`item`	`K`
`request`	() => `Promise`<`any`>

Returns#

Promise<void>

Inherited from#

InternalKubeObjectStore.removeItem

removeItems#

▸ removeItems(items): Promise<void>

Parameters#

Name	Type
`items`	`K`[]

Returns#

Promise<void>

Inherited from#

InternalKubeObjectStore.removeItems

removeSelectedItems#

▸ removeSelectedItems(): Promise<void>

Returns#

Promise<void>

Inherited from#

InternalKubeObjectStore.removeSelectedItems

reset#

▸ reset(): void

Returns#

void

Inherited from#

InternalKubeObjectStore.reset

resetOnError#

▸ Protected resetOnError(error): void

Parameters#

Name	Type
`error`	`any`

Returns#

void

Inherited from#

InternalKubeObjectStore.resetOnError

resetSelection#

▸ resetSelection(): void

Returns#

void

Inherited from#

InternalKubeObjectStore.resetSelection

select#

▸ select(item): void

Parameters#

Name	Type
`item`	`K`

Returns#

void

Inherited from#

InternalKubeObjectStore.select

sortItems#

▸ Protected sortItems(items?, sorting?, order?): K[]

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	Description
`items?`	`K`[]	the items to be sorted (default: the current items in this store)
`sorting?`	(`item`: `K`) => `any`[]	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#

K[]

Inherited from#

InternalKubeObjectStore.sortItems

▸ subscribe(«destructured»?): Disposer

Parameters#

Name	Type
`«destructured»`	`KubeObjectStoreSubscribeParams`

Returns#

Disposer

Inherited from#

InternalKubeObjectStore.subscribe

toggleSelection#

▸ toggleSelection(item): void

Parameters#

Name	Type
`item`	`K`

Returns#

void

Inherited from#

InternalKubeObjectStore.toggleSelection

toggleSelectionAll#

▸ toggleSelectionAll(visibleItems?): void

Parameters#

Name	Type
`visibleItems?`	`K`[]

Returns#

void

Inherited from#

InternalKubeObjectStore.toggleSelectionAll

unselect#

▸ unselect(item): void

Parameters#

Name	Type
`item`	`K`

Returns#

void

Inherited from#

InternalKubeObjectStore.unselect

update#

▸ update(item, data): Promise<K>

Parameters#

Name	Type
`item`	`K`
`data`	`PartialDeep`<`K`>

Returns#

Promise<K>

Inherited from#

InternalKubeObjectStore.update

updateFromEventsBuffer#

▸ Protected updateFromEventsBuffer(): void

Returns#

void

Inherited from#

InternalKubeObjectStore.updateFromEventsBuffer

updateItem#

▸ Protected updateItem(item, request): Promise<K>

Parameters#

Name	Type
`item`	`K`
`request`	() => `Promise`<`K`>

Returns#

Promise<K>

Inherited from#

InternalKubeObjectStore.updateItem