Class: CRDStore#

Renderer.K8sApi.CRDStore

Hierarchy#

KubeObjectStore<CustomResourceDefinition, CustomResourceDefinitionApi>

↳ CRDStore

Table of contents#

Constructors#

constructor

Properties#

Accessors#

Methods#

Constructors#

constructor#

• new CRDStore(dependencies, api, opts?)

Parameters#

Name	Type
`dependencies`	`CustomResourceDefinitionStoreDependencies`
`api`	`CustomResourceDefinitionApi`
`opts?`	`KubeObjectStoreOptions`

Overrides#

KubeObjectStore.constructor

Properties#

api#

• Readonly api: CustomResourceDefinitionApi

Inherited from#

KubeObjectStore.api

bufferSize#

• Readonly bufferSize: number

Inherited from#

KubeObjectStore.bufferSize

dependencies#

• Protected Readonly dependencies: CustomResourceDefinitionStoreDependencies

eventsBuffer#

• Protected eventsBuffer: IObservableArray<IKubeWatchEvent<KubeJsonApiData<ClusterScopedMetadata, CustomResourceDefinitionStatus, CustomResourceDefinitionSpec>>>

Inherited from#

KubeObjectStore.eventsBuffer

failedLoading#

• failedLoading: boolean = false

Inherited from#

KubeObjectStore.failedLoading

isLoaded#

• isLoaded: boolean = false

Inherited from#

KubeObjectStore.isLoaded

isLoading#

• isLoading: boolean = false

Inherited from#

KubeObjectStore.isLoading

items#

• items: IObservableArray<CustomResourceDefinition>

Inherited from#

KubeObjectStore.items

limit#

• Readonly limit: undefined | number

Inherited from#

KubeObjectStore.limit

selectedItemsIds#

• selectedItemsIds: ObservableSet<string>

Inherited from#

KubeObjectStore.selectedItemsIds

defaultContext#

▪ Static Readonly defaultContext: IObservableValue<undefined | ClusterContext>

Inherited from#

KubeObjectStore.defaultContext

Accessors#

context#

• get context(): undefined | ClusterContext

Returns#

undefined | ClusterContext

Inherited from#

KubeObjectStore.context

contextItems#

• get contextItems(): K[]

Returns#

K[]

Inherited from#

KubeObjectStore.contextItems

contextReady#

• get contextReady(): Promise<void> & { cancel: () => void }

Returns#

Promise<void> & { cancel: () => void }

Inherited from#

KubeObjectStore.contextReady

groups#

• get groups(): Record<string, CustomResourceDefinition[]>

Returns#

Record<string, CustomResourceDefinition[]>

namespacesReady#

• get namespacesReady(): Promise<void> & { cancel: () => void }

Returns#

Promise<void> & { cancel: () => void }

Inherited from#

KubeObjectStore.namespacesReady

query#

• get query(): KubeApiQueryParams

Returns#

KubeApiQueryParams

Inherited from#

KubeObjectStore.query

selectedItems#

• get selectedItems(): Item[]

Returns#

Item[]

Inherited from#

KubeObjectStore.selectedItems

Methods#

[iterator]#

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

Returns#

Generator<CustomResourceDefinition, void, undefined>

Inherited from#

KubeObjectStore.[iterator]

bindWatchEventsUpdater#

▸ Protected bindWatchEventsUpdater(delay?): void

Parameters#

Name	Type	Default value
`delay`	`number`	`1000`

Returns#

void

Inherited from#

KubeObjectStore.bindWatchEventsUpdater

create#

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

Parameters#

Name	Type
`params`	`Object`
`params.name`	`string`
`params.namespace?`	`string`
`data?`	`PartialObjectDeep`<`CustomResourceDefinition`>

Returns#

Promise<CustomResourceDefinition>

Inherited from#

KubeObjectStore.create

createItem#

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

Parameters#

Name	Type
`params`	`Object`
`params.name`	`string`
`params.namespace?`	`string`
`data?`	`PartialObjectDeep`<`CustomResourceDefinition`>

Returns#

Promise<null | CustomResourceDefinition>

Inherited from#

KubeObjectStore.createItem

defaultSorting#

▸ Protected defaultSorting(item): string

Parameters#

Name	Type
`item`	`Item`

Returns#

string

Inherited from#

KubeObjectStore.defaultSorting

filterItemsOnLoad#

▸ Protected filterItemsOnLoad(items): CustomResourceDefinition[]

Parameters#

Name	Type
`items`	`CustomResourceDefinition`[]

Returns#

CustomResourceDefinition[]

Inherited from#

KubeObjectStore.filterItemsOnLoad

getAllByNs#

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

Parameters#

Name	Type	Default value
`namespace`	`string` \| `string`[]	`undefined`
`strict`	`boolean`	`false`

Returns#

CustomResourceDefinition[]

Inherited from#

KubeObjectStore.getAllByNs

getByGroup#

▸ getByGroup(group, pluralName): undefined | CustomResourceDefinition

Parameters#

Name	Type
`group`	`string`
`pluralName`	`string`

Returns#

undefined | CustomResourceDefinition

getById#

▸ getById(id): undefined | CustomResourceDefinition

Parameters#

Name	Type
`id`	`string`

