From 278ae5c2821eba5bd1e6663b5f772bc43e3b7321 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Wed, 26 May 2021 21:17:53 +0000 Subject: [PATCH] Deployed 57c87a2e71 to master with MkDocs 1.1.2 and mike 1.0.0 --- .../index.html | 2 +- .../index.html | 28 +- .../index.html | 24 +- .../_core_api_catalog_.weblink/index.html | 24 +- .../index.html | 22 +- .../index.html | 92 +- .../index.html | 121 +-- .../index.html | 56 +- .../_core_api_utils_.singleton/index.html | 9 +- .../index.html | 12 +- .../index.html | 24 +- .../index.html | 2 +- .../index.html | 4 +- .../index.html | 2 +- .../index.html | 6 +- .../index.html | 4 +- .../index.html | 30 +- .../index.html | 2 +- .../index.html | 50 +- .../index.html | 20 +- .../index.html | 2 +- .../index.html | 6 +- .../index.html | 2 +- .../_renderer_api_components_.icon/index.html | 12 +- .../index.html | 52 +- .../index.html | 4 +- .../index.html | 16 +- .../index.html | 10 +- .../index.html | 16 +- .../index.html | 6 +- .../index.html | 12 +- .../_renderer_api_components_.menu/index.html | 50 +- .../index.html | 18 +- .../index.html | 20 +- .../index.html | 12 +- .../index.html | 16 +- .../index.html | 16 +- .../index.html | 12 +- .../index.html | 2 +- .../index.html | 16 +- .../index.html | 6 +- .../index.html | 2 +- .../index.html | 14 +- .../index.html | 24 +- .../index.html | 4 +- .../index.html | 8 +- .../index.html | 2 +- .../index.html | 2 +- .../index.html | 2 +- .../_renderer_api_components_.tab/index.html | 24 +- .../index.html | 30 +- .../index.html | 10 +- .../index.html | 6 +- .../index.html | 2 +- .../_renderer_api_components_.tabs/index.html | 6 +- .../index.html | 32 +- .../index.html | 26 +- .../index.html | 2 +- .../index.html | 18 +- .../index.html | 70 +- .../index.html | 74 +- .../index.html | 70 +- .../index.html | 114 +-- .../index.html | 114 +-- .../index.html | 120 +-- .../_renderer_api_k8s_api_.cronjob/index.html | 76 +- .../index.html | 116 +-- .../index.html | 96 +- .../index.html | 80 +- .../index.html | 120 +-- .../index.html | 84 +- .../index.html | 68 +- .../index.html | 120 +-- .../index.html | 72 +- .../index.html | 114 +-- .../index.html | 122 +-- .../index.html | 82 +- .../index.html | 114 +-- .../_renderer_api_k8s_api_.ingress/index.html | 76 +- .../index.html | 62 +- .../index.html | 118 +-- .../_renderer_api_k8s_api_.job/index.html | 88 +- .../index.html | 118 +-- .../_renderer_api_k8s_api_.kubeapi/index.html | 60 +- .../index.html | 96 +- .../index.html | 64 +- .../index.html | 114 +-- .../index.html | 72 +- .../index.html | 114 +-- .../index.html | 68 +- .../index.html | 134 +-- .../index.html | 70 +- .../index.html | 114 +-- .../_renderer_api_k8s_api_.node/index.html | 88 +- .../index.html | 62 +- .../index.html | 134 +-- .../index.html | 76 +- .../index.html | 76 +- .../index.html | 62 +- .../index.html | 116 +-- .../_renderer_api_k8s_api_.pod/index.html | 122 +-- .../index.html | 76 +- .../index.html | 114 +-- .../_renderer_api_k8s_api_.podsapi/index.html | 64 +- .../index.html | 132 +-- .../index.html | 86 +- .../index.html | 122 +-- .../index.html | 68 +- .../index.html | 114 +-- .../index.html | 18 +- .../_renderer_api_k8s_api_.role/index.html | 70 +- .../index.html | 74 +- .../index.html | 116 +-- .../index.html | 114 +-- .../_renderer_api_k8s_api_.secret/index.html | 74 +- .../index.html | 114 +-- .../_renderer_api_k8s_api_.service/index.html | 82 +- .../index.html | 74 +- .../index.html | 114 +-- .../index.html | 114 +-- .../index.html | 82 +- .../index.html | 120 +-- .../index.html | 82 +- .../index.html | 116 +-- .../index.html | 118 +-- .../index.html | 24 +- .../api/classes/lensmainextension/index.html | 42 +- .../classes/lensrendererextension/index.html | 62 +- .../index.html | 6 +- .../index.html | 16 +- .../index.html | 6 +- master/extensions/api/globals/index.html | 1 + .../index.html | 8 +- .../index.html | 8 +- .../index.html | 4 +- .../index.html | 8 +- .../index.html | 6 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 10 +- .../index.html | 4 +- .../index.html | 8 +- .../index.html | 4 +- .../index.html | 6 +- .../index.html | 4 +- .../index.html | 10 +- .../index.html | 2 +- .../index.html | 6 +- .../index.html | 8 +- .../index.html | 10 +- .../index.html | 2 +- .../index.html | 8 +- .../index.html | 2 +- .../index.html | 6 +- .../index.html | 6 +- .../index.html | 2 +- .../index.html | 2 +- .../index.html | 2 +- .../index.html | 6 +- .../index.html | 6 +- .../_interfaces_index_.pagetarget/index.html | 6 +- .../index.html | 4 +- .../index.html | 10 +- .../index.html | 2 +- .../_interfaces_index_.routeparams/index.html | 6 +- .../index.html | 4 +- .../index.html | 10 +- .../index.html | 30 +- .../index.html | 14 +- .../index.html | 12 +- .../index.html | 16 +- .../index.html | 4 +- .../index.html | 18 +- .../index.html | 14 +- .../index.html | 12 +- .../index.html | 2 +- .../index.html | 20 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 30 +- .../index.html | 8 +- .../index.html | 2 +- .../index.html | 4 +- .../index.html | 64 +- .../index.html | 22 +- .../index.html | 4 +- .../index.html | 14 +- .../index.html | 16 +- .../index.html | 10 +- .../index.html | 8 +- .../index.html | 28 +- .../index.html | 10 +- .../index.html | 14 +- .../index.html | 10 +- .../index.html | 4 +- .../index.html | 12 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 8 +- .../index.html | 12 +- .../index.html | 22 +- .../index.html | 8 +- .../index.html | 36 +- .../index.html | 14 +- .../index.html | 14 +- .../index.html | 16 +- .../index.html | 10 +- .../index.html | 4 +- .../index.html | 20 +- .../index.html | 14 +- .../index.html | 20 +- .../index.html | 60 +- .../index.html | 2 +- .../index.html | 26 +- .../index.html | 18 +- .../index.html | 4 +- .../index.html | 6 +- .../index.html | 10 +- .../api/modules/_core_api_app_/index.html | 18 +- .../api/modules/_core_api_catalog_/index.html | 10 +- .../modules/_core_api_event_bus_/index.html | 4 +- .../api/modules/_core_api_ipc_/index.html | 942 ++++++++++++++++++ .../api/modules/_core_api_stores_/index.html | 2 - .../api/modules/_core_api_types_/index.html | 6 +- .../api/modules/_core_api_utils_/index.html | 8 +- .../api/modules/_interfaces_index_/index.html | 4 +- .../_renderer_api_components_/index.html | 76 +- .../modules/_renderer_api_k8s_api_/index.html | 66 +- .../_renderer_api_navigation_/index.html | 12 +- .../modules/_renderer_api_theming_/index.html | 2 +- master/extensions/guides/ipc/index.html | 100 +- master/search/search_index.json | 2 +- master/sitemap.xml.gz | Bin 501 -> 501 bytes 235 files changed, 5241 insertions(+), 4358 deletions(-) rename master/extensions/api/classes/{_core_api_stores_.mainipcstore => _core_api_ipc_.ipcmain}/index.html (91%) rename master/extensions/api/classes/{_core_api_stores_.rendereripcstore => _core_api_ipc_.ipcregistrar}/index.html (89%) create mode 100644 master/extensions/api/modules/_core_api_ipc_/index.html diff --git a/master/extensions/api/classes/_core_api_catalog_.catalogentityregistry/index.html b/master/extensions/api/classes/_core_api_catalog_.catalogentityregistry/index.html index f2487a4abf..959d593f9a 100644 --- a/master/extensions/api/classes/_core_api_catalog_.catalogentityregistry/index.html +++ b/master/extensions/api/classes/_core_api_catalog_.catalogentityregistry/index.html @@ -896,7 +896,7 @@

