Skip to content

Class: NamespaceStore#

Hierarchy#

↳ KubeObjectStore‹Namespace›

↳ NamespaceStore

Index#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

+ new NamespaceStore(): NamespaceStore

Overrides KubeObjectStore.constructor

Defined in src/renderer/components/+namespaces/namespace.store.ts:30

Returns: NamespaceStore

Properties#

api#

• api: KubeApi‹Namespace‹›› = namespacesApi

Overrides KubeObjectStore.api

Defined in src/renderer/components/+namespaces/namespace.store.ts:29


bufferSize#

• bufferSize: number = 50000

Inherited from KubeObjectStore.bufferSize

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


Protected eventsBuffer#

• eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

Inherited from KubeObjectStore.eventsBuffer

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


failedLoading#

• failedLoading: boolean = false

Inherited from KubeObjectStore.failedLoading

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


isLoaded#

• isLoaded: boolean = false

Inherited from KubeObjectStore.isLoaded

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


isLoading#

• isLoading: boolean = false

Inherited from KubeObjectStore.isLoading

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


items#

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

Inherited from KubeObjectStore.items

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


Optional limit#

• limit? : number

Inherited from KubeObjectStore.limit

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


selectedItemsIds#

• selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

Inherited from KubeObjectStore.selectedItemsIds

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


Static defaultContext#

▪ defaultContext: IObservableValue‹ClusterContext› = observable.box()

Inherited from KubeObjectStore.defaultContext

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

Accessors#

allowedNamespaces#

• get allowedNamespaces(): string[]

Defined in src/renderer/components/+namespaces/namespace.store.ts:85

Returns: string[]


context#

• get context(): ClusterContext

Inherited from KubeObjectStore.context

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

Returns: ClusterContext


contextItems#

• get contextItems(): Namespace[]

Inherited from KubeObjectStore.contextItems

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

Returns: Namespace[]


contextNamespaces#

• get contextNamespaces(): string[]

Defined in src/renderer/components/+namespaces/namespace.store.ts:92

Returns: string[]


contextReady#

• get contextReady(): Promise‹void› & object

Inherited from KubeObjectStore.contextReady

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

Returns: Promise‹void› & object


hasAllContexts#

• get hasAllContexts(): boolean

Defined in src/renderer/components/+namespaces/namespace.store.ts:148

Returns: boolean


namespacesReady#

• get namespacesReady(): Promise‹void› & object

Inherited from KubeObjectStore.namespacesReady

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

Returns: Promise‹void› & object


query#

• get query(): IKubeApiQueryParams

Inherited from KubeObjectStore.query

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

Returns: IKubeApiQueryParams


selectedItems#

• get selectedItems(): Namespace[]

Inherited from KubeObjectStore.selectedItems

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

Returns: Namespace[]


selectedNamespaces#

• get selectedNamespaces(): string[]

Defined in src/renderer/components/+namespaces/namespace.store.ts:81

Returns: string[]

Methods#

[Symbol.iterator]#

▸ [Symbol.iterator](): Generator‹T, void, undefined›

Inherited from KubeObjectStore.[Symbol.iterator]

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

Returns: Generator‹T, void, undefined›


Protected bindWatchEventsUpdater#

▸ bindWatchEventsUpdater(delay: number): void

Inherited from KubeObjectStore.bindWatchEventsUpdater

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

Parameters:

Name Type Default
delay number 1000

Returns: void


clearSelected#

▸ clearSelected(namespaces?: string | string[]): void

Defined in src/renderer/components/+namespaces/namespace.store.ts:131

Parameters:

Name Type
namespaces? string | string[]

Returns: void


create#

▸ create(params: object, data?: Partial‹Namespace›): Promise‹Namespace›

Inherited from KubeObjectStore.create

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

Parameters:

▪ params: object

Name Type
name string
namespace? string

▪Optional data: Partial‹Namespace›

Returns: Promise‹Namespace›


Protected createItem#

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

Inherited from KubeObjectStore.createItem

Overrides void

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

Parameters:

▪ params: object

Name Type
name string
namespace? string

▪Optional data: Partial‹Namespace›