Returns#

undefined | CustomResourceDefinition

Inherited from#

KubeObjectStore.getById

getByLabel#

▸ getByLabel(labels): CustomResourceDefinition[]

Parameters#

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

Returns#

CustomResourceDefinition[]

Inherited from#

KubeObjectStore.getByLabel

getByName#

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

Parameters#

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

Returns#

undefined | CustomResourceDefinition

Inherited from#

KubeObjectStore.getByName

getByObject#

▸ getByObject(obj): undefined | null | CustomResourceDefinition

Parameters#

Name	Type
`obj`	`KubeObject`<`KubeObjectMetadata`<`KubeObjectScope`>, `unknown`, `unknown`>

Returns#

undefined | null | CustomResourceDefinition

getByPath#

▸ getByPath(path): undefined | CustomResourceDefinition

Parameters#

Name	Type
`path`	`string`

Returns#

undefined | CustomResourceDefinition

Inherited from#

KubeObjectStore.getByPath

getIndexById#

▸ getIndexById(id): number

Parameters#

Name	Type
`id`	`string`

Returns#

number

getTotalCount#

▸ getTotalCount(): number

Returns#

number

Inherited from#

KubeObjectStore.getTotalCount

isSelected#

▸ isSelected(item): boolean

Parameters#

Name	Type
`item`	`CustomResourceDefinition`

Returns#

boolean

Inherited from#

KubeObjectStore.isSelected

isSelectedAll#

▸ isSelectedAll(visibleItems?): boolean

Parameters#

Name	Type
`visibleItems`	`CustomResourceDefinition`[]

Returns#

boolean

Inherited from#

KubeObjectStore.isSelectedAll

load#

▸ load(params): Promise<CustomResourceDefinition>

Parameters#

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

Returns#

Promise<CustomResourceDefinition>

Inherited from#

KubeObjectStore.load

loadAll#

▸ loadAll(__namedParameters?): Promise<undefined | CustomResourceDefinition[]>

Parameters#

Name	Type
`__namedParameters`	`KubeObjectStoreLoadAllParams`

Returns#

Promise<undefined | CustomResourceDefinition[]>

Inherited from#

KubeObjectStore.loadAll

loadFromPath#

▸ loadFromPath(resourcePath): Promise<CustomResourceDefinition>

Parameters#

Name	Type
`resourcePath`	`string`

Returns#

Promise<CustomResourceDefinition>

Inherited from#

KubeObjectStore.loadFromPath

loadItem#

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

Parameters#

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

Returns#

Promise<null | CustomResourceDefinition>

Inherited from#

KubeObjectStore.loadItem

loadItems#

▸ Protected loadItems(__namedParameters): Promise<CustomResourceDefinition[]>

Parameters#

Name	Type
`__namedParameters`	`KubeObjectStoreLoadingParams`

Returns#

Promise<CustomResourceDefinition[]>

Inherited from#

KubeObjectStore.loadItems

mergeItems#

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

Parameters#

Name	Type
`partialItems`	`CustomResourceDefinition`[]
`__namedParameters`	`MergeItemsOptions`

Returns#

CustomResourceDefinition[]

Inherited from#

KubeObjectStore.mergeItems

patch#

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

Parameters#

Name	Type
`item`	`CustomResourceDefinition`
`patch`	`Patch`

Returns#

Promise<CustomResourceDefinition>

Inherited from#

KubeObjectStore.patch

pickOnlySelected#

▸ pickOnlySelected(items): CustomResourceDefinition[]

Parameters#

Name	Type
`items`	`CustomResourceDefinition`[]

Returns#

CustomResourceDefinition[]

Inherited from#

KubeObjectStore.pickOnlySelected

reloadAll#

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

Parameters#

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

Returns#

Promise<undefined | CustomResourceDefinition[]>

Inherited from#

KubeObjectStore.reloadAll

remove#

▸ remove(item): Promise<void>

Parameters#

Name	Type
`item`	`CustomResourceDefinition`

Returns#

Promise<void>

Inherited from#

KubeObjectStore.remove

removeItem#

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

Parameters#

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

Returns#

Promise<void>

Inherited from#

KubeObjectStore.removeItem

removeItems#

▸ removeItems(items): Promise<void>

Parameters#

Name	Type
`items`	`CustomResourceDefinition`[]

Returns#

Promise<void>

Inherited from#

KubeObjectStore.removeItems

removeSelectedItems#

▸ removeSelectedItems(): Promise<void>

Returns#

Promise<void>

Inherited from#

KubeObjectStore.removeSelectedItems

reset#

▸ reset(): void

Returns#

void

Inherited from#

KubeObjectStore.reset

resetOnError#

▸ Protected resetOnError(error): void

Parameters#

Name	Type
`error`	`any`

Returns#

void

Inherited from#

KubeObjectStore.resetOnError

resetSelection#

▸ resetSelection(): void

Returns#

void

Inherited from#

KubeObjectStore.resetSelection

select#

▸ select(item): void

Parameters#

Name	Type
`item`	`CustomResourceDefinition`

Returns#

void

Inherited from#

KubeObjectStore.select

sortItems#

▸ Protected sortItems(items): CustomResourceDefinition[]

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).