Methods#

getItemsForApiKind#

getItemsForApiKindT›(apiVersion: string, kind: string): T[]

-

Defined in src/extensions/core-api/catalog.ts:30

+

Defined in src/extensions/core-api/catalog.ts:30

Type parameters:

T: CatalogEntity

Parameters:

diff --git a/master/extensions/api/classes/_core_api_catalog_.kubernetescluster/index.html b/master/extensions/api/classes/_core_api_catalog_.kubernetescluster/index.html index 90824ec0fe..ebfab361c1 100644 --- a/master/extensions/api/classes/_core_api_catalog_.kubernetescluster/index.html +++ b/master/extensions/api/classes/_core_api_catalog_.kubernetescluster/index.html @@ -1059,7 +1059,7 @@

constructor#

+ new KubernetesCluster(data: CatalogEntityDataCatalogEntityMetadata, KubernetesClusterStatus, KubernetesClusterSpec›): KubernetesCluster

Inherited from KubernetesCluster.constructor

-

Defined in src/common/catalog/catalog-entity.ts:153

+

Defined in src/common/catalog/catalog-entity.ts:153

Parameters:

@@ -1081,55 +1081,55 @@

apiVersion: "entity.k8slens.dev/v1alpha1" = "entity.k8slens.dev/v1alpha1"