Returns: Promise‹Namespace›


Protected defaultSorting#

▸ defaultSorting(item: Namespace): string

Inherited from KubeObjectStore.defaultSorting

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

Parameters:

Name Type
item Namespace

Returns: string


Protected filterItemsOnLoad#

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

Inherited from KubeObjectStore.filterItemsOnLoad

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

Parameters:

Name Type
items Namespace[]

Returns: T[]


getAllByNs#

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

Inherited from KubeObjectStore.getAllByNs

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

Parameters:

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

Returns: Namespace[]


getById#

▸ getById(id: string): T

Inherited from KubeObjectStore.getById

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

Parameters:

Name Type
id string

Returns: T


getByLabel#

▸ getByLabel(labels: string[] | object): Namespace[]

Inherited from KubeObjectStore.getByLabel

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

Parameters:

Name Type
labels string[] | object

Returns: Namespace[]


getByName#

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

Inherited from KubeObjectStore.getByName

Overrides void

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

Parameters:

Name Type
name string
namespace? string

Returns: Namespace


getByPath#

▸ getByPath(path: string): Namespace

Inherited from KubeObjectStore.getByPath

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

Parameters:

Name Type
path string

Returns: Namespace


getIndexById#

▸ getIndexById(id: string): number

Inherited from KubeObjectStore.getIndexById

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

Parameters:

Name Type
id string

Returns: number


getItems#

▸ getItems(): Namespace[]

Inherited from KubeObjectStore.getItems

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

Returns: Namespace[]


Optional getStatuses#

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

Inherited from KubeObjectStore.getStatuses

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

Parameters:

Name Type
items Namespace[]

Returns: Record‹string, number›


getSubscribeApis#

▸ getSubscribeApis(): KubeApi‹any›[]

Overrides KubeObjectStore.getSubscribeApis

Defined in src/renderer/components/+namespaces/namespace.store.ts:100

Returns: KubeApi‹any›[]


getTotalCount#

▸ getTotalCount(): number

Inherited from KubeObjectStore.getTotalCount

Overrides void

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

Returns: number


hasContext#

▸ hasContext(namespaces: string | string[]): boolean

Defined in src/renderer/components/+namespaces/namespace.store.ts:142

Parameters:

Name Type
namespaces string | string[]

Returns: boolean


isSelected#

▸ isSelected(item: Namespace): boolean

Inherited from KubeObjectStore.isSelected

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

Parameters:

Name Type
item Namespace

Returns: boolean


isSelectedAll#

▸ isSelectedAll(visibleItems: Namespace[]): boolean

Inherited from KubeObjectStore.isSelectedAll

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

Parameters:

Name Type Default
visibleItems Namespace[] this.items

Returns: boolean


load#

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

Inherited from KubeObjectStore.load

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

Parameters:

▪ params: object

Name Type
name string
namespace? string

Returns: Promise‹Namespace›


loadAll#

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

Inherited from KubeObjectStore.loadAll

Overrides void

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

Parameters:

▪Default value options: object= {}

Name Type
merge? boolean
namespaces? string[]
reqInit? RequestInit

Returns: Promise‹void | Namespace[]›


loadFromPath#

▸ loadFromPath(resourcePath: string): Promise‹T›

Inherited from KubeObjectStore.loadFromPath

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

Parameters:

Name Type
resourcePath string

Returns: Promise‹T›


Protected loadItem#

▸ loadItem(params: object): Promise‹Namespace›

Inherited from KubeObjectStore.loadItem

Overrides void

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

Parameters:

▪ params: object

Name Type
name string
namespace? string

Returns: Promise‹Namespace›


Protected loadItems#

▸ loadItems(params: KubeObjectStoreLoadingParams): Promise‹Namespace‹›[]›

Overrides KubeObjectStore.loadItems

Defined in src/renderer/components/+namespaces/namespace.store.ts:109

Parameters:

Name Type
params KubeObjectStoreLoadingParams

Returns: Promise‹Namespace‹›[]›


Protected mergeItems#

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

Inherited from KubeObjectStore.mergeItems

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

Parameters:

▪ partialItems: Namespace[]

