Class: RolesStore#
Hierarchy#
↳ RolesStore
Index#
Constructors#
Properties#
- api
- bufferSize
- eventsBuffer
- failedLoading
- isLoaded
- isLoading
- items
- limit
- selectedItemsIds
- defaultContext
Accessors#
Methods#
- [Symbol.iterator]
- bindWatchEventsUpdater
- create
- createItem
- defaultSorting
- filterItemsOnLoad
- getAllByNs
- getById
- getByLabel
- getByName
- getByPath
- getIndexById
- getItems
- getStatuses
- getSubscribeApis
- getTotalCount
- isSelected
- isSelectedAll
- load
- loadAll
- loadFromPath
- loadItem
- loadItems
- mergeItems
- reloadAll
- remove
- removeItem
- removeSelectedItems
- reset
- resetOnError
- resetSelection
- select
- sortItems
- subscribe
- toggleSelection
- toggleSelectionAll
- unselect
- update
- updateFromEventsBuffer
- updateItem
Constructors#
constructor#
+ new RolesStore(): RolesStore
Overrides KubeObjectStore.constructor
Defined in src/renderer/components/+user-management-roles/roles.store.ts:28
Returns: RolesStore
Properties#
api#
• api: KubeApi‹ClusterRole‹›› = clusterRoleApi
Overrides KubeObjectStore.api
Defined in src/renderer/components/+user-management-roles/roles.store.ts:28
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
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
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#
context#
• get context(): ClusterContext
Inherited from KubeObjectStore.context
Defined in src/renderer/kube-object.store.ts:63
Returns: ClusterContext
contextItems#
• get contextItems(): Role[]
Inherited from KubeObjectStore.contextItems
Defined in src/renderer/kube-object.store.ts:67
Returns: Role[]
contextReady#
• get contextReady(): Promise‹void› & object
Inherited from KubeObjectStore.contextReady
Defined in src/renderer/kube-object.store.ts:48
Returns: Promise‹void› & object
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(): Role[]
Inherited from KubeObjectStore.selectedItems
Defined in src/renderer/item.store.ts:47
Returns: Role[]
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
create#
▸ create(params: object, data?: Partial‹Role›): Promise‹Role›
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‹Role›
Returns: Promise‹Role›
Protected createItem#
▸ createItem(params: object, data?: Partial‹Role›): Promise‹Role‹››
Overrides KubeObjectStore.createItem
Defined in src/renderer/components/+user-management-roles/roles.store.ts:61
Parameters:
▪ params: object
| Name | Type |
|---|---|
name |
string |
namespace? |
string |
▪Optional data: Partial‹Role›
Returns: Promise‹Role‹››
Protected defaultSorting#
▸ defaultSorting(item: Role): string
Inherited from KubeObjectStore.defaultSorting
Defined in src/renderer/item.store.ts:34
Parameters:
| Name | Type |
|---|---|
item |
Role |
Returns: string
Protected filterItemsOnLoad#
▸ filterItemsOnLoad(items: Role[]): T[]
Inherited from KubeObjectStore.filterItemsOnLoad
Defined in src/renderer/kube-object.store.ts:166
Parameters:
| Name | Type |
|---|---|
items |
Role[] |
Returns: T[]
getAllByNs#
▸ getAllByNs(namespace: string | string[], strict: boolean): Role[]
Inherited from KubeObjectStore.getAllByNs
Defined in src/renderer/kube-object.store.ts:93
Parameters:
| Name | Type | Default |
|---|---|---|
namespace |
string | string[] | - |
strict |
boolean | false |
Returns: Role[]
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): Role[]
Inherited from KubeObjectStore.getByLabel
Defined in src/renderer/kube-object.store.ts:123
Parameters:
| Name | Type |
|---|---|
labels |
string[] | object |
Returns: Role[]
getByName#
▸ getByName(name: string, namespace?: string): Role
Inherited from KubeObjectStore.getByName
Overrides void
Defined in src/renderer/kube-object.store.ts:111
Parameters:
| Name | Type |
|---|---|
name |
string |
namespace? |
string |
Returns: Role
getByPath#
▸ getByPath(path: string): Role
Inherited from KubeObjectStore.getByPath
Defined in src/renderer/kube-object.store.ts:119
Parameters:
| Name | Type |
|---|---|
path |
string |
Returns: Role
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(): Role[]
Inherited from KubeObjectStore.getItems
Defined in src/renderer/item.store.ts:51
Returns: Role[]
Optional getStatuses#
▸ getStatuses(items: Role[]): Record‹string, number›
Inherited from KubeObjectStore.getStatuses
Defined in src/renderer/kube-object.store.ts:91
Parameters:
| Name | Type |
|---|---|
items |
Role[] |
Returns: Record‹string, number›
getSubscribeApis#
▸ getSubscribeApis(): KubeApi‹Role‹››[]
Overrides KubeObjectStore.getSubscribeApis
Defined in src/renderer/components/+user-management-roles/roles.store.ts:35
getTotalCount#
▸ getTotalCount(): number
Inherited from KubeObjectStore.getTotalCount
Overrides void
Defined in src/renderer/kube-object.store.ts:77
Returns: number
isSelected#
▸ isSelected(item: Role): boolean
Inherited from KubeObjectStore.isSelected
Defined in src/renderer/item.store.ts:160
Parameters:
| Name | Type |
|---|---|
item |
Role |
Returns: boolean
isSelectedAll#
▸ isSelectedAll(visibleItems: Role[]): boolean
Inherited from KubeObjectStore.isSelectedAll
Defined in src/renderer/item.store.ts:194
Parameters:
| Name | Type | Default |
|---|---|---|
visibleItems |
Role[] | this.items |
Returns: boolean
load#
▸ load(params: object): Promise‹Role›
Inherited from KubeObjectStore.load
Defined in src/renderer/kube-object.store.ts:247
Parameters:
▪ params: object
| Name | Type |
|---|---|
name |
string |
namespace? |
string |
Returns: Promise‹Role›
loadAll#
▸ loadAll(options: object): Promise‹void | Role[]›
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 | Role[]›
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‹Role‹››
Overrides KubeObjectStore.loadItem
Defined in src/renderer/components/+user-management-roles/roles.store.ts:46
Parameters:
▪ params: object
| Name | Type |
|---|---|
name |
string |
namespace? |
string |
Returns: Promise‹Role‹››
Protected loadItems#
▸ loadItems(params: KubeObjectStoreLoadingParams): Promise‹Role[]›
Overrides KubeObjectStore.loadItems
Defined in src/renderer/components/+user-management-roles/roles.store.ts:52
Parameters:
| Name | Type |
|---|---|
params |
KubeObjectStoreLoadingParams |
Returns: Promise‹Role[]›
Protected mergeItems#
▸ mergeItems(partialItems: Role[], __namedParameters: object): Role[]
Inherited from KubeObjectStore.mergeItems
Defined in src/renderer/kube-object.store.ts:218
Parameters:
▪ partialItems: Role[]
▪Default value __namedParameters: object= {}
| Name | Type | Default |
|---|---|---|
filter |
boolean | true |
replace |
boolean | false |
sort |
boolean | true |
updateStore |
boolean | true |
Returns: Role[]
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: Role): Promise‹void›
Inherited from KubeObjectStore.remove
Defined in src/renderer/kube-object.store.ts:290
Parameters:
| Name | Type |
|---|---|
item |
Role |
Returns: Promise‹void›
Protected removeItem#
▸ removeItem(item: Role, request: function): Promise‹void›
Inherited from KubeObjectStore.removeItem
Defined in src/renderer/item.store.ts:154
Parameters:
▪ item: Role
▪ 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: Role): void
Inherited from KubeObjectStore.select
Defined in src/renderer/item.store.ts:165
Parameters:
| Name | Type |
|---|---|
item |
Role |
Returns: void
Protected sortItems#
▸ sortItems(items: Role[]): Role‹›[]
Overrides KubeObjectStore.sortItems
Defined in src/renderer/components/+user-management-roles/roles.store.ts:39
Parameters:
| Name | Type |
|---|---|
items |
Role[] |
Returns: Role‹›[]
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)
toggleSelection#
▸ toggleSelection(item: Role): void
Inherited from KubeObjectStore.toggleSelection
Defined in src/renderer/item.store.ts:175
Parameters:
| Name | Type |
|---|---|
item |
Role |
Returns: void
toggleSelectionAll#
▸ toggleSelectionAll(visibleItems: Role[]): void
Inherited from KubeObjectStore.toggleSelectionAll
Defined in src/renderer/item.store.ts:184
Parameters:
| Name | Type | Default |
|---|---|---|
visibleItems |
Role[] | this.items |
Returns: void
unselect#
▸ unselect(item: Role): void
Inherited from KubeObjectStore.unselect
Defined in src/renderer/item.store.ts:170
Parameters:
| Name | Type |
|---|---|
item |
Role |
Returns: void
update#
▸ update(item: Role, data: Partial‹Role›): Promise‹Role›
Inherited from KubeObjectStore.update
Defined in src/renderer/kube-object.store.ts:281
Parameters:
| Name | Type |
|---|---|
item |
Role |
data |
Partial‹Role› |
Returns: Promise‹Role›
Protected updateFromEventsBuffer#
▸ updateFromEventsBuffer(): void
Inherited from KubeObjectStore.updateFromEventsBuffer
Defined in src/renderer/kube-object.store.ts:398
Returns: void
Protected updateItem#
▸ updateItem(item: Role, request: function): Promise‹T›
Inherited from KubeObjectStore.updateItem
Defined in src/renderer/item.store.ts:144
Parameters:
▪ item: Role
▪ request: function
▸ (): Promise‹Role›
Returns: Promise‹T›