Implementation of CatalogEntityKindData.apiVersion

Overrides CatalogEntity.apiVersion

-

Defined in src/common/catalog-entities/kubernetes-cluster.ts:56

+

Defined in src/common/catalog-entities/kubernetes-cluster.ts:56


kind#

kind: "KubernetesCluster" = "KubernetesCluster"

Implementation of CatalogEntityKindData.kind

Overrides CatalogEntity.kind

-

Defined in src/common/catalog-entities/kubernetes-cluster.ts:57

+

Defined in src/common/catalog-entities/kubernetes-cluster.ts:57


metadata#

metadata: CatalogEntityMetadata

Inherited from KubernetesCluster.metadata

-

Defined in src/common/catalog/catalog-entity.ts:151

+

Defined in src/common/catalog/catalog-entity.ts:151


spec#

spec: KubernetesClusterSpec

Inherited from KubernetesCluster.spec

-

Defined in src/common/catalog/catalog-entity.ts:153

+

Defined in src/common/catalog/catalog-entity.ts:153


status#

status: KubernetesClusterStatus

Inherited from KubernetesCluster.status

-

Defined in src/common/catalog/catalog-entity.ts:152

+

Defined in src/common/catalog/catalog-entity.ts:152

Methods#

connect#

connect(): Promise‹void›

-

Defined in src/common/catalog-entities/kubernetes-cluster.ts:59

+

Defined in src/common/catalog-entities/kubernetes-cluster.ts:59

Returns: Promise‹void›


disconnect#

disconnect(): Promise‹void›

-

Defined in src/common/catalog-entities/kubernetes-cluster.ts:75

+

Defined in src/common/catalog-entities/kubernetes-cluster.ts:75

Returns: Promise‹void›


getId#

getId(): string

Inherited from KubernetesCluster.getId

-

Defined in src/common/catalog/catalog-entity.ts:162

+

Defined in src/common/catalog/catalog-entity.ts:162

Returns: string


getName#

getName(): string

Inherited from KubernetesCluster.getName

-

Defined in src/common/catalog/catalog-entity.ts:166

+

Defined in src/common/catalog/catalog-entity.ts:166

Returns: string


onContextMenuOpen#

onContextMenuOpen(context: CatalogEntityContextMenuContext): Promise‹void›

Overrides CatalogEntity.onContextMenuOpen

-

Defined in src/common/catalog-entities/kubernetes-cluster.ts:103

+

Defined in src/common/catalog-entities/kubernetes-cluster.ts:103

Parameters:

@@ -1150,13 +1150,13 @@

onDetailsOpen#

onDetailsOpen(): void