▪Default value __namedParameters: object= {}

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

Returns: Namespace[]


onContextChange#

▸ onContextChange(callback: function, opts: IReactionOptions): IReactionDisposer

Defined in src/renderer/components/+namespaces/namespace.store.ts:48

Parameters:

▪ callback: function

▸ (namespaces: string[]): void

Parameters:

Name Type
namespaces string[]

▪Default value opts: IReactionOptions= {}

Returns: IReactionDisposer


reloadAll#

▸ reloadAll(opts: object): Promise‹void | T[]›

Inherited from KubeObjectStore.reloadAll

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

Parameters:

▪Default value opts: object= {}

Name Type
force? boolean
merge? boolean
namespaces? string[]

Returns: Promise‹void | T[]›


remove#

▸ remove(item: Namespace): Promise‹void›

Overrides KubeObjectStore.remove

Defined in src/renderer/components/+namespaces/namespace.store.ts:175

Parameters:

Name Type
item Namespace

Returns: Promise‹void›


Protected removeItem#

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

Inherited from KubeObjectStore.removeItem

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

Parameters:

▪ item: Namespace

▪ 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:296

Returns: Promise‹void[]›


reset#

▸ reset(): void

Inherited from KubeObjectStore.reset

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

Returns: void


Protected resetOnError#

▸ resetOnError(error: any): void

Inherited from KubeObjectStore.resetOnError

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

Parameters:

Name Type
error any

Returns: void


resetSelection#

▸ resetSelection(): void

Inherited from KubeObjectStore.resetSelection

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

Returns: void


select#

▸ select(item: Namespace): void

Inherited from KubeObjectStore.select

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

Parameters:

Name Type
item Namespace

Returns: void


selectNamespaces#

▸ selectNamespaces(namespace: string | string[]): void

Defined in src/renderer/components/+namespaces/namespace.store.ts:124

Parameters:

Name Type
namespace string | string[]

Returns: void


Protected sortItems#

▸ sortItems(items: Namespace[], sorting: function[], order?: "asc" | "desc"): Namespace[]

Inherited from KubeObjectStore.sortItems

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

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 Default Description
items Namespace[] this.items the items to be sorted (default: the current items in this store)
sorting function[] [this.defaultSorting] 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: Namespace[]


subscribe#

▸ subscribe(apis: KubeApi‹any›[]): (Anonymous function)

Inherited from KubeObjectStore.subscribe

Overrides void

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

Parameters:

Name Type Default
apis KubeApi‹any›[] this.getSubscribeApis()

Returns: (Anonymous function)


toggleAll#

▸ toggleAll(showAll?: boolean): void

Defined in src/renderer/components/+namespaces/namespace.store.ts:162

Parameters:

Name Type
showAll? boolean

Returns: void


toggleContext#

▸ toggleContext(namespaces: string | string[]): void

Defined in src/renderer/components/+namespaces/namespace.store.ts:153

Parameters:

Name Type
namespaces string | string[]

Returns: void


toggleSelection#

▸ toggleSelection(item: Namespace): void

Inherited from KubeObjectStore.toggleSelection

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

Parameters:

Name Type
item Namespace

Returns: void


toggleSelectionAll#

▸ toggleSelectionAll(visibleItems: Namespace[]): void

Inherited from KubeObjectStore.toggleSelectionAll

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

Parameters:

Name Type Default
visibleItems Namespace[] this.items

Returns: void


unselect#

▸ unselect(item: Namespace): void

Inherited from KubeObjectStore.unselect

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

Parameters:

Name Type
item Namespace

Returns: void


update#

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

Inherited from KubeObjectStore.update

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

Parameters:

Name Type
item Namespace
data Partial‹Namespace›

Returns: Promise‹Namespace›


Protected updateFromEventsBuffer#

▸ updateFromEventsBuffer(): void

Inherited from KubeObjectStore.updateFromEventsBuffer

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

Returns: void


Protected updateItem#

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

Inherited from KubeObjectStore.updateItem

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

Parameters:

▪ item: Namespace

▪ request: function

▸ (): Promise‹Namespace›

Returns: Promise‹T›