Overrides CatalogEntity.onDetailsOpen

-

Defined in src/common/catalog-entities/kubernetes-cluster.ts:95

+

Defined in src/common/catalog-entities/kubernetes-cluster.ts:95

Returns: void


onRun#

onRun(context: CatalogEntityActionContext): Promise‹void›

Overrides CatalogEntity.onRun

-

Defined in src/common/catalog-entities/kubernetes-cluster.ts:91

+

Defined in src/common/catalog-entities/kubernetes-cluster.ts:91

Parameters:

@@ -1177,7 +1177,7 @@

onSettingsOpen#

onSettingsOpen(): void

Overrides CatalogEntity.onSettingsOpen

-

Defined in src/common/catalog-entities/kubernetes-cluster.ts:99

+

Defined in src/common/catalog-entities/kubernetes-cluster.ts:99

Returns: void

diff --git a/master/extensions/api/classes/_core_api_catalog_.kubernetesclustercategory/index.html b/master/extensions/api/classes/_core_api_catalog_.kubernetesclustercategory/index.html index d2514a312d..d45e40e5f5 100644 --- a/master/extensions/api/classes/_core_api_catalog_.kubernetesclustercategory/index.html +++ b/master/extensions/api/classes/_core_api_catalog_.kubernetesclustercategory/index.html @@ -1190,18 +1190,18 @@

Constructors#

constructor#

+ new KubernetesClusterCategory(): KubernetesClusterCategory

-

Defined in src/common/catalog-entities/kubernetes-cluster.ts:164

+

Defined in src/common/catalog-entities/kubernetes-cluster.ts:164

Returns: KubernetesClusterCategory

Properties#

apiVersion#

apiVersion: "catalog.k8slens.dev/v1alpha1" = "catalog.k8slens.dev/v1alpha1"

Overrides CatalogCategory.apiVersion

-

Defined in src/common/catalog-entities/kubernetes-cluster.ts:147

+

Defined in src/common/catalog-entities/kubernetes-cluster.ts:147


kind#

kind: "CatalogCategory" = "CatalogCategory"

Overrides CatalogCategory.kind

-

Defined in src/common/catalog-entities/kubernetes-cluster.ts:148

+

Defined in src/common/catalog-entities/kubernetes-cluster.ts:148


Static defaultMaxListeners#

defaultMaxListeners: number

@@ -1270,7 +1270,7 @@

getId#

getId(): string

Inherited from KubernetesClusterCategory.getId

-

Defined in src/common/catalog/catalog-entity.ts:65

+

Defined in src/common/catalog/catalog-entity.ts:65

Returns: string


getMaxListeners#

@@ -1575,7 +1575,7 @@

Static parseId#

parseId(id: string): object

Inherited from KubernetesClusterCategory.parseId

-

Defined in src/common/catalog/catalog-entity.ts:59

+

Defined in src/common/catalog/catalog-entity.ts:59

Parameters:

@@ -1606,21 +1606,21 @@

metadata#

metadata: object#

Overrides CatalogCategory.metadata

-

Defined in src/common/catalog-entities/kubernetes-cluster.ts:149

+

Defined in src/common/catalog-entities/kubernetes-cluster.ts:149

icon#

icon: any = require(!!raw-loader!./icons/kubernetes.svg).default

-

Defined in src/common/catalog-entities/kubernetes-cluster.ts:151

+

Defined in src/common/catalog-entities/kubernetes-cluster.ts:151

name#

name: string = "Kubernetes Clusters"

-

Defined in src/common/catalog-entities/kubernetes-cluster.ts:150

+

Defined in src/common/catalog-entities/kubernetes-cluster.ts:150


spec#

spec: object#

Overrides CatalogCategory.spec

-

Defined in src/common/catalog-entities/kubernetes-cluster.ts:153

+

Defined in src/common/catalog-entities/kubernetes-cluster.ts:153

group#

group: string = "entity.k8slens.dev"

-

Defined in src/common/catalog-entities/kubernetes-cluster.ts:154

+

Defined in src/common/catalog-entities/kubernetes-cluster.ts:154

versions#

versions: object[] = [ { @@ -1628,9 +1628,9 @@ entityClass: KubernetesCluster } ]

-

Defined in src/common/catalog-entities/kubernetes-cluster.ts:155

+

Defined in src/common/catalog-entities/kubernetes-cluster.ts:155

names: object

-

Defined in src/common/catalog-entities/kubernetes-cluster.ts:161

+

Defined in src/common/catalog-entities/kubernetes-cluster.ts:161

diff --git a/master/extensions/api/classes/_core_api_catalog_.weblink/index.html b/master/extensions/api/classes/_core_api_catalog_.weblink/index.html index febad97351..a877900e1c 100644 --- a/master/extensions/api/classes/_core_api_catalog_.weblink/index.html +++ b/master/extensions/api/classes/_core_api_catalog_.weblink/index.html @@ -1043,7 +1043,7 @@

constructor#

+ new WebLink(data: CatalogEntityDataCatalogEntityMetadata, WebLinkStatus, WebLinkSpec›): WebLink

Inherited from KubernetesCluster.constructor

-

Defined in src/common/catalog/catalog-entity.ts:153

+

Defined in src/common/catalog/catalog-entity.ts:153

Parameters:

@@ -1065,63 +1065,63 @@

apiVersion: "entity.k8slens.dev/v1alpha1" = "entity.k8slens.dev/v1alpha1"

Implementation of CatalogEntityKindData.apiVersion

Overrides CatalogEntity.apiVersion

-

Defined in src/common/catalog-entities/web-link.ts:34

+

Defined in src/common/catalog-entities/web-link.ts:34


kind#

kind: "WebLink" = "WebLink"

Implementation of CatalogEntityKindData.kind

Overrides CatalogEntity.kind

-

Defined in src/common/catalog-entities/web-link.ts:35

+

Defined in src/common/catalog-entities/web-link.ts:35


metadata#

metadata: CatalogEntityMetadata

Inherited from KubernetesCluster.metadata

-

Defined in src/common/catalog/catalog-entity.ts:151

+

Defined in src/common/catalog/catalog-entity.ts:151


spec#

spec: WebLinkSpec

Inherited from KubernetesCluster.spec

-

Defined in src/common/catalog/catalog-entity.ts:153

+

Defined in src/common/catalog/catalog-entity.ts:153


status#

status: WebLinkStatus

Inherited from KubernetesCluster.status

-

Defined in src/common/catalog/catalog-entity.ts:152

+

Defined in src/common/catalog/catalog-entity.ts:152

Methods#

getId#

getId(): string

Inherited from KubernetesCluster.getId

-

Defined in src/common/catalog/catalog-entity.ts:162

+

Defined in src/common/catalog/catalog-entity.ts:162

Returns: string


getName#

getName(): string

Inherited from KubernetesCluster.getName

-

Defined in src/common/catalog/catalog-entity.ts:166

+

Defined in src/common/catalog/catalog-entity.ts:166

Returns: string


onContextMenuOpen#

onContextMenuOpen(): void

Overrides CatalogEntity.onContextMenuOpen

-

Defined in src/common/catalog-entities/web-link.ts:49

+

Defined in src/common/catalog-entities/web-link.ts:49

Returns: void


onDetailsOpen#

onDetailsOpen(): void

Overrides CatalogEntity.onDetailsOpen

-

Defined in src/common/catalog-entities/web-link.ts:45

+

Defined in src/common/catalog-entities/web-link.ts:45

Returns: void


onRun#

onRun(): Promise‹void›

Overrides CatalogEntity.onRun

-

Defined in src/common/catalog-entities/web-link.ts:37

+

Defined in src/common/catalog-entities/web-link.ts:37

Returns: Promise‹void›


onSettingsOpen#

onSettingsOpen(): void

Overrides CatalogEntity.onSettingsOpen

-

Defined in src/common/catalog-entities/web-link.ts:41

+

Defined in src/common/catalog-entities/web-link.ts:41

Returns: void

diff --git a/master/extensions/api/classes/_core_api_catalog_.weblinkcategory/index.html b/master/extensions/api/classes/_core_api_catalog_.weblinkcategory/index.html index c5963fbbf6..0d14efa4bd 100644 --- a/master/extensions/api/classes/_core_api_catalog_.weblinkcategory/index.html +++ b/master/extensions/api/classes/_core_api_catalog_.weblinkcategory/index.html @@ -1160,12 +1160,12 @@

apiVersion#

apiVersion: "catalog.k8slens.dev/v1alpha1" = "catalog.k8slens.dev/v1alpha1"

Overrides CatalogCategory.apiVersion

-

Defined in src/common/catalog-entities/web-link.ts:55

+

Defined in src/common/catalog-entities/web-link.ts:55


kind#

kind: "CatalogCategory" = "CatalogCategory"

Overrides CatalogCategory.kind

-

Defined in src/common/catalog-entities/web-link.ts:56

+

Defined in src/common/catalog-entities/web-link.ts:56


Static defaultMaxListeners#

defaultMaxListeners: number

@@ -1234,7 +1234,7 @@

getId#

getId(): string

Inherited from KubernetesClusterCategory.getId

-

Defined in src/common/catalog/catalog-entity.ts:65

+

Defined in src/common/catalog/catalog-entity.ts:65

Returns: string


getMaxListeners#

@@ -1539,7 +1539,7 @@

Static parseId#

parseId(id: string): object

Inherited from KubernetesClusterCategory.parseId

-

Defined in src/common/catalog/catalog-entity.ts:59

+

Defined in src/common/catalog/catalog-entity.ts:59

Parameters:

@@ -1570,21 +1570,21 @@

metadata#

metadata: object#

Overrides CatalogCategory.metadata

-

Defined in src/common/catalog-entities/web-link.ts:57

+

Defined in src/common/catalog-entities/web-link.ts:57

icon#

icon: string = "link"

-

Defined in src/common/catalog-entities/web-link.ts:59

+

Defined in src/common/catalog-entities/web-link.ts:59

name#

name: string = "Web Links"

-

Defined in src/common/catalog-entities/web-link.ts:58

+

Defined in src/common/catalog-entities/web-link.ts:58


spec#

spec: object#

Overrides CatalogCategory.spec

-

Defined in src/common/catalog-entities/web-link.ts:61

+

Defined in src/common/catalog-entities/web-link.ts:61

group#

group: string = "entity.k8slens.dev"

-

Defined in src/common/catalog-entities/web-link.ts:62

+

Defined in src/common/catalog-entities/web-link.ts:62

versions#

versions: object[] = [ { @@ -1592,9 +1592,9 @@ entityClass: WebLink } ]

-

Defined in src/common/catalog-entities/web-link.ts:63

+

Defined in src/common/catalog-entities/web-link.ts:63

names: object

-

Defined in src/common/catalog-entities/web-link.ts:69

+

Defined in src/common/catalog-entities/web-link.ts:69

diff --git a/master/extensions/api/classes/_core_api_stores_.mainipcstore/index.html b/master/extensions/api/classes/_core_api_ipc_.ipcmain/index.html similarity index 91% rename from master/extensions/api/classes/_core_api_stores_.mainipcstore/index.html rename to master/extensions/api/classes/_core_api_ipc_.ipcmain/index.html index 501a73a4e0..02001ba7a6 100644 --- a/master/extensions/api/classes/_core_api_stores_.mainipcstore/index.html +++ b/master/extensions/api/classes/_core_api_ipc_.ipcmain/index.html @@ -9,7 +9,7 @@ - + @@ -19,7 +19,7 @@ - Class: MainIpcStore - Lens Documentation + Class: IpcMain - Lens Documentation @@ -72,7 +72,7 @@
- + Skip to content @@ -103,7 +103,7 @@
- Class: MainIpcStore + Class: IpcMain
@@ -919,22 +919,22 @@
@@ -1024,49 +1022,55 @@
-

Returns: MainIpcStore

+

Returns: IpcMain

Properties#

[IpcPrefix]#

[IpcPrefix]: string

-

Inherited from MainIpcStore.[IpcPrefix]

-

Defined in src/extensions/ipc-store.ts:29

+

Inherited from IpcMain.[IpcPrefix]

+

Defined in src/extensions/ipc/ipc-registrar.ts:29


Protected extension#

extension: LensExtension

-

Inherited from MainIpcStore.extension

-

Defined in src/extensions/ipc-store.ts:31

+

Inherited from IpcMain.extension

+

Defined in src/extensions/ipc/ipc-registrar.ts:31

Methods#

-

broadcastIpc#

-

broadcastIpc(channel: string, ...args: any[]): void

-

Inherited from MainIpcStore.broadcastIpc

-

Defined in src/extensions/ipc-store.ts:36

+

broadcast#

+

broadcast(channel: string, ...args: any[]): void

+

Inherited from IpcMain.broadcast

+

Defined in src/extensions/ipc/ipc-registrar.ts:41

Parameters:

+ + +
Name TypeDescription
channel stringThe channel to broadcast to your whole extension, both main and renderer
...args any[]The arguments passed to all listeners

Returns: void


-

handleIpc#

-

handleIpc(channel: string, handler: function): void

-

Defined in src/extensions/main-ipc-store.ts:32

+

handle#

+

handle(channel: string, handler: function): void

+

Defined in src/extensions/ipc/ipc-main.ts:55

+

Declare a RPC over channel. Lens will cleanup when the extension is disabled or uninstalled

Parameters:

channel: string

+

The name of the RPC

handler: function

+

The remote procedure that is called

▸ (event: IpcMainInvokeEvent, ...args: any[]): any

Parameters:

@@ -1089,13 +1093,16 @@

Returns: void


-

listenIpc#

-

listenIpc(channel: string, listener: function): void

-

Defined in src/extensions/main-ipc-store.ts:39

+

listen#

+

listen(channel: string, listener: function): Disposer

+

Defined in src/extensions/ipc/ipc-main.ts:40

+

Listen for broadcasts within your extension

Parameters:

channel: string

+

The channel to listen for broadcasts on

listener: function

-

▸ (event: IpcMainEvent, ...args: any[]): any

+

The function that will be called with the arguments of the broadcast

+

▸ (event: IpcRendererEvent, ...args: any[]): any

Parameters:

@@ -1107,7 +1114,7 @@ - + @@ -1115,12 +1122,13 @@
eventIpcMainEventIpcRendererEvent
...args
-

Returns: void

+

Returns: Disposer

+

An optional disopser, Lens will cleanup when the extension is disabled or uninstalled even if this is not called


Static createInstance#

createInstanceT, R›(this: StaticThis‹T, R›, ...args: R): T

Inherited from ExtensionStore.createInstance

-

Defined in src/common/utils/singleton.ts:46

+

Defined in src/common/utils/singleton.ts:46

Creates the single instance of the child class if one was not already created.

Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls.

@@ -1157,7 +1165,7 @@ only the first's arguments will be used.

Static getInstance#

getInstanceT, R›(this: StaticThis‹T, R›, strict: boolean): T | undefined

Inherited from ExtensionStore.getInstance

-

Defined in src/common/utils/singleton.ts:67

+

Defined in src/common/utils/singleton.ts:67

Get the instance of the child class that was previously created.

Type parameters:

T

@@ -1193,7 +1201,7 @@ only the first's arguments will be used.

Static resetInstance#

resetInstance(): void

Inherited from ExtensionStore.resetInstance

-

Defined in src/common/utils/singleton.ts:82

+

Defined in src/common/utils/singleton.ts:82

Delete the instance of the child class.

Note: this doesn't prevent callers of getInstance from storing the result in a global.

There is no way in JS or TS to prevent globals like that.

diff --git a/master/extensions/api/classes/_core_api_stores_.rendereripcstore/index.html b/master/extensions/api/classes/_core_api_ipc_.ipcregistrar/index.html similarity index 89% rename from master/extensions/api/classes/_core_api_stores_.rendereripcstore/index.html rename to master/extensions/api/classes/_core_api_ipc_.ipcregistrar/index.html index a4388ffd4d..c7dc225ab6 100644 --- a/master/extensions/api/classes/_core_api_stores_.rendereripcstore/index.html +++ b/master/extensions/api/classes/_core_api_ipc_.ipcregistrar/index.html @@ -9,7 +9,7 @@ - + @@ -19,7 +19,7 @@ - Class: RendererIpcStore - Lens Documentation + Class: IpcRegistrar - Lens Documentation @@ -72,7 +72,7 @@
- + Skip to content @@ -103,7 +103,7 @@
- Class: RendererIpcStore + Class: IpcRegistrar
@@ -919,22 +919,8 @@