From a9951676bbe37b5b471369558a8d342c33da8a53 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Mon, 7 Jun 2021 13:59:17 +0000 Subject: [PATCH] Deployed ba1e5973be to master with MkDocs 1.1.2 and mike 1.0.1 --- .../index.html | 1393 ----- .../index.html | 1158 ---- .../index.html | 1200 ---- .../index.html | 1603 ----- .../index.html | 1393 ----- .../index.html | 1516 ----- .../index.html | 1393 ----- .../index.html | 1404 ----- .../index.html | 1393 ----- .../index.html | 1303 ---- .../index.html | 1435 ----- .../index.html | 1241 ---- .../index.html | 1483 ----- .../index.html | 1454 ----- .../index.html | 1434 ----- .../index.html | 1391 ---- .../index.html | 1590 ----- .../index.html | 1405 ----- .../index.html | 1453 ----- .../index.html | 1393 ----- .../index.html | 1391 ---- .../index.html | 1391 ---- .../index.html | 1610 ----- .../index.html | 1445 ----- .../index.html | 1393 ----- .../index.html | 1222 ---- .../index.html | 1604 ----- .../index.html | 1393 ----- .../index.html | 1493 ----- .../index.html | 1535 ----- .../index.html | 1575 ----- .../index.html | 2166 ------- .../index.html | 2189 ------- .../index.html | 2218 ------- .../index.html | 2201 ------- .../index.html | 2244 ------- .../index.html | 2224 ------- .../index.html | 2166 ------- .../index.html | 2194 ------- .../index.html | 2166 ------- .../index.html | 2205 ------- .../index.html | 1763 ------ .../index.html | 2235 ------- .../index.html | 2166 ------- .../index.html | 2379 ------- .../index.html | 2166 ------- .../index.html | 2325 ------- .../index.html | 2193 ------- .../index.html | 2166 ------- .../index.html | 2393 ------- .../index.html | 2272 ------- .../index.html | 2166 ------- .../index.html | 2170 ------- .../index.html | 2133 ------- .../index.html | 2166 ------- .../index.html | 1559 ----- .../index.html | 2163 ------- .../index.html | 2166 ------- .../index.html | 2244 ------- .../index.html | 2193 ------- .../index.html | 2205 ------- .../index.html | 1137 ++-- .../index.html | 208 +- .../index.html | 156 +- .../index.html | 1167 ++-- .../index.html | 124 +- .../index.html | 774 ++- .../index.html | 603 +- .../index.html | 160 +- .../index.html | 93 +- .../index.html | 275 +- .../index.html | 272 +- .../index.html | 154 +- .../renderer.component.badge/index.html | 1434 +++++ .../index.html | 546 +- .../renderer.component.button/index.html | 1434 +++++ .../renderer.component.checkbox/index.html | 1475 +++++ .../index.html | 90 +- .../index.html | 1563 +++++ .../renderer.component.cubespinner/index.html | 1434 +++++ .../renderer.component.dialog/index.html | 1628 +++++ .../index.html | 596 +- .../renderer.component.draweritem/index.html | 1434 +++++ .../index.html | 1447 +++++ .../renderer.component.drawertitle/index.html | 1434 +++++ .../renderer.component.icon/index.html | 1537 +++++ .../index.html | 798 ++- .../index.html | 1433 +++++ .../index.html | 564 +- .../index.html | 1456 +++++ .../index.html | 632 +- .../index.html | 1473 +++++ .../index.html | 1445 +++++ .../index.html | 732 ++- .../renderer.component.menuactions/index.html | 1482 +++++ .../index.html | 578 +- .../index.html | 541 +- .../index.html | 1490 +++++ .../index.html | 679 +- .../index.html | 124 +- .../index.html | 562 +- .../index.html | 535 +- .../index.html | 638 +- .../renderer.component.radio/index.html | 1475 +++++ .../renderer.component.radiogroup/index.html | 1434 +++++ .../index.html | 568 +- .../index.html | 700 ++- .../renderer.component.slider/index.html | 1445 +++++ .../renderer.component.spinner/index.html | 1464 +++++ .../renderer.component.statusbrick/index.html | 1434 +++++ .../renderer.component.stepper/index.html | 1434 +++++ .../index.html | 535 +- .../classes/renderer.component.tab/index.html | 1594 +++++ .../renderer.component.table/index.html | 1566 +++++ .../index.html | 611 +- .../renderer.component.tablehead/index.html | 1445 +++++ .../renderer.component.tablerow/index.html | 1434 +++++ .../renderer.component.tabs/index.html | 1473 +++++ .../index.html | 693 +- .../renderer.component.wizard/index.html | 1607 +++++ .../index.html | 1434 +++++ .../index.html | 595 +- .../index.html | 272 +- .../renderer.k8sapi.clusterrole/index.html | 1562 +++++ .../index.html | 695 +- .../index.html | 636 +- .../index.html | 2232 +++++++ .../index.html | 2284 +++++++ .../renderer.k8sapi.crdstore/index.html | 2293 +++++++ .../index.html | 821 +-- .../renderer.k8sapi.cronjobstore/index.html | 2278 +++++++ .../index.html | 931 +-- .../renderer.k8sapi.daemonset/index.html | 1785 ++++++ .../renderer.k8sapi.daemonsetstore/index.html | 2321 +++++++ .../index.html | 970 +-- .../index.html | 702 ++- .../index.html | 2309 +++++++ .../index.html | 636 +- .../renderer.k8sapi.endpointstore/index.html | 2232 +++++++ .../renderer.k8sapi.eventstore/index.html | 2268 +++++++ .../index.html | 786 +-- .../renderer.k8sapi.hpastore/index.html | 2232 +++++++ .../index.html | 731 ++- .../index.html | 609 +- .../renderer.k8sapi.ingressstore/index.html | 2271 +++++++ .../index.html | 1006 +-- .../renderer.k8sapi.jobstore/index.html | 2314 +++++++ .../index.html | 547 +- .../index.html | 769 +-- .../index.html | 588 +- .../index.html | 1154 ++-- .../index.html | 650 +- .../index.html | 2232 +++++++ .../index.html | 646 +- .../renderer.k8sapi.namespacestore/index.html | 2456 ++++++++ .../index.html | 681 +- .../index.html | 2232 +++++++ .../index.html | 972 +-- .../index.html | 595 +- .../renderer.k8sapi.nodesstore/index.html | 2388 +++++++ .../index.html | 862 +-- .../index.html | 741 ++- .../index.html | 609 +- .../index.html | 2260 +++++++ .../index.html | 1153 ++-- .../index.html | 719 ++- .../index.html | 2232 +++++++ .../index.html | 651 +- .../renderer.k8sapi.podsstore/index.html | 2468 ++++++++ .../index.html | 930 +-- .../index.html | 2349 +++++++ .../index.html | 674 +- .../index.html | 2232 +++++++ .../index.html | 234 +- .../index.html | 632 +- .../renderer.k8sapi.rolebinding/index.html | 1604 +++++ .../index.html | 2260 +++++++ .../renderer.k8sapi.rolesstore/index.html | 2220 +++++++ .../index.html | 665 +- .../renderer.k8sapi.secretsstore/index.html | 2232 +++++++ .../index.html | 856 +-- .../renderer.k8sapi.serviceaccount/index.html | 1580 +++++ .../index.html | 2228 +++++++ .../renderer.k8sapi.servicestore/index.html | 2232 +++++++ .../index.html | 850 +-- .../index.html | 2321 +++++++ .../index.html | 672 +- .../index.html | 2260 +++++++ .../index.html | 2271 +++++++ .../index.html | 283 +- .../index.html | 230 +- .../index.html | 20 +- .../index.html | 35 +- .../index.html | 20 +- master/extensions/api/index.html | 70 +- .../index.html | 796 --- .../index.html | 4190 ------------- .../index.html | 4441 ------------- .../index.html | 848 --- .../index.html | 4173 ------------ .../index.html | 4158 ------------ .../index.html | 4310 ------------- .../index.html | 1277 ---- .../index.html | 906 --- .../index.html | 5558 ---------------- .../index.html | 856 --- .../index.html | 5549 ---------------- .../index.html | 780 --- .../index.html | 2944 --------- .../index.html | 2030 ------ .../index.html | 5537 ---------------- .../index.html | 4154 ------------ .../index.html | 5525 ---------------- .../index.html | 3014 --------- .../index.html | 2891 --------- .../index.html | 3120 --------- .../index.html | 2927 --------- .../index.html | 2936 --------- .../index.html | 792 --- .../index.html | 2927 --------- .../index.html | 894 --- .../index.html | 909 --- .../index.html | 778 --- .../index.html | 73 +- .../index.html | 50 +- .../index.html | 51 +- .../index.html | 60 +- .../index.html | 85 +- .../index.html | 44 +- .../index.html | 77 +- .../index.html | 44 +- .../index.html | 64 +- .../index.html | 32 +- .../index.html | 57 +- .../index.html | 25 +- .../index.html | 58 +- .../index.html | 51 +- .../index.html | 61 +- .../index.html | 61 +- .../index.html | 43 +- .../index.html | 65 +- .../index.html | 795 +++ .../index.html | 25 +- .../index.html | 42 +- .../index.html | 25 +- .../index.html | 31 +- .../index.html | 47 +- .../index.html | 755 +++ .../index.html | 25 +- .../index.html | 25 +- .../index.html | 30 +- .../index.html | 41 +- .../index.html | 47 +- .../common.types.pagetarget/index.html | 755 +++ .../index.html | 28 +- .../index.html | 52 +- .../index.html | 47 +- .../index.html | 37 +- .../index.html | 38 +- .../renderer.component.badgeprops/index.html | 4199 +++++++++++++ .../renderer.component.buttonprops/index.html | 4441 +++++++++++++ .../index.html | 141 +- .../index.html | 88 +- .../index.html | 123 +- .../index.html | 197 +- .../index.html | 744 +++ .../index.html | 146 +- .../index.html | 4183 +++++++++++++ .../index.html | 4167 ++++++++++++ .../index.html | 25 +- .../index.html | 136 +- .../index.html | 744 +++ .../index.html | 51 +- .../renderer.component.iconprops/index.html | 4309 +++++++++++++ .../index.html | 88 +- .../index.html | 25 +- .../index.html | 68 +- .../index.html | 606 +- .../index.html | 1093 ++++ .../index.html | 36 +- .../index.html | 5568 +++++++++++++++++ .../index.html | 278 +- .../index.html | 5557 ++++++++++++++++ .../index.html | 74 +- .../index.html | 217 +- .../index.html | 108 +- .../index.html | 2951 +++++++++ .../index.html | 90 +- .../index.html | 59 +- .../renderer.component.selectprops/index.html | 2103 +++++++ .../renderer.component.sliderprops/index.html | 4528 ++++++++++++++ .../index.html | 5546 ++++++++++++++++ .../index.html | 4166 ++++++++++++ .../index.html | 5535 ++++++++++++++++ .../index.html | 74 +- .../index.html | 96 +- .../index.html | 3016 +++++++++ .../index.html | 2899 +++++++++ .../renderer.component.tableprops/index.html | 3120 +++++++++ .../index.html | 2932 +++++++++ .../renderer.component.tabprops/index.html | 2954 +++++++++ .../renderer.component.tabsprops/index.html | 3005 +++++++++ .../index.html | 777 +++ .../index.html | 43 +- .../index.html | 832 +++ .../index.html | 2932 +++++++++ .../index.html | 192 +- .../index.html | 1151 ++++ .../index.html | 44 +- .../index.html | 248 +- .../index.html | 259 +- .../index.html | 36 +- .../index.html | 82 +- .../index.html | 118 +- .../index.html | 853 --- .../index.html | 1392 ----- .../modules/_renderer_api_index_/index.html | 725 --- .../api/modules/common.app/index.html | 846 +++ .../index.html | 235 +- .../index.html | 83 +- .../index.html | 21 +- .../index.html | 68 +- .../index.html | 123 +- .../common}/index.html | 38 +- .../api/{globals => modules}/index.html | 22 +- .../index.html | 78 +- .../index.html | 35 +- .../{_main_api_index_ => main}/index.html | 32 +- .../index.html | 43 +- .../index.html | 966 ++- .../api/modules/renderer.k8sapi/index.html | 1323 ++++ .../index.html | 266 +- .../index.html | 25 +- .../index.html | 47 +- master/extensions/typedoc-readme.md.tpl | 6 +- master/search/search_index.json | 2 +- master/sitemap.xml.gz | Bin 389 -> 389 bytes 337 files changed, 228090 insertions(+), 214707 deletions(-) delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.badge/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.button/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.checkbox/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.confirmdialog/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.cubespinner/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.dialog/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.draweritem/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.drawerparamtoggler/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.drawertitle/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.icon/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.kubeobjectmeta/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.lineprogress/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.menuactions/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.namespaceselectfilter/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.radio/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.radiogroup/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.select/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.slider/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.spinner/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.statusbrick/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.stepper/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.tab/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.table/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.tablehead/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.tablerow/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.tabs/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.wizard/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.wizardlayout/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.wizardstep/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.clusterrole/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.clusterrolebinding/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.configmapsstore/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.crdresourcestore/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.crdstore/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.cronjobstore/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.daemonsetstore/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.deploymentstore/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.endpointstore/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.eventstore/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.hpastore/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.ingressstore/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.job/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.jobstore/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.limitrangesstore/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.namespacestore/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.networkpolicystore/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.nodesstore/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.persistentvolumesstore/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.podsstore/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.replicasetstore/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.resourcequotasstore/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.rolebindingsstore/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.rolesstore/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.secretsstore/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.serviceaccount/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.serviceaccountsstore/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.servicestore/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.statefulsetstore/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.storageclassstore/index.html delete mode 100644 master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.volumeclaimstore/index.html rename master/extensions/api/classes/{_common_api_index_._common_api_catalog_.kubernetesclustercategory => common.catalog.catalogcategory}/index.html (62%) rename master/extensions/api/classes/{_common_api_index_._common_api_catalog_.catalogentity => common.catalog.catalogentity}/index.html (78%) rename master/extensions/api/classes/{_common_api_index_._common_api_catalog_.kubernetescluster => common.catalog.kubernetescluster}/index.html (76%) rename master/extensions/api/classes/{_common_api_index_._common_api_catalog_.weblinkcategory => common.catalog.kubernetesclustercategory}/index.html (59%) rename master/extensions/api/classes/{_common_api_index_._common_api_catalog_.weblink => common.catalog.weblink}/index.html (78%) rename master/extensions/api/classes/{_common_api_index_._common_api_catalog_.catalogcategory => common.catalog.weblinkcategory}/index.html (56%) rename master/extensions/api/classes/{_common_api_index_._common_api_stores_.extensionstore => common.store.extensionstore}/index.html (63%) rename master/extensions/api/classes/{_common_api_index_._common_api_utils_.singleton => common.util.singleton}/index.html (85%) rename master/extensions/api/classes/{_main_api_index_._main_api_catalog_.catalogentityregistry => main.catalog.catalogentityregistry}/index.html (91%) rename master/extensions/api/classes/{_main_api_index_.ipcmain => main.ipc}/index.html (78%) rename master/extensions/api/classes/{_main_api_index_.lensmainextension => main.lensextension}/index.html (74%) rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_catalog_.catalogentityregistry => renderer.catalog.catalogentityregistry}/index.html (81%) create mode 100644 master/extensions/api/classes/renderer.component.badge/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_components_.barchart => renderer.component.barchart}/index.html (67%) create mode 100644 master/extensions/api/classes/renderer.component.button/index.html create mode 100644 master/extensions/api/classes/renderer.component.checkbox/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_components_.commandoverlay => renderer.component.commandoverlay}/index.html (91%) create mode 100644 master/extensions/api/classes/renderer.component.confirmdialog/index.html create mode 100644 master/extensions/api/classes/renderer.component.cubespinner/index.html create mode 100644 master/extensions/api/classes/renderer.component.dialog/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_components_.drawer => renderer.component.drawer}/index.html (64%) create mode 100644 master/extensions/api/classes/renderer.component.draweritem/index.html create mode 100644 master/extensions/api/classes/renderer.component.drawerparamtoggler/index.html create mode 100644 master/extensions/api/classes/renderer.component.drawertitle/index.html create mode 100644 master/extensions/api/classes/renderer.component.icon/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_components_.input => renderer.component.input}/index.html (61%) create mode 100644 master/extensions/api/classes/renderer.component.kubeeventdetails/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_components_.kubeobjectdetails => renderer.component.kubeobjectdetails}/index.html (67%) create mode 100644 master/extensions/api/classes/renderer.component.kubeobjectlistlayout/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_components_.kubeobjectmenu => renderer.component.kubeobjectmenu}/index.html (64%) create mode 100644 master/extensions/api/classes/renderer.component.kubeobjectmeta/index.html create mode 100644 master/extensions/api/classes/renderer.component.lineprogress/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_components_.menu => renderer.component.menu}/index.html (61%) create mode 100644 master/extensions/api/classes/renderer.component.menuactions/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_components_.menuitem => renderer.component.menuitem}/index.html (63%) rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_components_.namespaceselect => renderer.component.namespaceselect}/index.html (67%) create mode 100644 master/extensions/api/classes/renderer.component.namespaceselectfilter/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_components_.notifications => renderer.component.notifications}/index.html (62%) rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_components_.notificationsstore => renderer.component.notificationsstore}/index.html (83%) rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_components_.pagelayout => renderer.component.pagelayout}/index.html (67%) rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_components_.piechart => renderer.component.piechart}/index.html (68%) rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_components_.poddetailslist => renderer.component.poddetailslist}/index.html (65%) create mode 100644 master/extensions/api/classes/renderer.component.radio/index.html create mode 100644 master/extensions/api/classes/renderer.component.radiogroup/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_components_.searchinput => renderer.component.searchinput}/index.html (67%) rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_components_.tablecell => renderer.component.select}/index.html (63%) create mode 100644 master/extensions/api/classes/renderer.component.slider/index.html create mode 100644 master/extensions/api/classes/renderer.component.spinner/index.html create mode 100644 master/extensions/api/classes/renderer.component.statusbrick/index.html create mode 100644 master/extensions/api/classes/renderer.component.stepper/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_components_.subtitle => renderer.component.subtitle}/index.html (68%) create mode 100644 master/extensions/api/classes/renderer.component.tab/index.html create mode 100644 master/extensions/api/classes/renderer.component.table/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_components_.kubeobjectlistlayout => renderer.component.tablecell}/index.html (65%) create mode 100644 master/extensions/api/classes/renderer.component.tablehead/index.html create mode 100644 master/extensions/api/classes/renderer.component.tablerow/index.html create mode 100644 master/extensions/api/classes/renderer.component.tabs/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_components_.tooltip => renderer.component.tooltip}/index.html (62%) create mode 100644 master/extensions/api/classes/renderer.component.wizard/index.html create mode 100644 master/extensions/api/classes/renderer.component.wizardlayout/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_components_.kubeeventdetails => renderer.component.wizardstep}/index.html (64%) rename master/extensions/api/classes/{_renderer_api_index_.ipcrenderer => renderer.ipc}/index.html (78%) create mode 100644 master/extensions/api/classes/renderer.k8sapi.clusterrole/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.rolebinding => renderer.k8sapi.clusterrolebinding}/index.html (56%) rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.configmap => renderer.k8sapi.configmap}/index.html (57%) create mode 100644 master/extensions/api/classes/renderer.k8sapi.configmapsstore/index.html create mode 100644 master/extensions/api/classes/renderer.k8sapi.crdresourcestore/index.html create mode 100644 master/extensions/api/classes/renderer.k8sapi.crdstore/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.cronjob => renderer.k8sapi.cronjob}/index.html (56%) create mode 100644 master/extensions/api/classes/renderer.k8sapi.cronjobstore/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.customresourcedefinition => renderer.k8sapi.customresourcedefinition}/index.html (56%) create mode 100644 master/extensions/api/classes/renderer.k8sapi.daemonset/index.html create mode 100644 master/extensions/api/classes/renderer.k8sapi.daemonsetstore/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.deployment => renderer.k8sapi.deployment}/index.html (55%) rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.deploymentapi => renderer.k8sapi.deploymentapi}/index.html (58%) create mode 100644 master/extensions/api/classes/renderer.k8sapi.deploymentstore/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.endpoint => renderer.k8sapi.endpoint}/index.html (57%) create mode 100644 master/extensions/api/classes/renderer.k8sapi.endpointstore/index.html create mode 100644 master/extensions/api/classes/renderer.k8sapi.eventstore/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.horizontalpodautoscaler => renderer.k8sapi.horizontalpodautoscaler}/index.html (57%) create mode 100644 master/extensions/api/classes/renderer.k8sapi.hpastore/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.ingress => renderer.k8sapi.ingress}/index.html (57%) rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.ingressapi => renderer.k8sapi.ingressapi}/index.html (59%) create mode 100644 master/extensions/api/classes/renderer.k8sapi.ingressstore/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.daemonset => renderer.k8sapi.job}/index.html (55%) create mode 100644 master/extensions/api/classes/renderer.k8sapi.jobstore/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.kubeapi => renderer.k8sapi.kubeapi}/index.html (68%) rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.kubeevent => renderer.k8sapi.kubeevent}/index.html (57%) rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.kubeobject => renderer.k8sapi.kubeobject}/index.html (65%) rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.kubeobjectstore => renderer.k8sapi.kubeobjectstore}/index.html (54%) rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.limitrange => renderer.k8sapi.limitrange}/index.html (57%) create mode 100644 master/extensions/api/classes/renderer.k8sapi.limitrangesstore/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.namespace => renderer.k8sapi.namespace}/index.html (57%) create mode 100644 master/extensions/api/classes/renderer.k8sapi.namespacestore/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.networkpolicy => renderer.k8sapi.networkpolicy}/index.html (57%) create mode 100644 master/extensions/api/classes/renderer.k8sapi.networkpolicystore/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.node => renderer.k8sapi.node}/index.html (54%) rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.nodesapi => renderer.k8sapi.nodesapi}/index.html (60%) create mode 100644 master/extensions/api/classes/renderer.k8sapi.nodesstore/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.persistentvolume => renderer.k8sapi.persistentvolume}/index.html (56%) rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.persistentvolumeclaim => renderer.k8sapi.persistentvolumeclaim}/index.html (56%) rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.persistentvolumeclaimsapi => renderer.k8sapi.persistentvolumeclaimsapi}/index.html (59%) create mode 100644 master/extensions/api/classes/renderer.k8sapi.persistentvolumesstore/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.pod => renderer.k8sapi.pod}/index.html (53%) rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.poddisruptionbudget => renderer.k8sapi.poddisruptionbudget}/index.html (57%) create mode 100644 master/extensions/api/classes/renderer.k8sapi.poddisruptionbudgetsstore/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.podsapi => renderer.k8sapi.podsapi}/index.html (59%) create mode 100644 master/extensions/api/classes/renderer.k8sapi.podsstore/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.replicaset => renderer.k8sapi.replicaset}/index.html (56%) create mode 100644 master/extensions/api/classes/renderer.k8sapi.replicasetstore/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.resourcequota => renderer.k8sapi.resourcequota}/index.html (58%) create mode 100644 master/extensions/api/classes/renderer.k8sapi.resourcequotasstore/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.resourcestack => renderer.k8sapi.resourcestack}/index.html (79%) rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.role => renderer.k8sapi.role}/index.html (58%) create mode 100644 master/extensions/api/classes/renderer.k8sapi.rolebinding/index.html create mode 100644 master/extensions/api/classes/renderer.k8sapi.rolebindingsstore/index.html create mode 100644 master/extensions/api/classes/renderer.k8sapi.rolesstore/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.secret => renderer.k8sapi.secret}/index.html (57%) create mode 100644 master/extensions/api/classes/renderer.k8sapi.secretsstore/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.service => renderer.k8sapi.service}/index.html (56%) create mode 100644 master/extensions/api/classes/renderer.k8sapi.serviceaccount/index.html create mode 100644 master/extensions/api/classes/renderer.k8sapi.serviceaccountsstore/index.html create mode 100644 master/extensions/api/classes/renderer.k8sapi.servicestore/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.statefulset => renderer.k8sapi.statefulset}/index.html (55%) create mode 100644 master/extensions/api/classes/renderer.k8sapi.statefulsetstore/index.html rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_k8s_api_.storageclass => renderer.k8sapi.storageclass}/index.html (56%) create mode 100644 master/extensions/api/classes/renderer.k8sapi.storageclassstore/index.html create mode 100644 master/extensions/api/classes/renderer.k8sapi.volumeclaimstore/index.html rename master/extensions/api/classes/{_renderer_api_index_.lensrendererextension => renderer.lensextension}/index.html (73%) rename master/extensions/api/classes/{_renderer_api_index_._renderer_api_navigation_.pageparam => renderer.navigation.pageparam}/index.html (83%) rename master/extensions/api/enums/{_renderer_api_index_._renderer_api_components_.notificationstatus => renderer.component.notificationstatus}/index.html (96%) rename master/extensions/api/enums/{_renderer_api_index_._renderer_api_components_.tooltipposition => renderer.component.tooltipposition}/index.html (92%) rename master/extensions/api/enums/{_renderer_api_index_._renderer_api_k8s_api_.kubeobjectstatuslevel => renderer.k8sapi.kubeobjectstatuslevel}/index.html (96%) delete mode 100644 master/extensions/api/interfaces/_common_api_index_._common_api_types_.clusterpagemenuregistration/index.html delete mode 100644 master/extensions/api/interfaces/_renderer_api_index_._renderer_api_components_.badgeprops/index.html delete mode 100644 master/extensions/api/interfaces/_renderer_api_index_._renderer_api_components_.buttonprops/index.html delete mode 100644 master/extensions/api/interfaces/_renderer_api_index_._renderer_api_components_.dialogprops/index.html delete mode 100644 master/extensions/api/interfaces/_renderer_api_index_._renderer_api_components_.draweritemlabelsprops/index.html delete mode 100644 master/extensions/api/interfaces/_renderer_api_index_._renderer_api_components_.draweritemprops/index.html delete mode 100644 master/extensions/api/interfaces/_renderer_api_index_._renderer_api_components_.iconprops/index.html delete mode 100644 master/extensions/api/interfaces/_renderer_api_index_._renderer_api_components_.kubeobjectlistlayoutprops/index.html delete mode 100644 master/extensions/api/interfaces/_renderer_api_index_._renderer_api_components_.kubeobjectmenuprops/index.html delete mode 100644 master/extensions/api/interfaces/_renderer_api_index_._renderer_api_components_.lineprogressprops/index.html delete mode 100644 master/extensions/api/interfaces/_renderer_api_index_._renderer_api_components_.menuactionsprops/index.html delete mode 100644 master/extensions/api/interfaces/_renderer_api_index_._renderer_api_components_.menuitemprops/index.html delete mode 100644 master/extensions/api/interfaces/_renderer_api_index_._renderer_api_components_.menuposition/index.html delete mode 100644 master/extensions/api/interfaces/_renderer_api_index_._renderer_api_components_.pagelayoutprops/index.html delete mode 100644 master/extensions/api/interfaces/_renderer_api_index_._renderer_api_components_.selectprops/index.html delete mode 100644 master/extensions/api/interfaces/_renderer_api_index_._renderer_api_components_.spinnerprops/index.html delete mode 100644 master/extensions/api/interfaces/_renderer_api_index_._renderer_api_components_.statusbrickprops/index.html delete mode 100644 master/extensions/api/interfaces/_renderer_api_index_._renderer_api_components_.stepperprops/index.html delete mode 100644 master/extensions/api/interfaces/_renderer_api_index_._renderer_api_components_.tablecellprops/index.html delete mode 100644 master/extensions/api/interfaces/_renderer_api_index_._renderer_api_components_.tableheadprops/index.html delete mode 100644 master/extensions/api/interfaces/_renderer_api_index_._renderer_api_components_.tableprops/index.html delete mode 100644 master/extensions/api/interfaces/_renderer_api_index_._renderer_api_components_.tablerowprops/index.html delete mode 100644 master/extensions/api/interfaces/_renderer_api_index_._renderer_api_components_.tabprops/index.html delete mode 100644 master/extensions/api/interfaces/_renderer_api_index_._renderer_api_components_.tooltipcontentformatters/index.html delete mode 100644 master/extensions/api/interfaces/_renderer_api_index_._renderer_api_components_.wizardlayoutprops/index.html delete mode 100644 master/extensions/api/interfaces/_renderer_api_index_._renderer_api_components_.wizardprops/index.html delete mode 100644 master/extensions/api/interfaces/_renderer_api_index_._renderer_api_k8s_api_.ipodcontainer/index.html delete mode 100644 master/extensions/api/interfaces/_renderer_api_index_._renderer_api_navigation_.iurlparams/index.html rename master/extensions/api/interfaces/{_common_api_index_._common_api_catalog_.catalogcategoryevents => common.catalog.catalogcategoryevents}/index.html (89%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_catalog_.catalogcategoryspec => common.catalog.catalogcategoryspec}/index.html (94%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_catalog_.catalogcategoryversion => common.catalog.catalogcategoryversion}/index.html (93%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_catalog_.catalogentityactioncontext => common.catalog.catalogentityactioncontext}/index.html (91%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_catalog_.catalogentityaddmenu => common.catalog.catalogentityaddmenu}/index.html (87%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_catalog_.catalogentityaddmenucontext => common.catalog.catalogentityaddmenucontext}/index.html (94%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_catalog_.catalogentitycontextmenu => common.catalog.catalogentitycontextmenu}/index.html (90%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_catalog_.catalogentitycontextmenucontext => common.catalog.catalogentitycontextmenucontext}/index.html (94%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_catalog_.catalogentitydata => common.catalog.catalogentitydata}/index.html (92%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_catalog_.catalogentitykinddata => common.catalog.catalogentitykinddata}/index.html (95%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_catalog_.catalogentitymetadata => common.catalog.catalogentitymetadata}/index.html (91%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_catalog_.catalogentitysettingscontext => common.catalog.catalogentitysettingscontext}/index.html (96%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_catalog_.catalogentitysettingsmenu => common.catalog.catalogentitysettingsmenu}/index.html (93%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_catalog_.catalogentitystatus => common.catalog.catalogentitystatus}/index.html (92%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_catalog_.kubernetesclusterstatus => common.catalog.kubernetesclusterstatus}/index.html (90%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_catalog_.weblinkstatus => common.catalog.weblinkstatus}/index.html (89%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_types_.apppreferencecomponents => common.types.apppreferencecomponents}/index.html (93%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_types_.apppreferenceregistration => common.types.apppreferenceregistration}/index.html (91%) create mode 100644 master/extensions/api/interfaces/common.types.clusterpagemenuregistration/index.html rename master/extensions/api/interfaces/{_common_api_index_._common_api_types_.kubeobjectdetailcomponents => common.types.kubeobjectdetailcomponents}/index.html (96%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_types_.kubeobjectdetailregistration => common.types.kubeobjectdetailregistration}/index.html (92%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_types_.kubeobjectmenucomponents => common.types.kubeobjectmenucomponents}/index.html (96%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_types_.kubeobjectmenuregistration => common.types.kubeobjectmenuregistration}/index.html (94%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_types_.kubeobjectstatusregistration => common.types.kubeobjectstatusregistration}/index.html (93%) create mode 100644 master/extensions/api/interfaces/common.types.pagecomponentprops/index.html rename master/extensions/api/interfaces/{_common_api_index_._common_api_types_.pagecomponents => common.types.pagecomponents}/index.html (96%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_types_.pagemenucomponents => common.types.pagemenucomponents}/index.html (96%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_types_.pagemenuregistration => common.types.pagemenuregistration}/index.html (94%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_types_.pageparams => common.types.pageparams}/index.html (96%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_types_.pageregistration => common.types.pageregistration}/index.html (92%) create mode 100644 master/extensions/api/interfaces/common.types.pagetarget/index.html rename master/extensions/api/interfaces/{_common_api_index_._common_api_types_.protocolhandlerregistration => common.types.protocolhandlerregistration}/index.html (95%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_types_.routehandler => common.types.protocolroutehandler}/index.html (94%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_types_.routeparams => common.types.protocolrouteparams}/index.html (93%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_types_.registeredpage => common.types.registeredpage}/index.html (93%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_types_.statusbarregistration => common.types.statusbarregistration}/index.html (94%) create mode 100644 master/extensions/api/interfaces/renderer.component.badgeprops/index.html create mode 100644 master/extensions/api/interfaces/renderer.component.buttonprops/index.html rename master/extensions/api/interfaces/{_renderer_api_index_._renderer_api_components_.notification => renderer.component.checkboxprops}/index.html (87%) rename master/extensions/api/interfaces/{_renderer_api_index_._renderer_api_components_.tablayoutprops => renderer.component.confirmdialogbooleanparams}/index.html (89%) rename master/extensions/api/interfaces/{_renderer_api_index_._renderer_api_components_.confirmdialogparams => renderer.component.confirmdialogparams}/index.html (82%) rename master/extensions/api/interfaces/{_renderer_api_index_._renderer_api_components_.drawerprops => renderer.component.confirmdialogprops}/index.html (82%) create mode 100644 master/extensions/api/interfaces/renderer.component.cubespinnerprops/index.html rename master/extensions/api/interfaces/{_renderer_api_index_._renderer_api_components_.confirmdialogbooleanparams => renderer.component.dialogprops}/index.html (85%) create mode 100644 master/extensions/api/interfaces/renderer.component.draweritemlabelsprops/index.html create mode 100644 master/extensions/api/interfaces/renderer.component.draweritemprops/index.html rename master/extensions/api/interfaces/{_renderer_api_index_._renderer_api_components_.drawerparamtogglerprops => renderer.component.drawerparamtogglerprops}/index.html (96%) rename master/extensions/api/interfaces/{_renderer_api_index_._renderer_api_components_.tablayoutroute => renderer.component.drawerprops}/index.html (86%) create mode 100644 master/extensions/api/interfaces/renderer.component.drawertitleprops/index.html rename master/extensions/api/interfaces/{_renderer_api_index_._renderer_api_components_.groupselectoption => renderer.component.groupselectoption}/index.html (94%) create mode 100644 master/extensions/api/interfaces/renderer.component.iconprops/index.html rename master/extensions/api/interfaces/{_renderer_api_index_._renderer_api_components_.inputvalidator => renderer.component.inputvalidator}/index.html (89%) rename master/extensions/api/interfaces/{_renderer_api_index_._renderer_api_components_.kubeeventdetailsprops => renderer.component.kubeeventdetailsprops}/index.html (96%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_types_.pagecomponentprops => renderer.component.kubeobjectdetailsprops}/index.html (93%) rename master/extensions/api/interfaces/{_renderer_api_index_._renderer_api_components_.wizardstepprops => renderer.component.kubeobjectlistlayoutprops}/index.html (54%) create mode 100644 master/extensions/api/interfaces/renderer.component.kubeobjectmenuprops/index.html rename master/extensions/api/interfaces/{_renderer_api_index_._renderer_api_components_.kubeobjectmetaprops => renderer.component.kubeobjectmetaprops}/index.html (94%) create mode 100644 master/extensions/api/interfaces/renderer.component.lineprogressprops/index.html rename master/extensions/api/interfaces/{_renderer_api_index_._renderer_api_components_.menuprops => renderer.component.menuactionsprops}/index.html (72%) create mode 100644 master/extensions/api/interfaces/renderer.component.menuitemprops/index.html rename master/extensions/api/interfaces/{_renderer_api_index_._renderer_api_components_.drawertitleprops => renderer.component.menuposition}/index.html (92%) rename master/extensions/api/interfaces/{_renderer_api_index_._renderer_api_components_.checkboxprops => renderer.component.menuprops}/index.html (82%) rename master/extensions/api/interfaces/{_renderer_api_index_._renderer_api_components_.sliderprops => renderer.component.notification}/index.html (90%) create mode 100644 master/extensions/api/interfaces/renderer.component.pagelayoutprops/index.html rename master/extensions/api/interfaces/{_renderer_api_index_._renderer_api_components_.radiogroupprops => renderer.component.radiogroupprops}/index.html (89%) rename master/extensions/api/interfaces/{_renderer_api_index_._renderer_api_components_.selectoption => renderer.component.selectoption}/index.html (93%) create mode 100644 master/extensions/api/interfaces/renderer.component.selectprops/index.html create mode 100644 master/extensions/api/interfaces/renderer.component.sliderprops/index.html create mode 100644 master/extensions/api/interfaces/renderer.component.spinnerprops/index.html create mode 100644 master/extensions/api/interfaces/renderer.component.statusbrickprops/index.html create mode 100644 master/extensions/api/interfaces/renderer.component.stepperprops/index.html rename master/extensions/api/interfaces/{_renderer_api_index_._renderer_api_components_.cubespinnerprops => renderer.component.tablayoutprops}/index.html (92%) rename master/extensions/api/interfaces/{_common_api_index_._common_api_types_.pagetarget => renderer.component.tablayoutroute}/index.html (90%) create mode 100644 master/extensions/api/interfaces/renderer.component.tablecellprops/index.html create mode 100644 master/extensions/api/interfaces/renderer.component.tableheadprops/index.html create mode 100644 master/extensions/api/interfaces/renderer.component.tableprops/index.html create mode 100644 master/extensions/api/interfaces/renderer.component.tablerowprops/index.html create mode 100644 master/extensions/api/interfaces/renderer.component.tabprops/index.html create mode 100644 master/extensions/api/interfaces/renderer.component.tabsprops/index.html create mode 100644 master/extensions/api/interfaces/renderer.component.tooltipcontentformatters/index.html rename master/extensions/api/interfaces/{_renderer_api_index_._renderer_api_components_.tooltipdecoratorprops => renderer.component.tooltipdecoratorprops}/index.html (92%) create mode 100644 master/extensions/api/interfaces/renderer.component.tooltipprops/index.html create mode 100644 master/extensions/api/interfaces/renderer.component.wizardlayoutprops/index.html rename master/extensions/api/interfaces/{_renderer_api_index_._renderer_api_components_.tooltipprops => renderer.component.wizardprops}/index.html (80%) create mode 100644 master/extensions/api/interfaces/renderer.component.wizardstepprops/index.html rename master/extensions/api/interfaces/{_renderer_api_index_._renderer_api_k8s_api_.ikubeapicluster => renderer.k8sapi.ikubeapicluster}/index.html (96%) rename master/extensions/api/interfaces/{_renderer_api_index_._renderer_api_components_.tabsprops => renderer.k8sapi.ipodcontainer}/index.html (80%) rename master/extensions/api/interfaces/{_renderer_api_index_._renderer_api_k8s_api_.ipodcontainerstatus => renderer.k8sapi.ipodcontainerstatus}/index.html (83%) rename master/extensions/api/interfaces/{_renderer_api_index_._renderer_api_k8s_api_.isecretref => renderer.k8sapi.isecretref}/index.html (95%) rename master/extensions/api/interfaces/{_renderer_api_index_._renderer_api_components_.kubeobjectdetailsprops => renderer.navigation.iurlparams}/index.html (92%) rename master/extensions/api/interfaces/{_renderer_api_index_._renderer_api_navigation_.pageparaminit => renderer.navigation.pageparaminit}/index.html (88%) delete mode 100644 master/extensions/api/modules/_common_api_index_._common_api_app_/index.html delete mode 100644 master/extensions/api/modules/_renderer_api_index_._renderer_api_k8s_api_/index.html delete mode 100644 master/extensions/api/modules/_renderer_api_index_/index.html create mode 100644 master/extensions/api/modules/common.app/index.html rename master/extensions/api/modules/{_common_api_index_._common_api_catalog_ => common.catalog}/index.html (80%) rename master/extensions/api/modules/{_common_api_index_._common_api_event_bus_ => common.eventbus}/index.html (90%) rename master/extensions/api/modules/{_common_api_index_._common_api_stores_ => common.store}/index.html (97%) rename master/extensions/api/modules/{_common_api_index_._common_api_types_ => common.types}/index.html (87%) rename master/extensions/api/modules/{_common_api_index_._common_api_utils_ => common.util}/index.html (88%) rename master/extensions/api/{interfaces/_renderer_api_index_._renderer_api_components_.confirmdialogprops => modules/common}/index.html (95%) rename master/extensions/api/{globals => modules}/index.html (97%) rename master/extensions/api/modules/{_renderer_api_index_._renderer_api_catalog_ => main.catalog}/index.html (92%) rename master/extensions/api/modules/{_main_api_index_._main_api_navigation_ => main.navigation}/index.html (95%) rename master/extensions/api/modules/{_main_api_index_ => main}/index.html (95%) rename master/extensions/api/modules/{_main_api_index_._main_api_catalog_ => renderer.catalog}/index.html (92%) rename master/extensions/api/modules/{_renderer_api_index_._renderer_api_components_ => renderer.component}/index.html (50%) create mode 100644 master/extensions/api/modules/renderer.k8sapi/index.html rename master/extensions/api/modules/{_renderer_api_index_._renderer_api_navigation_ => renderer.navigation}/index.html (85%) rename master/extensions/api/modules/{_renderer_api_index_._renderer_api_theming_ => renderer.theme}/index.html (96%) rename master/extensions/api/modules/{_common_api_index_ => renderer}/index.html (94%) diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.badge/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.badge/index.html deleted file mode 100644 index 65aa418531..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.badge/index.html +++ /dev/null @@ -1,1393 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: Badge ‹**S, SS, S**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: Badge ‹S, SS, S›#

-

Type parameters#

-

▪ S

-

▪ SS

-

▪ S

-

Hierarchy#

- -

↳ Badge

-

Index#

-

Constructors#

- -

Properties#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new Badge(props: Readonly‹BadgeProps› | BadgeProps): Badge

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:473

-

Parameters:

- - - - - - - - - - - - - -
NameType
propsReadonly‹BadgeProps› | BadgeProps
-

Returns: Badge

-

+ new Badge(props: BadgeProps, context: any): Badge

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:475

-

deprecated

-

see https://reactjs.org/docs/legacy-context.html

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
propsBadgeProps
contextany
-

Returns: Badge

-

Properties#

-

context#

-

• context: any

-

Inherited from PageLayout.context

-

Defined in node_modules/@types/react/index.d.ts:473

-

If using the new style context, re-declare this in your class to be the -React.ContextType of your static contextType. -Should be used with type annotation or static contextType.

-
static contextType = MyContext
-// For TS pre-3.7:
-context!: React.ContextType<typeof MyContext>
-// For TS 3.7 and above:
-declare context: React.ContextType<typeof MyContext>
-
-

see https://reactjs.org/docs/context.html

-
-

props#

-

• props: Readonly‹BadgeProps› & Readonly‹object›

-

Inherited from PageLayout.props

-

Defined in node_modules/@types/react/index.d.ts:498

-
-

refs#

-

• refs: object

-

Inherited from PageLayout.refs

-

Defined in node_modules/@types/react/index.d.ts:504

-

deprecated -https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

-

Type declaration:#

-
    -
  • [ key: string]: ReactInstance
    • -
-
-

state#

-

• state: Readonly‹S›

-

Inherited from PageLayout.state

-

Defined in node_modules/@types/react/index.d.ts:499

-
-

Static Optional contextType#

-

▪ contextType? : Context‹any›

-

Inherited from PageLayout.contextType

-

Defined in node_modules/@types/react/index.d.ts:455

-

If set, this.context will be set at runtime to the current value of the given Context.

-

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
-
-class Foo extends React.Component {
-  static contextType = Ctx
-  context!: React.ContextType<typeof Ctx>
-  render () {
-    return <>My context's value: {this.context}</>;
-  }
-}
-
-

see https://reactjs.org/docs/context.html#classcontexttype

-

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹BadgeProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹BadgeProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹BadgeProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹BadgeProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

Optional componentDidMount#

-

▸ componentDidMount(): void

-

Inherited from WizardLayout.componentDidMount

-

Defined in node_modules/@types/react/index.d.ts:619

-

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

-

Returns: void

-
-

Optional componentDidUpdate#

-

▸ componentDidUpdate(prevProps: Readonly‹BadgeProps›, prevState: Readonly‹S›, snapshot?: SS): void

-

Inherited from PageLayout.componentDidUpdate

-

Defined in node_modules/@types/react/index.d.ts:682

-

Called immediately after updating occurs. Not called for the initial render.

-

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹BadgeProps›
prevStateReadonly‹S›
snapshot?SS
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹BadgeProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹BadgeProps›
nextContextany
-

Returns: void

-
-

Optional componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Inherited from WizardLayout.componentWillUnmount

-

Defined in node_modules/@types/react/index.d.ts:635

-

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as -cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹BadgeProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹BadgeProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

forceUpdate#

-

▸ forceUpdate(callback?: function): void

-

Inherited from PageLayout.forceUpdate

-

Defined in node_modules/@types/react/index.d.ts:490

-

Parameters:

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹BadgeProps›, prevState: Readonly‹S›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹BadgeProps›
prevStateReadonly‹S›
-

Returns: SS | null

-
-

render#

-

▸ render(): Element‹›

-

Overrides void

-

Defined in src/renderer/components/badge/badge.tsx:36

-

Returns: Element‹›

-
-

setState#

-

▸ setState‹K›(state: function | S | object, callback?: function): void

-

Inherited from PageLayout.setState

-

Defined in node_modules/@types/react/index.d.ts:485

-

Type parameters:

-

▪ K: keyof S

-

Parameters:

-

▪ state: function | S | object

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹BadgeProps›, nextState: Readonly‹S›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹BadgeProps›
nextStateReadonly‹S›
nextContextany
-

Returns: boolean

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.button/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.button/index.html deleted file mode 100644 index 5ec676c170..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.button/index.html +++ /dev/null @@ -1,1158 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: Button ‹**SS**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: Button ‹SS›#

-

Type parameters#

-

▪ SS

-

Hierarchy#

- -

↳ Button

-

Index#

-

Methods#

- -

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹ButtonProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹ButtonProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹ButtonProps›, nextState: Readonly‹object›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹ButtonProps›
nextStateReadonly‹object›
nextContextany
-

Returns: void

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

Optional componentDidMount#

-

▸ componentDidMount(): void

-

Inherited from WizardLayout.componentDidMount

-

Defined in node_modules/@types/react/index.d.ts:619

-

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

-

Returns: void

-
-

Optional componentDidUpdate#

-

▸ componentDidUpdate(prevProps: Readonly‹ButtonProps›, prevState: Readonly‹object›, snapshot?: SS): void

-

Inherited from PageLayout.componentDidUpdate

-

Defined in node_modules/@types/react/index.d.ts:682

-

Called immediately after updating occurs. Not called for the initial render.

-

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹ButtonProps›
prevStateReadonly‹object›
snapshot?SS
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹ButtonProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹ButtonProps›
nextContextany
-

Returns: void

-
-

Optional componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Inherited from WizardLayout.componentWillUnmount

-

Defined in node_modules/@types/react/index.d.ts:635

-

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as -cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹ButtonProps›, nextState: Readonly‹object›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹ButtonProps›
nextStateReadonly‹object›
nextContextany
-

Returns: void

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹ButtonProps›, prevState: Readonly‹object›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹ButtonProps›
prevStateReadonly‹object›
-

Returns: SS | null

-
-

render#

-

▸ render(): Element‹›

-

Defined in src/renderer/components/button/button.tsx:45

-

Returns: Element‹›

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹ButtonProps›, nextState: Readonly‹object›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹ButtonProps›
nextStateReadonly‹object›
nextContextany
-

Returns: boolean

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.checkbox/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.checkbox/index.html deleted file mode 100644 index 46a16cc742..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.checkbox/index.html +++ /dev/null @@ -1,1200 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: Checkbox ‹**S, SS**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: Checkbox ‹S, SS›#

-

Type parameters#

-

▪ S

-

▪ SS

-

Hierarchy#

- -

↳ Checkbox

-

Index#

-

Methods#

- -

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹CheckboxProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹CheckboxProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹CheckboxProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹CheckboxProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

Optional componentDidMount#

-

▸ componentDidMount(): void

-

Inherited from WizardLayout.componentDidMount

-

Defined in node_modules/@types/react/index.d.ts:619

-

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

-

Returns: void

-
-

Optional componentDidUpdate#

-

▸ componentDidUpdate(prevProps: Readonly‹CheckboxProps›, prevState: Readonly‹S›, snapshot?: SS): void

-

Inherited from PageLayout.componentDidUpdate

-

Defined in node_modules/@types/react/index.d.ts:682

-

Called immediately after updating occurs. Not called for the initial render.

-

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹CheckboxProps›
prevStateReadonly‹S›
snapshot?SS
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹CheckboxProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹CheckboxProps›
nextContextany
-

Returns: void

-
-

Optional componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Inherited from WizardLayout.componentWillUnmount

-

Defined in node_modules/@types/react/index.d.ts:635

-

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as -cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹CheckboxProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹CheckboxProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹CheckboxProps›, prevState: Readonly‹S›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹CheckboxProps›
prevStateReadonly‹S›
-

Returns: SS | null

-
-

getValue#

-

▸ getValue(): boolean

-

Defined in src/renderer/components/checkbox/checkbox.tsx:46

-

Returns: boolean

-
-

onChange#

-

▸ onChange(evt: ChangeEvent‹HTMLInputElement›): void

-

Defined in src/renderer/components/checkbox/checkbox.tsx:40

-

Parameters:

- - - - - - - - - - - - - -
NameType
evtChangeEvent‹HTMLInputElement›
-

Returns: void

-
-

render#

-

▸ render(): Element‹›

-

Defined in src/renderer/components/checkbox/checkbox.tsx:52

-

Returns: Element‹›

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹CheckboxProps›, nextState: Readonly‹S›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹CheckboxProps›
nextStateReadonly‹S›
nextContextany
-

Returns: boolean

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.confirmdialog/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.confirmdialog/index.html deleted file mode 100644 index 12a2ffefad..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.confirmdialog/index.html +++ /dev/null @@ -1,1603 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: ConfirmDialog ‹**S, SS, S**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: ConfirmDialog ‹S, SS, S›#

-

Type parameters#

-

▪ S

-

▪ SS

-

▪ S

-

Hierarchy#

- -

↳ ConfirmDialog

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Object literals#

- -

Constructors#

-

constructor#

-

+ new ConfirmDialog(props: ConfirmDialogProps): ConfirmDialog

-

Overrides PageLayout.constructor

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:56

-

Parameters:

- - - - - - - - - - - - - -
NameType
propsConfirmDialogProps
-

Returns: ConfirmDialog

-

Properties#

-

context#

-

• context: any

-

Inherited from PageLayout.context

-

Defined in node_modules/@types/react/index.d.ts:473

-

If using the new style context, re-declare this in your class to be the -React.ContextType of your static contextType. -Should be used with type annotation or static contextType.

-
static contextType = MyContext
-// For TS pre-3.7:
-context!: React.ContextType<typeof MyContext>
-// For TS 3.7 and above:
-declare context: React.ContextType<typeof MyContext>
-
-

see https://reactjs.org/docs/context.html

-
-

isSaving#

-

• isSaving: boolean = false

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:56

-
-

props#

-

• props: Readonly‹ConfirmDialogProps› & Readonly‹object›

-

Inherited from PageLayout.props

-

Defined in node_modules/@types/react/index.d.ts:498

-
-

refs#

-

• refs: object

-

Inherited from PageLayout.refs

-

Defined in node_modules/@types/react/index.d.ts:504

-

deprecated -https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

-

Type declaration:#

-
    -
  • [ key: string]: ReactInstance
    • -
-
-

state#

-

• state: Readonly‹S›

-

Inherited from PageLayout.state

-

Defined in node_modules/@types/react/index.d.ts:499

-
-

Static Optional contextType#

-

▪ contextType? : Context‹any›

-

Inherited from PageLayout.contextType

-

Defined in node_modules/@types/react/index.d.ts:455

-

If set, this.context will be set at runtime to the current value of the given Context.

-

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
-
-class Foo extends React.Component {
-  static contextType = Ctx
-  context!: React.ContextType<typeof Ctx>
-  render () {
-    return <>My context's value: {this.context}</>;
-  }
-}
-
-

see https://reactjs.org/docs/context.html#classcontexttype

-

Accessors#

-

params#

-

• get params(): ConfirmDialogParams

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:86

-

Returns: ConfirmDialogParams

-

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹ConfirmDialogProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹ConfirmDialogProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹ConfirmDialogProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹ConfirmDialogProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

close#

-

▸ close(): Promise‹void›

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:104

-

Returns: Promise‹void›

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

Optional componentDidMount#

-

▸ componentDidMount(): void

-

Inherited from WizardLayout.componentDidMount

-

Defined in node_modules/@types/react/index.d.ts:619

-

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

-

Returns: void

-
-

Optional componentDidUpdate#

-

▸ componentDidUpdate(prevProps: Readonly‹ConfirmDialogProps›, prevState: Readonly‹S›, snapshot?: SS): void

-

Inherited from PageLayout.componentDidUpdate

-

Defined in node_modules/@types/react/index.d.ts:682

-

Called immediately after updating occurs. Not called for the initial render.

-

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹ConfirmDialogProps›
prevStateReadonly‹S›
snapshot?SS
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹ConfirmDialogProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹ConfirmDialogProps›
nextContextany
-

Returns: void

-
-

Optional componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Inherited from WizardLayout.componentWillUnmount

-

Defined in node_modules/@types/react/index.d.ts:635

-

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as -cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹ConfirmDialogProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹ConfirmDialogProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

forceUpdate#

-

▸ forceUpdate(callback?: function): void

-

Inherited from PageLayout.forceUpdate

-

Defined in node_modules/@types/react/index.d.ts:490

-

Parameters:

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹ConfirmDialogProps›, prevState: Readonly‹S›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹ConfirmDialogProps›
prevStateReadonly‹S›
-

Returns: SS | null

-
-

ok#

-

▸ ok(): Promise‹void›

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:90

-

Returns: Promise‹void›

-
-

onClose#

-

▸ onClose(): void

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:100

-

Returns: void

-
-

render#

-

▸ render(): Element‹›

-

Overrides void

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:113

-

Returns: Element‹›

-
-

setState#

-

▸ setState‹K›(state: function | S | object, callback?: function): void

-

Inherited from PageLayout.setState

-

Defined in node_modules/@types/react/index.d.ts:485

-

Type parameters:

-

▪ K: keyof S

-

Parameters:

-

▪ state: function | S | object

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹ConfirmDialogProps›, nextState: Readonly‹S›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹ConfirmDialogProps›
nextStateReadonly‹S›
nextContextany
-

Returns: boolean

-
-

Static confirm#

-

▸ confirm(params: ConfirmDialogBooleanParams): Promise‹boolean›

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:68

-

Parameters:

- - - - - - - - - - - - - -
NameType
paramsConfirmDialogBooleanParams
-

Returns: Promise‹boolean›

-
-

Static open#

-

▸ open(params: ConfirmDialogParams): void

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:63

-

Parameters:

- - - - - - - - - - - - - -
NameType
paramsConfirmDialogParams
-

Returns: void

-

Object literals#

-

Static defaultParams#

-

▪ defaultParams: object#

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:78

-

cancel#

-

• cancel: noop = noop

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:80

-

icon#

-

• icon: Element‹› =

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:83

-

labelCancel#

-

• labelCancel: string = "Cancel"

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:82

-

labelOk#

-

• labelOk: string = "Ok"

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:81

-

ok#

-

• ok: noop = noop

-

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:79

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.cubespinner/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.cubespinner/index.html deleted file mode 100644 index 5830baeb62..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.cubespinner/index.html +++ /dev/null @@ -1,1393 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: CubeSpinner ‹**S, SS, S**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: CubeSpinner ‹S, SS, S›#

-

Type parameters#

-

▪ S

-

▪ SS

-

▪ S

-

Hierarchy#

- -

↳ CubeSpinner

-

Index#

-

Constructors#

- -

Properties#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new CubeSpinner(props: Readonly‹CubeSpinnerProps› | CubeSpinnerProps): CubeSpinner

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:473

-

Parameters:

- - - - - - - - - - - - - -
NameType
propsReadonly‹CubeSpinnerProps› | CubeSpinnerProps
-

Returns: CubeSpinner

-

+ new CubeSpinner(props: CubeSpinnerProps, context: any): CubeSpinner

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:475

-

deprecated

-

see https://reactjs.org/docs/legacy-context.html

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
propsCubeSpinnerProps
contextany
-

Returns: CubeSpinner

-

Properties#

-

context#

-

• context: any

-

Inherited from PageLayout.context

-

Defined in node_modules/@types/react/index.d.ts:473

-

If using the new style context, re-declare this in your class to be the -React.ContextType of your static contextType. -Should be used with type annotation or static contextType.

-
static contextType = MyContext
-// For TS pre-3.7:
-context!: React.ContextType<typeof MyContext>
-// For TS 3.7 and above:
-declare context: React.ContextType<typeof MyContext>
-
-

see https://reactjs.org/docs/context.html

-
-

props#

-

• props: Readonly‹CubeSpinnerProps› & Readonly‹object›

-

Inherited from PageLayout.props

-

Defined in node_modules/@types/react/index.d.ts:498

-
-

refs#

-

• refs: object

-

Inherited from PageLayout.refs

-

Defined in node_modules/@types/react/index.d.ts:504

-

deprecated -https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

-

Type declaration:#

-
    -
  • [ key: string]: ReactInstance
    • -
-
-

state#

-

• state: Readonly‹S›

-

Inherited from PageLayout.state

-

Defined in node_modules/@types/react/index.d.ts:499

-
-

Static Optional contextType#

-

▪ contextType? : Context‹any›

-

Inherited from PageLayout.contextType

-

Defined in node_modules/@types/react/index.d.ts:455

-

If set, this.context will be set at runtime to the current value of the given Context.

-

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
-
-class Foo extends React.Component {
-  static contextType = Ctx
-  context!: React.ContextType<typeof Ctx>
-  render () {
-    return <>My context's value: {this.context}</>;
-  }
-}
-
-

see https://reactjs.org/docs/context.html#classcontexttype

-

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹CubeSpinnerProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹CubeSpinnerProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹CubeSpinnerProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹CubeSpinnerProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

Optional componentDidMount#

-

▸ componentDidMount(): void

-

Inherited from WizardLayout.componentDidMount

-

Defined in node_modules/@types/react/index.d.ts:619

-

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

-

Returns: void

-
-

Optional componentDidUpdate#

-

▸ componentDidUpdate(prevProps: Readonly‹CubeSpinnerProps›, prevState: Readonly‹S›, snapshot?: SS): void

-

Inherited from PageLayout.componentDidUpdate

-

Defined in node_modules/@types/react/index.d.ts:682

-

Called immediately after updating occurs. Not called for the initial render.

-

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹CubeSpinnerProps›
prevStateReadonly‹S›
snapshot?SS
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹CubeSpinnerProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹CubeSpinnerProps›
nextContextany
-

Returns: void

-
-

Optional componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Inherited from WizardLayout.componentWillUnmount

-

Defined in node_modules/@types/react/index.d.ts:635

-

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as -cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹CubeSpinnerProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹CubeSpinnerProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

forceUpdate#

-

▸ forceUpdate(callback?: function): void

-

Inherited from PageLayout.forceUpdate

-

Defined in node_modules/@types/react/index.d.ts:490

-

Parameters:

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹CubeSpinnerProps›, prevState: Readonly‹S›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹CubeSpinnerProps›
prevStateReadonly‹S›
-

Returns: SS | null

-
-

render#

-

▸ render(): Element‹›

-

Overrides void

-

Defined in src/renderer/components/spinner/cube-spinner.tsx:32

-

Returns: Element‹›

-
-

setState#

-

▸ setState‹K›(state: function | S | object, callback?: function): void

-

Inherited from PageLayout.setState

-

Defined in node_modules/@types/react/index.d.ts:485

-

Type parameters:

-

▪ K: keyof S

-

Parameters:

-

▪ state: function | S | object

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹CubeSpinnerProps›, nextState: Readonly‹S›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹CubeSpinnerProps›
nextStateReadonly‹S›
nextContextany
-

Returns: boolean

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.dialog/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.dialog/index.html deleted file mode 100644 index c0c7956d72..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.dialog/index.html +++ /dev/null @@ -1,1516 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: Dialog ‹**SS**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: Dialog ‹SS›#

-

Type parameters#

-

▪ SS

-

Hierarchy#

- -

↳ Dialog

-

Index#

-

Properties#

- -

Accessors#

- -

Methods#

- -

Object literals#

- -

Properties#

-

closeOnNavigate#

-

• closeOnNavigate: IReactionDisposer = reaction(() => navigation.toString(), () => this.close())

-

Defined in src/renderer/components/dialog/dialog.tsx:66

-

Accessors#

-

elem#

-

• get elem(): HTMLElement

-

Defined in src/renderer/components/dialog/dialog.tsx:72

-

Returns: HTMLElement

-
-

isOpen#

-

• get isOpen(): boolean

-

Defined in src/renderer/components/dialog/dialog.tsx:77

-

Returns: boolean

-

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹DialogProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹DialogProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹DialogProps›, nextState: Readonly‹DialogState›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹DialogProps›
nextStateReadonly‹DialogState›
nextContextany
-

Returns: void

-
-

close#

-

▸ close(): void

-

Defined in src/renderer/components/dialog/dialog.tsx:108

-

Returns: void

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

componentDidMount#

-

▸ componentDidMount(): void

-

Overrides WizardLayout.componentDidMount

-

Defined in src/renderer/components/dialog/dialog.tsx:81

-

Returns: void

-
-

componentDidUpdate#

-

▸ componentDidUpdate(prevProps: DialogProps): void

-

Overrides PageLayout.componentDidUpdate

-

Defined in src/renderer/components/dialog/dialog.tsx:85

-

Parameters:

- - - - - - - - - - - - - -
NameType
prevPropsDialogProps
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹DialogProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹DialogProps›
nextContextany
-

Returns: void

-
-

componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Overrides WizardLayout.componentWillUnmount

-

Defined in src/renderer/components/dialog/dialog.tsx:93

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹DialogProps›, nextState: Readonly‹DialogState›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹DialogProps›
nextStateReadonly‹DialogState›
nextContextany
-

Returns: void

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹DialogProps›, prevState: Readonly‹DialogState›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹DialogProps›
prevStateReadonly‹DialogState›
-

Returns: SS | null

-
-

onClickOutside#

-

▸ onClickOutside(evt: MouseEvent): void

-

Defined in src/renderer/components/dialog/dialog.tsx:142

-

Parameters:

- - - - - - - - - - - - - -
NameType
evtMouseEvent
-

Returns: void

-
-

onClose#

-

▸ onClose(): void

-

Defined in src/renderer/components/dialog/dialog.tsx:124

-

Returns: void

-
-

onEscapeKey#

-

▸ onEscapeKey(evt: KeyboardEvent): void

-

Defined in src/renderer/components/dialog/dialog.tsx:133

-

Parameters:

- - - - - - - - - - - - - -
NameType
evtKeyboardEvent
-

Returns: void

-
-

onOpen#

-

▸ onOpen(): void

-

Defined in src/renderer/components/dialog/dialog.tsx:114

-

Returns: void

-
-

open#

-

▸ open(): void

-

Defined in src/renderer/components/dialog/dialog.tsx:102

-

Returns: void

-
-

render#

-

▸ render(): ReactPortal‹›

-

Defined in src/renderer/components/dialog/dialog.tsx:151

-

Returns: ReactPortal‹›

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹DialogProps›, nextState: Readonly‹DialogState›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹DialogProps›
nextStateReadonly‹DialogState›
nextContextany
-

Returns: boolean

-
-

toggle#

-

▸ toggle(isOpen: boolean): void

-

Defined in src/renderer/components/dialog/dialog.tsx:97

-

Parameters:

- - - - - - - - - - - - - -
NameType
isOpenboolean
-

Returns: void

-

Object literals#

-

state#

-

▪ state: object#

-

Defined in src/renderer/components/dialog/dialog.tsx:68

-

isOpen#

-

• isOpen: boolean = this.props.isOpen

-

Defined in src/renderer/components/dialog/dialog.tsx:69

-
-

Static defaultProps#

-

▪ defaultProps: object#

-

Defined in src/renderer/components/dialog/dialog.tsx:54

-

animated#

-

• animated: true = true

-

Defined in src/renderer/components/dialog/dialog.tsx:61

-

close#

-

• close: noop = noop

-

Defined in src/renderer/components/dialog/dialog.tsx:57

-

isOpen#

-

• isOpen: false = false

-

Defined in src/renderer/components/dialog/dialog.tsx:55

- -

• modal: true = true

-

Defined in src/renderer/components/dialog/dialog.tsx:60

-

onClose#

-

• onClose: noop = noop

-

Defined in src/renderer/components/dialog/dialog.tsx:59

-

onOpen#

-

• onOpen: noop = noop

-

Defined in src/renderer/components/dialog/dialog.tsx:58

-

open#

-

• open: noop = noop

-

Defined in src/renderer/components/dialog/dialog.tsx:56

-

pinned#

-

• pinned: false = false

-

Defined in src/renderer/components/dialog/dialog.tsx:62

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.draweritem/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.draweritem/index.html deleted file mode 100644 index 94fe7bc3fa..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.draweritem/index.html +++ /dev/null @@ -1,1393 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: DrawerItem ‹**S, SS, S**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: DrawerItem ‹S, SS, S›#

-

Type parameters#

-

▪ S

-

▪ SS

-

▪ S

-

Hierarchy#

- -

↳ DrawerItem

-

Index#

-

Constructors#

- -

Properties#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new DrawerItem(props: Readonly‹DrawerItemProps› | DrawerItemProps): DrawerItem

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:473

-

Parameters:

- - - - - - - - - - - - - -
NameType
propsReadonly‹DrawerItemProps› | DrawerItemProps
-

Returns: DrawerItem

-

+ new DrawerItem(props: DrawerItemProps, context: any): DrawerItem

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:475

-

deprecated

-

see https://reactjs.org/docs/legacy-context.html

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
propsDrawerItemProps
contextany
-

Returns: DrawerItem

-

Properties#

-

context#

-

• context: any

-

Inherited from PageLayout.context

-

Defined in node_modules/@types/react/index.d.ts:473

-

If using the new style context, re-declare this in your class to be the -React.ContextType of your static contextType. -Should be used with type annotation or static contextType.

-
static contextType = MyContext
-// For TS pre-3.7:
-context!: React.ContextType<typeof MyContext>
-// For TS 3.7 and above:
-declare context: React.ContextType<typeof MyContext>
-
-

see https://reactjs.org/docs/context.html

-
-

props#

-

• props: Readonly‹DrawerItemProps› & Readonly‹object›

-

Inherited from PageLayout.props

-

Defined in node_modules/@types/react/index.d.ts:498

-
-

refs#

-

• refs: object

-

Inherited from PageLayout.refs

-

Defined in node_modules/@types/react/index.d.ts:504

-

deprecated -https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

-

Type declaration:#

-
    -
  • [ key: string]: ReactInstance
    • -
-
-

state#

-

• state: Readonly‹S›

-

Inherited from PageLayout.state

-

Defined in node_modules/@types/react/index.d.ts:499

-
-

Static Optional contextType#

-

▪ contextType? : Context‹any›

-

Inherited from PageLayout.contextType

-

Defined in node_modules/@types/react/index.d.ts:455

-

If set, this.context will be set at runtime to the current value of the given Context.

-

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
-
-class Foo extends React.Component {
-  static contextType = Ctx
-  context!: React.ContextType<typeof Ctx>
-  render () {
-    return <>My context's value: {this.context}</>;
-  }
-}
-
-

see https://reactjs.org/docs/context.html#classcontexttype

-

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹DrawerItemProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹DrawerItemProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹DrawerItemProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹DrawerItemProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

Optional componentDidMount#

-

▸ componentDidMount(): void

-

Inherited from WizardLayout.componentDidMount

-

Defined in node_modules/@types/react/index.d.ts:619

-

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

-

Returns: void

-
-

Optional componentDidUpdate#

-

▸ componentDidUpdate(prevProps: Readonly‹DrawerItemProps›, prevState: Readonly‹S›, snapshot?: SS): void

-

Inherited from PageLayout.componentDidUpdate

-

Defined in node_modules/@types/react/index.d.ts:682

-

Called immediately after updating occurs. Not called for the initial render.

-

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹DrawerItemProps›
prevStateReadonly‹S›
snapshot?SS
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹DrawerItemProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹DrawerItemProps›
nextContextany
-

Returns: void

-
-

Optional componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Inherited from WizardLayout.componentWillUnmount

-

Defined in node_modules/@types/react/index.d.ts:635

-

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as -cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹DrawerItemProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹DrawerItemProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

forceUpdate#

-

▸ forceUpdate(callback?: function): void

-

Inherited from PageLayout.forceUpdate

-

Defined in node_modules/@types/react/index.d.ts:490

-

Parameters:

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹DrawerItemProps›, prevState: Readonly‹S›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹DrawerItemProps›
prevStateReadonly‹S›
-

Returns: SS | null

-
-

render#

-

▸ render(): Element‹›

-

Overrides void

-

Defined in src/renderer/components/drawer/drawer-item.tsx:36

-

Returns: Element‹›

-
-

setState#

-

▸ setState‹K›(state: function | S | object, callback?: function): void

-

Inherited from PageLayout.setState

-

Defined in node_modules/@types/react/index.d.ts:485

-

Type parameters:

-

▪ K: keyof S

-

Parameters:

-

▪ state: function | S | object

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹DrawerItemProps›, nextState: Readonly‹S›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹DrawerItemProps›
nextStateReadonly‹S›
nextContextany
-

Returns: boolean

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.drawerparamtoggler/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.drawerparamtoggler/index.html deleted file mode 100644 index 6e22fc464c..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.drawerparamtoggler/index.html +++ /dev/null @@ -1,1404 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: DrawerParamToggler ‹**SS**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: DrawerParamToggler ‹SS›#

-

Type parameters#

-

▪ SS

-

Hierarchy#

- -

↳ DrawerParamToggler

-

Index#

-

Constructors#

- -

Properties#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new DrawerParamToggler(props: Readonly‹DrawerParamTogglerProps› | DrawerParamTogglerProps): DrawerParamToggler

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:473

-

Parameters:

- - - - - - - - - - - - - -
NameType
propsReadonly‹DrawerParamTogglerProps› | DrawerParamTogglerProps
-

Returns: DrawerParamToggler

-

+ new DrawerParamToggler(props: DrawerParamTogglerProps, context: any): DrawerParamToggler

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:475

-

deprecated

-

see https://reactjs.org/docs/legacy-context.html

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
propsDrawerParamTogglerProps
contextany
-

Returns: DrawerParamToggler

-

Properties#

-

context#

-

• context: any

-

Inherited from PageLayout.context

-

Defined in node_modules/@types/react/index.d.ts:473

-

If using the new style context, re-declare this in your class to be the -React.ContextType of your static contextType. -Should be used with type annotation or static contextType.

-
static contextType = MyContext
-// For TS pre-3.7:
-context!: React.ContextType<typeof MyContext>
-// For TS 3.7 and above:
-declare context: React.ContextType<typeof MyContext>
-
-

see https://reactjs.org/docs/context.html

-
-

props#

-

• props: Readonly‹DrawerParamTogglerProps› & Readonly‹object›

-

Inherited from PageLayout.props

-

Defined in node_modules/@types/react/index.d.ts:498

-
-

refs#

-

• refs: object

-

Inherited from PageLayout.refs

-

Defined in node_modules/@types/react/index.d.ts:504

-

deprecated -https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

-

Type declaration:#

-
    -
  • [ key: string]: ReactInstance
    • -
-
-

state#

-

• state: State

-

Overrides PageLayout.state

-

Defined in src/renderer/components/drawer/drawer-param-toggler.tsx:35

-
-

Static Optional contextType#

-

▪ contextType? : Context‹any›

-

Inherited from PageLayout.contextType

-

Defined in node_modules/@types/react/index.d.ts:455

-

If set, this.context will be set at runtime to the current value of the given Context.

-

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
-
-class Foo extends React.Component {
-  static contextType = Ctx
-  context!: React.ContextType<typeof Ctx>
-  render () {
-    return <>My context's value: {this.context}</>;
-  }
-}
-
-

see https://reactjs.org/docs/context.html#classcontexttype

-

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹DrawerParamTogglerProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹DrawerParamTogglerProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹DrawerParamTogglerProps›, nextState: Readonly‹State›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹DrawerParamTogglerProps›
nextStateReadonly‹State›
nextContextany
-

Returns: void

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

Optional componentDidMount#

-

▸ componentDidMount(): void

-

Inherited from WizardLayout.componentDidMount

-

Defined in node_modules/@types/react/index.d.ts:619

-

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

-

Returns: void

-
-

Optional componentDidUpdate#

-

▸ componentDidUpdate(prevProps: Readonly‹DrawerParamTogglerProps›, prevState: Readonly‹State›, snapshot?: SS): void

-

Inherited from PageLayout.componentDidUpdate

-

Defined in node_modules/@types/react/index.d.ts:682

-

Called immediately after updating occurs. Not called for the initial render.

-

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹DrawerParamTogglerProps›
prevStateReadonly‹State›
snapshot?SS
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹DrawerParamTogglerProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹DrawerParamTogglerProps›
nextContextany
-

Returns: void

-
-

Optional componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Inherited from WizardLayout.componentWillUnmount

-

Defined in node_modules/@types/react/index.d.ts:635

-

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as -cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹DrawerParamTogglerProps›, nextState: Readonly‹State›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹DrawerParamTogglerProps›
nextStateReadonly‹State›
nextContextany
-

Returns: void

-
-

forceUpdate#

-

▸ forceUpdate(callback?: function): void

-

Inherited from PageLayout.forceUpdate

-

Defined in node_modules/@types/react/index.d.ts:490

-

Parameters:

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹DrawerParamTogglerProps›, prevState: Readonly‹State›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹DrawerParamTogglerProps›
prevStateReadonly‹State›
-

Returns: SS | null

-
-

render#

-

▸ render(): Element‹›

-

Overrides void

-

Defined in src/renderer/components/drawer/drawer-param-toggler.tsx:41

-

Returns: Element‹›

-
-

setState#

-

▸ setState‹K›(state: function | S | object, callback?: function): void

-

Inherited from PageLayout.setState

-

Defined in node_modules/@types/react/index.d.ts:485

-

Type parameters:

-

▪ K: keyof State

-

Parameters:

-

▪ state: function | S | object

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹DrawerParamTogglerProps›, nextState: Readonly‹State›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹DrawerParamTogglerProps›
nextStateReadonly‹State›
nextContextany
-

Returns: boolean

-
-

toggle#

-

▸ toggle(): void

-

Defined in src/renderer/components/drawer/drawer-param-toggler.tsx:37

-

Returns: void

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.drawertitle/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.drawertitle/index.html deleted file mode 100644 index 1a2e60bca8..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.drawertitle/index.html +++ /dev/null @@ -1,1393 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: DrawerTitle ‹**S, SS, S**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: DrawerTitle ‹S, SS, S›#

-

Type parameters#

-

▪ S

-

▪ SS

-

▪ S

-

Hierarchy#

- -

↳ DrawerTitle

-

Index#

-

Constructors#

- -

Properties#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new DrawerTitle(props: Readonly‹DrawerTitleProps› | DrawerTitleProps): DrawerTitle

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:473

-

Parameters:

- - - - - - - - - - - - - -
NameType
propsReadonly‹DrawerTitleProps› | DrawerTitleProps
-

Returns: DrawerTitle

-

+ new DrawerTitle(props: DrawerTitleProps, context: any): DrawerTitle

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:475

-

deprecated

-

see https://reactjs.org/docs/legacy-context.html

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
propsDrawerTitleProps
contextany
-

Returns: DrawerTitle

-

Properties#

-

context#

-

• context: any

-

Inherited from PageLayout.context

-

Defined in node_modules/@types/react/index.d.ts:473

-

If using the new style context, re-declare this in your class to be the -React.ContextType of your static contextType. -Should be used with type annotation or static contextType.

-
static contextType = MyContext
-// For TS pre-3.7:
-context!: React.ContextType<typeof MyContext>
-// For TS 3.7 and above:
-declare context: React.ContextType<typeof MyContext>
-
-

see https://reactjs.org/docs/context.html

-
-

props#

-

• props: Readonly‹DrawerTitleProps› & Readonly‹object›

-

Inherited from PageLayout.props

-

Defined in node_modules/@types/react/index.d.ts:498

-
-

refs#

-

• refs: object

-

Inherited from PageLayout.refs

-

Defined in node_modules/@types/react/index.d.ts:504

-

deprecated -https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

-

Type declaration:#

-
    -
  • [ key: string]: ReactInstance
    • -
-
-

state#

-

• state: Readonly‹S›

-

Inherited from PageLayout.state

-

Defined in node_modules/@types/react/index.d.ts:499

-
-

Static Optional contextType#

-

▪ contextType? : Context‹any›

-

Inherited from PageLayout.contextType

-

Defined in node_modules/@types/react/index.d.ts:455

-

If set, this.context will be set at runtime to the current value of the given Context.

-

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
-
-class Foo extends React.Component {
-  static contextType = Ctx
-  context!: React.ContextType<typeof Ctx>
-  render () {
-    return <>My context's value: {this.context}</>;
-  }
-}
-
-

see https://reactjs.org/docs/context.html#classcontexttype

-

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹DrawerTitleProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹DrawerTitleProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹DrawerTitleProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹DrawerTitleProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

Optional componentDidMount#

-

▸ componentDidMount(): void

-

Inherited from WizardLayout.componentDidMount

-

Defined in node_modules/@types/react/index.d.ts:619

-

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

-

Returns: void

-
-

Optional componentDidUpdate#

-

▸ componentDidUpdate(prevProps: Readonly‹DrawerTitleProps›, prevState: Readonly‹S›, snapshot?: SS): void

-

Inherited from PageLayout.componentDidUpdate

-

Defined in node_modules/@types/react/index.d.ts:682

-

Called immediately after updating occurs. Not called for the initial render.

-

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹DrawerTitleProps›
prevStateReadonly‹S›
snapshot?SS
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹DrawerTitleProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹DrawerTitleProps›
nextContextany
-

Returns: void

-
-

Optional componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Inherited from WizardLayout.componentWillUnmount

-

Defined in node_modules/@types/react/index.d.ts:635

-

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as -cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹DrawerTitleProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹DrawerTitleProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

forceUpdate#

-

▸ forceUpdate(callback?: function): void

-

Inherited from PageLayout.forceUpdate

-

Defined in node_modules/@types/react/index.d.ts:490

-

Parameters:

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹DrawerTitleProps›, prevState: Readonly‹S›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹DrawerTitleProps›
prevStateReadonly‹S›
-

Returns: SS | null

-
-

render#

-

▸ render(): Element‹›

-

Overrides void

-

Defined in src/renderer/components/drawer/drawer-title.tsx:32

-

Returns: Element‹›

-
-

setState#

-

▸ setState‹K›(state: function | S | object, callback?: function): void

-

Inherited from PageLayout.setState

-

Defined in node_modules/@types/react/index.d.ts:485

-

Type parameters:

-

▪ K: keyof S

-

Parameters:

-

▪ state: function | S | object

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹DrawerTitleProps›, nextState: Readonly‹S›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹DrawerTitleProps›
nextStateReadonly‹S›
nextContextany
-

Returns: boolean

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.icon/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.icon/index.html deleted file mode 100644 index af82323e4e..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.icon/index.html +++ /dev/null @@ -1,1303 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: Icon ‹**S, SS**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: Icon ‹S, SS›#

-

Type parameters#

-

▪ S

-

▪ SS

-

Hierarchy#

- -

↳ Icon

-

Index#

-

Accessors#

- -

Methods#

- -

Object literals#

- -

Accessors#

-

isInteractive#

-

• get isInteractive(): boolean

-

Defined in src/renderer/components/icon/icon.tsx:54

-

Returns: boolean

-

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹IconProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹IconProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹IconProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹IconProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

Optional componentDidMount#

-

▸ componentDidMount(): void

-

Inherited from WizardLayout.componentDidMount

-

Defined in node_modules/@types/react/index.d.ts:619

-

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

-

Returns: void

-
-

Optional componentDidUpdate#

-

▸ componentDidUpdate(prevProps: Readonly‹IconProps›, prevState: Readonly‹S›, snapshot?: SS): void

-

Inherited from PageLayout.componentDidUpdate

-

Defined in node_modules/@types/react/index.d.ts:682

-

Called immediately after updating occurs. Not called for the initial render.

-

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹IconProps›
prevStateReadonly‹S›
snapshot?SS
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹IconProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹IconProps›
nextContextany
-

Returns: void

-
-

Optional componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Inherited from WizardLayout.componentWillUnmount

-

Defined in node_modules/@types/react/index.d.ts:635

-

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as -cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹IconProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹IconProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹IconProps›, prevState: Readonly‹S›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹IconProps›
prevStateReadonly‹S›
-

Returns: SS | null

-
-

onClick#

-

▸ onClick(evt: MouseEvent): void

-

Defined in src/renderer/components/icon/icon.tsx:61

-

Parameters:

- - - - - - - - - - - - - -
NameType
evtMouseEvent
-

Returns: void

-
-

onKeyDown#

-

▸ onKeyDown(evt: KeyboardEvent‹any›): void

-

Defined in src/renderer/components/icon/icon.tsx:72

-

Parameters:

- - - - - - - - - - - - - -
NameType
evtKeyboardEvent‹any›
-

Returns: void

-
-

render#

-

▸ render(): Element‹›

-

Defined in src/renderer/components/icon/icon.tsx:91

-

Returns: Element‹›

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹IconProps›, nextState: Readonly‹S›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹IconProps›
nextStateReadonly‹S›
nextContextany
-

Returns: boolean

-

Object literals#

-

Static defaultProps#

-

▪ defaultProps: object#

-

Defined in src/renderer/components/icon/icon.tsx:50

-

focusable#

-

• focusable: true = true

-

Defined in src/renderer/components/icon/icon.tsx:51

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.kubeobjectmeta/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.kubeobjectmeta/index.html deleted file mode 100644 index f1f07c0369..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.kubeobjectmeta/index.html +++ /dev/null @@ -1,1435 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: KubeObjectMeta ‹**S, SS, S**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: KubeObjectMeta ‹S, SS, S›#

-

Type parameters#

-

▪ S

-

▪ SS

-

▪ S

-

Hierarchy#

- -

↳ KubeObjectMeta

-

Index#

-

Constructors#

- -

Properties#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new KubeObjectMeta(props: Readonly‹KubeObjectMetaProps› | KubeObjectMetaProps): KubeObjectMeta

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:473

-

Parameters:

- - - - - - - - - - - - - -
NameType
propsReadonly‹KubeObjectMetaProps› | KubeObjectMetaProps
-

Returns: KubeObjectMeta

-

+ new KubeObjectMeta(props: KubeObjectMetaProps, context: any): KubeObjectMeta

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:475

-

deprecated

-

see https://reactjs.org/docs/legacy-context.html

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
propsKubeObjectMetaProps
contextany
-

Returns: KubeObjectMeta

-

Properties#

-

context#

-

• context: any

-

Inherited from PageLayout.context

-

Defined in node_modules/@types/react/index.d.ts:473

-

If using the new style context, re-declare this in your class to be the -React.ContextType of your static contextType. -Should be used with type annotation or static contextType.

-
static contextType = MyContext
-// For TS pre-3.7:
-context!: React.ContextType<typeof MyContext>
-// For TS 3.7 and above:
-declare context: React.ContextType<typeof MyContext>
-
-

see https://reactjs.org/docs/context.html

-
-

props#

-

• props: Readonly‹KubeObjectMetaProps› & Readonly‹object›

-

Inherited from PageLayout.props

-

Defined in node_modules/@types/react/index.d.ts:498

-
-

refs#

-

• refs: object

-

Inherited from PageLayout.refs

-

Defined in node_modules/@types/react/index.d.ts:504

-

deprecated -https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

-

Type declaration:#

-
    -
  • [ key: string]: ReactInstance
    • -
-
-

state#

-

• state: Readonly‹S›

-

Inherited from PageLayout.state

-

Defined in node_modules/@types/react/index.d.ts:499

-
-

Static Optional contextType#

-

▪ contextType? : Context‹any›

-

Inherited from PageLayout.contextType

-

Defined in node_modules/@types/react/index.d.ts:455

-

If set, this.context will be set at runtime to the current value of the given Context.

-

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
-
-class Foo extends React.Component {
-  static contextType = Ctx
-  context!: React.ContextType<typeof Ctx>
-  render () {
-    return <>My context's value: {this.context}</>;
-  }
-}
-
-

see https://reactjs.org/docs/context.html#classcontexttype

-
-

Static defaultHiddenFields#

-

▪ defaultHiddenFields: IKubeMetaField[] = [ - "uid", "resourceVersion", "selfLink" - ]

-

Defined in src/renderer/components/kube-object/kube-object-meta.tsx:37

-

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹KubeObjectMetaProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹KubeObjectMetaProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹KubeObjectMetaProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹KubeObjectMetaProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

Optional componentDidMount#

-

▸ componentDidMount(): void

-

Inherited from WizardLayout.componentDidMount

-

Defined in node_modules/@types/react/index.d.ts:619

-

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

-

Returns: void

-
-

Optional componentDidUpdate#

-

▸ componentDidUpdate(prevProps: Readonly‹KubeObjectMetaProps›, prevState: Readonly‹S›, snapshot?: SS): void

-

Inherited from PageLayout.componentDidUpdate

-

Defined in node_modules/@types/react/index.d.ts:682

-

Called immediately after updating occurs. Not called for the initial render.

-

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹KubeObjectMetaProps›
prevStateReadonly‹S›
snapshot?SS
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹KubeObjectMetaProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹KubeObjectMetaProps›
nextContextany
-

Returns: void

-
-

Optional componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Inherited from WizardLayout.componentWillUnmount

-

Defined in node_modules/@types/react/index.d.ts:635

-

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as -cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹KubeObjectMetaProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹KubeObjectMetaProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

forceUpdate#

-

▸ forceUpdate(callback?: function): void

-

Inherited from PageLayout.forceUpdate

-

Defined in node_modules/@types/react/index.d.ts:490

-

Parameters:

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹KubeObjectMetaProps›, prevState: Readonly‹S›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹KubeObjectMetaProps›
prevStateReadonly‹S›
-

Returns: SS | null

-
-

isHidden#

-

▸ isHidden(field: IKubeMetaField): boolean

-

Defined in src/renderer/components/kube-object/kube-object-meta.tsx:41

-

Parameters:

- - - - - - - - - - - - - -
NameType
fieldIKubeMetaField
-

Returns: boolean

-
-

render#

-

▸ render(): Element‹›

-

Overrides void

-

Defined in src/renderer/components/kube-object/kube-object-meta.tsx:47

-

Returns: Element‹›

-
-

setState#

-

▸ setState‹K›(state: function | S | object, callback?: function): void

-

Inherited from PageLayout.setState

-

Defined in node_modules/@types/react/index.d.ts:485

-

Type parameters:

-

▪ K: keyof S

-

Parameters:

-

▪ state: function | S | object

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹KubeObjectMetaProps›, nextState: Readonly‹S›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹KubeObjectMetaProps›
nextStateReadonly‹S›
nextContextany
-

Returns: boolean

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.lineprogress/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.lineprogress/index.html deleted file mode 100644 index f524f1c813..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.lineprogress/index.html +++ /dev/null @@ -1,1241 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: LineProgress ‹**S, SS**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: LineProgress ‹S, SS›#

-

Type parameters#

-

▪ S

-

▪ SS

-

Hierarchy#

- -

↳ LineProgress

-

Index#

-

Methods#

- -

Object literals#

- -

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹LineProgressProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹LineProgressProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹LineProgressProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹LineProgressProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

Optional componentDidMount#

-

▸ componentDidMount(): void

-

Inherited from WizardLayout.componentDidMount

-

Defined in node_modules/@types/react/index.d.ts:619

-

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

-

Returns: void

-
-

Optional componentDidUpdate#

-

▸ componentDidUpdate(prevProps: Readonly‹LineProgressProps›, prevState: Readonly‹S›, snapshot?: SS): void

-

Inherited from PageLayout.componentDidUpdate

-

Defined in node_modules/@types/react/index.d.ts:682

-

Called immediately after updating occurs. Not called for the initial render.

-

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹LineProgressProps›
prevStateReadonly‹S›
snapshot?SS
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹LineProgressProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹LineProgressProps›
nextContextany
-

Returns: void

-
-

Optional componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Inherited from WizardLayout.componentWillUnmount

-

Defined in node_modules/@types/react/index.d.ts:635

-

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as -cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹LineProgressProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹LineProgressProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹LineProgressProps›, prevState: Readonly‹S›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹LineProgressProps›
prevStateReadonly‹S›
-

Returns: SS | null

-
-

render#

-

▸ render(): Element‹›

-

Defined in src/renderer/components/line-progress/line-progress.tsx:44

-

Returns: Element‹›

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹LineProgressProps›, nextState: Readonly‹S›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹LineProgressProps›
nextStateReadonly‹S›
nextContextany
-

Returns: boolean

-

Object literals#

-

Static defaultProps#

-

▪ defaultProps: object#

-

Defined in src/renderer/components/line-progress/line-progress.tsx:37

-

max#

-

• max: number = 100

-

Defined in src/renderer/components/line-progress/line-progress.tsx:40

-

min#

-

• min: number = 0

-

Defined in src/renderer/components/line-progress/line-progress.tsx:39

-

precise#

-

• precise: number = 2

-

Defined in src/renderer/components/line-progress/line-progress.tsx:41

-

value#

-

• value: number = 0

-

Defined in src/renderer/components/line-progress/line-progress.tsx:38

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.menuactions/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.menuactions/index.html deleted file mode 100644 index 51a2e93751..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.menuactions/index.html +++ /dev/null @@ -1,1483 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: MenuActions ‹**S, SS, S**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: MenuActions ‹S, SS, S›#

-

Type parameters#

-

▪ S

-

▪ SS

-

▪ S

-

Hierarchy#

- -

↳ MenuActions

-

Index#

-

Constructors#

- -

Properties#

- -

Methods#

- -

Object literals#

- -

Constructors#

-

constructor#

-

+ new MenuActions(props: MenuActionsProps): MenuActions

-

Overrides PageLayout.constructor

-

Defined in src/renderer/components/menu/menu-actions.tsx:60

-

Parameters:

- - - - - - - - - - - - - -
NameType
propsMenuActionsProps
-

Returns: MenuActions

-

Properties#

-

context#

-

• context: any

-

Inherited from PageLayout.context

-

Defined in node_modules/@types/react/index.d.ts:473

-

If using the new style context, re-declare this in your class to be the -React.ContextType of your static contextType. -Should be used with type annotation or static contextType.

-
static contextType = MyContext
-// For TS pre-3.7:
-context!: React.ContextType<typeof MyContext>
-// For TS 3.7 and above:
-declare context: React.ContextType<typeof MyContext>
-
-

see https://reactjs.org/docs/context.html

-
-

id#

-

• id: string = uniqueId("menu_actions_")

-

Defined in src/renderer/components/menu/menu-actions.tsx:53

-
-

isOpen#

-

• isOpen: boolean = !!this.props.toolbar

-

Defined in src/renderer/components/menu/menu-actions.tsx:55

-
-

props#

-

• props: Readonly‹MenuActionsProps› & Readonly‹object›

-

Inherited from PageLayout.props

-

Defined in node_modules/@types/react/index.d.ts:498

-
-

refs#

-

• refs: object

-

Inherited from PageLayout.refs

-

Defined in node_modules/@types/react/index.d.ts:504

-

deprecated -https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

-

Type declaration:#

-
    -
  • [ key: string]: ReactInstance
    • -
-
-

state#

-

• state: Readonly‹S›

-

Inherited from PageLayout.state

-

Defined in node_modules/@types/react/index.d.ts:499

-
-

Static Optional contextType#

-

▪ contextType? : Context‹any›

-

Inherited from PageLayout.contextType

-

Defined in node_modules/@types/react/index.d.ts:455

-

If set, this.context will be set at runtime to the current value of the given Context.

-

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
-
-class Foo extends React.Component {
-  static contextType = Ctx
-  context!: React.ContextType<typeof Ctx>
-  render () {
-    return <>My context's value: {this.context}</>;
-  }
-}
-
-

see https://reactjs.org/docs/context.html#classcontexttype

-

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹MenuActionsProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹MenuActionsProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹MenuActionsProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹MenuActionsProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

Optional componentDidMount#

-

▸ componentDidMount(): void

-

Inherited from WizardLayout.componentDidMount

-

Defined in node_modules/@types/react/index.d.ts:619

-

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

-

Returns: void

-
-

Optional componentDidUpdate#

-

▸ componentDidUpdate(prevProps: Readonly‹MenuActionsProps›, prevState: Readonly‹S›, snapshot?: SS): void

-

Inherited from PageLayout.componentDidUpdate

-

Defined in node_modules/@types/react/index.d.ts:682

-

Called immediately after updating occurs. Not called for the initial render.

-

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹MenuActionsProps›
prevStateReadonly‹S›
snapshot?SS
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹MenuActionsProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹MenuActionsProps›
nextContextany
-

Returns: void

-
-

Optional componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Inherited from WizardLayout.componentWillUnmount

-

Defined in node_modules/@types/react/index.d.ts:635

-

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as -cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹MenuActionsProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹MenuActionsProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

forceUpdate#

-

▸ forceUpdate(callback?: function): void

-

Inherited from PageLayout.forceUpdate

-

Defined in node_modules/@types/react/index.d.ts:490

-

Parameters:

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹MenuActionsProps›, prevState: Readonly‹S›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹MenuActionsProps›
prevStateReadonly‹S›
-

Returns: SS | null

-
-

remove#

-

▸ remove(): void

-

Defined in src/renderer/components/menu/menu-actions.tsx:68

-

Returns: void

-
-

render#

-

▸ render(): Element‹›

-

Overrides void

-

Defined in src/renderer/components/menu/menu-actions.tsx:113

-

Returns: Element‹›

-
-

renderTriggerIcon#

-

▸ renderTriggerIcon(): Element‹›

-

Defined in src/renderer/components/menu/menu-actions.tsx:82

-

Returns: Element‹›

-
-

setState#

-

▸ setState‹K›(state: function | S | object, callback?: function): void

-

Inherited from PageLayout.setState

-

Defined in node_modules/@types/react/index.d.ts:485

-

Type parameters:

-

▪ K: keyof S

-

Parameters:

-

▪ state: function | S | object

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹MenuActionsProps›, nextState: Readonly‹S›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹MenuActionsProps›
nextStateReadonly‹S›
nextContextany
-

Returns: boolean

-
-

toggle#

-

▸ toggle(): void

-

Defined in src/renderer/components/menu/menu-actions.tsx:57

-

Returns: void

-

Object literals#

-

Static defaultProps#

-

▪ defaultProps: object#

-

Defined in src/renderer/components/menu/menu-actions.tsx:47

-

removeConfirmationMessage#

-

• removeConfirmationMessage:

-

Defined in src/renderer/components/menu/menu-actions.tsx:48

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.namespaceselectfilter/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.namespaceselectfilter/index.html deleted file mode 100644 index 5b07bba828..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.namespaceselectfilter/index.html +++ /dev/null @@ -1,1454 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: NamespaceSelectFilter ‹**S, SS, S**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: NamespaceSelectFilter ‹S, SS, S›#

-

Type parameters#

-

▪ S

-

▪ SS

-

▪ S

-

Hierarchy#

- -

↳ NamespaceSelectFilter

-

Index#

-

Constructors#

- -

Properties#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new NamespaceSelectFilter(props: Readonly‹SelectProps› | SelectProps): NamespaceSelectFilter

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:473

-

Parameters:

- - - - - - - - - - - - - -
NameType
propsReadonly‹SelectProps› | SelectProps
-

Returns: NamespaceSelectFilter

-

+ new NamespaceSelectFilter(props: SelectProps, context: any): NamespaceSelectFilter

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:475

-

deprecated

-

see https://reactjs.org/docs/legacy-context.html

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
propsSelectProps
contextany
-

Returns: NamespaceSelectFilter

-

Properties#

-

context#

-

• context: any

-

Inherited from PageLayout.context

-

Defined in node_modules/@types/react/index.d.ts:473

-

If using the new style context, re-declare this in your class to be the -React.ContextType of your static contextType. -Should be used with type annotation or static contextType.

-
static contextType = MyContext
-// For TS pre-3.7:
-context!: React.ContextType<typeof MyContext>
-// For TS 3.7 and above:
-declare context: React.ContextType<typeof MyContext>
-
-

see https://reactjs.org/docs/context.html

-
-

props#

-

• props: Readonly‹SelectProps› & Readonly‹object›

-

Inherited from PageLayout.props

-

Defined in node_modules/@types/react/index.d.ts:498

-
-

refs#

-

• refs: object

-

Inherited from PageLayout.refs

-

Defined in node_modules/@types/react/index.d.ts:504

-

deprecated -https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

-

Type declaration:#

-
    -
  • [ key: string]: ReactInstance
    • -
-
-

state#

-

• state: Readonly‹S›

-

Inherited from PageLayout.state

-

Defined in node_modules/@types/react/index.d.ts:499

-
-

Static Optional contextType#

-

▪ contextType? : Context‹any›

-

Inherited from PageLayout.contextType

-

Defined in node_modules/@types/react/index.d.ts:455

-

If set, this.context will be set at runtime to the current value of the given Context.

-

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
-
-class Foo extends React.Component {
-  static contextType = Ctx
-  context!: React.ContextType<typeof Ctx>
-  render () {
-    return <>My context's value: {this.context}</>;
-  }
-}
-
-

see https://reactjs.org/docs/context.html#classcontexttype

-

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹SelectProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹SelectProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹SelectProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹SelectProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

Optional componentDidMount#

-

▸ componentDidMount(): void

-

Inherited from WizardLayout.componentDidMount

-

Defined in node_modules/@types/react/index.d.ts:619

-

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

-

Returns: void

-
-

Optional componentDidUpdate#

-

▸ componentDidUpdate(prevProps: Readonly‹SelectProps›, prevState: Readonly‹S›, snapshot?: SS): void

-

Inherited from PageLayout.componentDidUpdate

-

Defined in node_modules/@types/react/index.d.ts:682

-

Called immediately after updating occurs. Not called for the initial render.

-

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹SelectProps›
prevStateReadonly‹S›
snapshot?SS
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹SelectProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹SelectProps›
nextContextany
-

Returns: void

-
-

Optional componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Inherited from WizardLayout.componentWillUnmount

-

Defined in node_modules/@types/react/index.d.ts:635

-

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as -cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹SelectProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹SelectProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

forceUpdate#

-

▸ forceUpdate(callback?: function): void

-

Inherited from PageLayout.forceUpdate

-

Defined in node_modules/@types/react/index.d.ts:490

-

Parameters:

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

formatOptionLabel#

-

▸ formatOptionLabel(__namedParameters: object): string | number | false | true | object | ReactElement‹any, string | function | object› | ReactNodeArray‹› | ReactPortal‹›

-

Defined in src/renderer/components/+namespaces/namespace-select-filter.tsx:58

-

Parameters:

-

▪ __namedParameters: object

- - - - - - - - - - - - - - - - - -
NameType
labelstring | number | false | true | object | ReactElement‹any, string | function | object› | ReactNodeArray‹› | ReactPortal‹›
namespaceany
-

Returns: string | number | false | true | object | ReactElement‹any, string | function | object› | ReactNodeArray‹› | ReactPortal‹›

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹SelectProps›, prevState: Readonly‹S›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹SelectProps›
prevStateReadonly‹S›
-

Returns: SS | null

-
-

onChange#

-

▸ onChange(__namedParameters: [any]): void

-

Defined in src/renderer/components/+namespaces/namespace-select-filter.tsx:74

-

Parameters:

- - - - - - - - - - - - - -
NameType
__namedParameters[any]
-

Returns: void

-
-

render#

-

▸ render(): Element‹›

-

Overrides void

-

Defined in src/renderer/components/+namespaces/namespace-select-filter.tsx:82

-

Returns: Element‹›

-
-

setState#

-

▸ setState‹K›(state: function | S | object, callback?: function): void

-

Inherited from PageLayout.setState

-

Defined in node_modules/@types/react/index.d.ts:485

-

Type parameters:

-

▪ K: keyof S

-

Parameters:

-

▪ state: function | S | object

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹SelectProps›, nextState: Readonly‹S›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹SelectProps›
nextStateReadonly‹S›
nextContextany
-

Returns: boolean

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.radio/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.radio/index.html deleted file mode 100644 index 2c73d4a99c..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.radio/index.html +++ /dev/null @@ -1,1434 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: Radio ‹**S, SS, S**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: Radio ‹S, SS, S›#

-

Type parameters#

-

▪ S

-

▪ SS

-

▪ S

-

Hierarchy#

- -

↳ Radio

-

Index#

-

Constructors#

- -

Properties#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new Radio(props: Readonly‹RadioProps› | RadioProps): Radio

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:473

-

Parameters:

- - - - - - - - - - - - - -
NameType
propsReadonly‹RadioProps› | RadioProps
-

Returns: Radio

-

+ new Radio(props: RadioProps, context: any): Radio

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:475

-

deprecated

-

see https://reactjs.org/docs/legacy-context.html

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
propsRadioProps
contextany
-

Returns: Radio

-

Properties#

-

context#

-

• context: any

-

Inherited from PageLayout.context

-

Defined in node_modules/@types/react/index.d.ts:473

-

If using the new style context, re-declare this in your class to be the -React.ContextType of your static contextType. -Should be used with type annotation or static contextType.

-
static contextType = MyContext
-// For TS pre-3.7:
-context!: React.ContextType<typeof MyContext>
-// For TS 3.7 and above:
-declare context: React.ContextType<typeof MyContext>
-
-

see https://reactjs.org/docs/context.html

-
-

props#

-

• props: Readonly‹RadioProps› & Readonly‹object›

-

Inherited from PageLayout.props

-

Defined in node_modules/@types/react/index.d.ts:498

-
-

refs#

-

• refs: object

-

Inherited from PageLayout.refs

-

Defined in node_modules/@types/react/index.d.ts:504

-

deprecated -https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

-

Type declaration:#

-
    -
  • [ key: string]: ReactInstance
    • -
-
-

state#

-

• state: Readonly‹S›

-

Inherited from PageLayout.state

-

Defined in node_modules/@types/react/index.d.ts:499

-
-

Static Optional contextType#

-

▪ contextType? : Context‹any›

-

Inherited from PageLayout.contextType

-

Defined in node_modules/@types/react/index.d.ts:455

-

If set, this.context will be set at runtime to the current value of the given Context.

-

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
-
-class Foo extends React.Component {
-  static contextType = Ctx
-  context!: React.ContextType<typeof Ctx>
-  render () {
-    return <>My context's value: {this.context}</>;
-  }
-}
-
-

see https://reactjs.org/docs/context.html#classcontexttype

-

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹RadioProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹RadioProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹RadioProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹RadioProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

Optional componentDidMount#

-

▸ componentDidMount(): void

-

Inherited from WizardLayout.componentDidMount

-

Defined in node_modules/@types/react/index.d.ts:619

-

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

-

Returns: void

-
-

Optional componentDidUpdate#

-

▸ componentDidUpdate(prevProps: Readonly‹RadioProps›, prevState: Readonly‹S›, snapshot?: SS): void

-

Inherited from PageLayout.componentDidUpdate

-

Defined in node_modules/@types/react/index.d.ts:682

-

Called immediately after updating occurs. Not called for the initial render.

-

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹RadioProps›
prevStateReadonly‹S›
snapshot?SS
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹RadioProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹RadioProps›
nextContextany
-

Returns: void

-
-

Optional componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Inherited from WizardLayout.componentWillUnmount

-

Defined in node_modules/@types/react/index.d.ts:635

-

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as -cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹RadioProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹RadioProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

forceUpdate#

-

▸ forceUpdate(callback?: function): void

-

Inherited from PageLayout.forceUpdate

-

Defined in node_modules/@types/react/index.d.ts:490

-

Parameters:

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹RadioProps›, prevState: Readonly‹S›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹RadioProps›
prevStateReadonly‹S›
-

Returns: SS | null

-
-

onChange#

-

▸ onChange(): void

-

Defined in src/renderer/components/radio/radio.tsx:73

-

Returns: void

-
-

onKeyDown#

-

▸ onKeyDown(e: KeyboardEvent‹any›): void

-

Defined in src/renderer/components/radio/radio.tsx:81

-

Parameters:

- - - - - - - - - - - - - -
NameType
eKeyboardEvent‹any›
-

Returns: void

-
-

render#

-

▸ render(): Element‹›

-

Overrides void

-

Defined in src/renderer/components/radio/radio.tsx:91

-

Returns: Element‹›

-
-

setState#

-

▸ setState‹K›(state: function | S | object, callback?: function): void

-

Inherited from PageLayout.setState

-

Defined in node_modules/@types/react/index.d.ts:485

-

Type parameters:

-

▪ K: keyof S

-

Parameters:

-

▪ state: function | S | object

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹RadioProps›, nextState: Readonly‹S›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹RadioProps›
nextStateReadonly‹S›
nextContextany
-

Returns: boolean

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.radiogroup/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.radiogroup/index.html deleted file mode 100644 index ae0a769de3..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.radiogroup/index.html +++ /dev/null @@ -1,1391 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: RadioGroup ‹**SS**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: RadioGroup ‹SS›#

-

Type parameters#

-

▪ SS

-

Hierarchy#

- -

↳ RadioGroup

-

Index#

-

Constructors#

- -

Properties#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new RadioGroup(props: Readonly‹RadioGroupProps› | RadioGroupProps): RadioGroup

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:473

-

Parameters:

- - - - - - - - - - - - - -
NameType
propsReadonly‹RadioGroupProps› | RadioGroupProps
-

Returns: RadioGroup

-

+ new RadioGroup(props: RadioGroupProps, context: any): RadioGroup

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:475

-

deprecated

-

see https://reactjs.org/docs/legacy-context.html

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
propsRadioGroupProps
contextany
-

Returns: RadioGroup

-

Properties#

-

context#

-

• context: any

-

Inherited from PageLayout.context

-

Defined in node_modules/@types/react/index.d.ts:473

-

If using the new style context, re-declare this in your class to be the -React.ContextType of your static contextType. -Should be used with type annotation or static contextType.

-
static contextType = MyContext
-// For TS pre-3.7:
-context!: React.ContextType<typeof MyContext>
-// For TS 3.7 and above:
-declare context: React.ContextType<typeof MyContext>
-
-

see https://reactjs.org/docs/context.html

-
-

props#

-

• props: Readonly‹RadioGroupProps› & Readonly‹object›

-

Inherited from PageLayout.props

-

Defined in node_modules/@types/react/index.d.ts:498

-
-

refs#

-

• refs: object

-

Inherited from PageLayout.refs

-

Defined in node_modules/@types/react/index.d.ts:504

-

deprecated -https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

-

Type declaration:#

-
    -
  • [ key: string]: ReactInstance
    • -
-
-

state#

-

• state: Readonly‹object›

-

Inherited from PageLayout.state

-

Defined in node_modules/@types/react/index.d.ts:499

-
-

Static Optional contextType#

-

▪ contextType? : Context‹any›

-

Inherited from PageLayout.contextType

-

Defined in node_modules/@types/react/index.d.ts:455

-

If set, this.context will be set at runtime to the current value of the given Context.

-

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
-
-class Foo extends React.Component {
-  static contextType = Ctx
-  context!: React.ContextType<typeof Ctx>
-  render () {
-    return <>My context's value: {this.context}</>;
-  }
-}
-
-

see https://reactjs.org/docs/context.html#classcontexttype

-

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹RadioGroupProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹RadioGroupProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹RadioGroupProps›, nextState: Readonly‹object›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹RadioGroupProps›
nextStateReadonly‹object›
nextContextany
-

Returns: void

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

Optional componentDidMount#

-

▸ componentDidMount(): void

-

Inherited from WizardLayout.componentDidMount

-

Defined in node_modules/@types/react/index.d.ts:619

-

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

-

Returns: void

-
-

Optional componentDidUpdate#

-

▸ componentDidUpdate(prevProps: Readonly‹RadioGroupProps›, prevState: Readonly‹object›, snapshot?: SS): void

-

Inherited from PageLayout.componentDidUpdate

-

Defined in node_modules/@types/react/index.d.ts:682

-

Called immediately after updating occurs. Not called for the initial render.

-

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹RadioGroupProps›
prevStateReadonly‹object›
snapshot?SS
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹RadioGroupProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹RadioGroupProps›
nextContextany
-

Returns: void

-
-

Optional componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Inherited from WizardLayout.componentWillUnmount

-

Defined in node_modules/@types/react/index.d.ts:635

-

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as -cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹RadioGroupProps›, nextState: Readonly‹object›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹RadioGroupProps›
nextStateReadonly‹object›
nextContextany
-

Returns: void

-
-

forceUpdate#

-

▸ forceUpdate(callback?: function): void

-

Inherited from PageLayout.forceUpdate

-

Defined in node_modules/@types/react/index.d.ts:490

-

Parameters:

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹RadioGroupProps›, prevState: Readonly‹object›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹RadioGroupProps›
prevStateReadonly‹object›
-

Returns: SS | null

-
-

render#

-

▸ render(): Element‹›

-

Overrides void

-

Defined in src/renderer/components/radio/radio.tsx:38

-

Returns: Element‹›

-
-

setState#

-

▸ setState‹K›(state: function | S | object, callback?: function): void

-

Inherited from PageLayout.setState

-

Defined in node_modules/@types/react/index.d.ts:485

-

Type parameters:

-

▪ K: keyof object

-

Parameters:

-

▪ state: function | S | object

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹RadioGroupProps›, nextState: Readonly‹object›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹RadioGroupProps›
nextStateReadonly‹object›
nextContextany
-

Returns: boolean

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.select/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.select/index.html deleted file mode 100644 index 65877528e6..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.select/index.html +++ /dev/null @@ -1,1590 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: Select ‹**S, SS, S**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: Select ‹S, SS, S›#

-

Type parameters#

-

▪ S

-

▪ SS

-

▪ S

-

Hierarchy#

- -

↳ Select

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Object literals#

- -

Constructors#

-

constructor#

-

+ new Select(props: SelectProps): Select

-

Overrides PageLayout.constructor

-

Defined in src/renderer/components/select/select.tsx:61

-

Parameters:

- - - - - - - - - - - - - -
NameType
propsSelectProps
-

Returns: Select

-

Properties#

-

context#

-

• context: any

-

Inherited from PageLayout.context

-

Defined in node_modules/@types/react/index.d.ts:473

-

If using the new style context, re-declare this in your class to be the -React.ContextType of your static contextType. -Should be used with type annotation or static contextType.

-
static contextType = MyContext
-// For TS pre-3.7:
-context!: React.ContextType<typeof MyContext>
-// For TS 3.7 and above:
-declare context: React.ContextType<typeof MyContext>
-
-

see https://reactjs.org/docs/context.html

-
-

props#

-

• props: Readonly‹SelectProps› & Readonly‹object›

-

Inherited from PageLayout.props

-

Defined in node_modules/@types/react/index.d.ts:498

-
-

refs#

-

• refs: object

-

Inherited from PageLayout.refs

-

Defined in node_modules/@types/react/index.d.ts:504

-

deprecated -https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

-

Type declaration:#

-
    -
  • [ key: string]: ReactInstance
    • -
-
-

state#

-

• state: Readonly‹S›

-

Inherited from PageLayout.state

-

Defined in node_modules/@types/react/index.d.ts:499

-
-

Static Optional contextType#

-

▪ contextType? : Context‹any›

-

Inherited from PageLayout.contextType

-

Defined in node_modules/@types/react/index.d.ts:455

-

If set, this.context will be set at runtime to the current value of the given Context.

-

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
-
-class Foo extends React.Component {
-  static contextType = Ctx
-  context!: React.ContextType<typeof Ctx>
-  render () {
-    return <>My context's value: {this.context}</>;
-  }
-}
-
-

see https://reactjs.org/docs/context.html#classcontexttype

-

Accessors#

-

options#

-

• get options(): SelectOption[]

-

Defined in src/renderer/components/select/select.tsx:97

-

Returns: SelectOption[]

-
-

selectedOption#

-

• get selectedOption(): SelectOption‹any› | SelectOption‹any›[]

-

Defined in src/renderer/components/select/select.tsx:83

-

Returns: SelectOption‹any› | SelectOption‹any›[]

-
-

theme#

-

• get theme(): "lens" | "dark" | "light" | "outlined" | DARK | LIGHT

-

Defined in src/renderer/components/select/select.tsx:68

-

Returns: "lens" | "dark" | "light" | "outlined" | DARK | LIGHT

-

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹SelectProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹SelectProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹SelectProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹SelectProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

Optional componentDidMount#

-

▸ componentDidMount(): void

-

Inherited from WizardLayout.componentDidMount

-

Defined in node_modules/@types/react/index.d.ts:619

-

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

-

Returns: void

-
-

Optional componentDidUpdate#

-

▸ componentDidUpdate(prevProps: Readonly‹SelectProps›, prevState: Readonly‹S›, snapshot?: SS): void

-

Inherited from PageLayout.componentDidUpdate

-

Defined in node_modules/@types/react/index.d.ts:682

-

Called immediately after updating occurs. Not called for the initial render.

-

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹SelectProps›
prevStateReadonly‹S›
snapshot?SS
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹SelectProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹SelectProps›
nextContextany
-

Returns: void

-
-

Optional componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Inherited from WizardLayout.componentWillUnmount

-

Defined in node_modules/@types/react/index.d.ts:635

-

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as -cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹SelectProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹SelectProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

forceUpdate#

-

▸ forceUpdate(callback?: function): void

-

Inherited from PageLayout.forceUpdate

-

Defined in node_modules/@types/react/index.d.ts:490

-

Parameters:

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹SelectProps›, prevState: Readonly‹S›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹SelectProps›
prevStateReadonly‹S›
-

Returns: SS | null

-
-

Protected isValidOption#

-

▸ isValidOption(opt: SelectOption | any): boolean

-

Defined in src/renderer/components/select/select.tsx:79

-

Parameters:

- - - - - - - - - - - - - -
NameType
optSelectOption | any
-

Returns: boolean

-
-

onChange#

-

▸ onChange(value: SelectOption, meta: ActionMeta‹any›): void

-

Defined in src/renderer/components/select/select.tsx:110

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
valueSelectOption
metaActionMeta‹any›
-

Returns: void

-
-

onKeyDown#

-

▸ onKeyDown(evt: KeyboardEvent‹HTMLElement›): void

-

Defined in src/renderer/components/select/select.tsx:117

-

Parameters:

- - - - - - - - - - - - - -
NameType
evtKeyboardEvent‹HTMLElement›
-

Returns: void

-
-

render#

-

▸ render(): Element‹›

-

Overrides void

-

Defined in src/renderer/components/select/select.tsx:126

-

Returns: Element‹›

-
-

setState#

-

▸ setState‹K›(state: function | S | object, callback?: function): void

-

Inherited from PageLayout.setState

-

Defined in node_modules/@types/react/index.d.ts:485

-

Type parameters:

-

▪ K: keyof S

-

Parameters:

-

▪ state: function | S | object

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹SelectProps›, nextState: Readonly‹S›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹SelectProps›
nextStateReadonly‹S›
nextContextany
-

Returns: boolean

-

Object literals#

-

Static defaultProps#

-

▪ defaultProps: object#

-

Defined in src/renderer/components/select/select.tsx:57

-

autoConvertOptions#

-

• autoConvertOptions: true = true

-

Defined in src/renderer/components/select/select.tsx:58

- -

• menuPlacement: "auto" = "auto"

-

Defined in src/renderer/components/select/select.tsx:60

- -

• menuPortalTarget: HTMLElement = document.body

-

Defined in src/renderer/components/select/select.tsx:59

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.slider/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.slider/index.html deleted file mode 100644 index df483cd6cc..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.slider/index.html +++ /dev/null @@ -1,1405 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: Slider ‹**S, SS, S**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: Slider ‹S, SS, S›#

-

Type parameters#

-

▪ S

-

▪ SS

-

▪ S

-

Hierarchy#

- -

↳ Slider

-

Index#

-

Constructors#

- -

Properties#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new Slider(props: Readonly‹SliderProps› | SliderProps): Slider

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:473

-

Parameters:

- - - - - - - - - - - - - -
NameType
propsReadonly‹SliderProps› | SliderProps
-

Returns: Slider

-

+ new Slider(props: SliderProps, context: any): Slider

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:475

-

deprecated

-

see https://reactjs.org/docs/legacy-context.html

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
propsSliderProps
contextany
-

Returns: Slider

-

Properties#

-

context#

-

• context: any

-

Inherited from PageLayout.context

-

Defined in node_modules/@types/react/index.d.ts:473

-

If using the new style context, re-declare this in your class to be the -React.ContextType of your static contextType. -Should be used with type annotation or static contextType.

-
static contextType = MyContext
-// For TS pre-3.7:
-context!: React.ContextType<typeof MyContext>
-// For TS 3.7 and above:
-declare context: React.ContextType<typeof MyContext>
-
-

see https://reactjs.org/docs/context.html

-
-

props#

-

• props: Readonly‹SliderProps› & Readonly‹object›

-

Inherited from PageLayout.props

-

Defined in node_modules/@types/react/index.d.ts:498

-
-

refs#

-

• refs: object

-

Inherited from PageLayout.refs

-

Defined in node_modules/@types/react/index.d.ts:504

-

deprecated -https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

-

Type declaration:#

-
    -
  • [ key: string]: ReactInstance
    • -
-
-

state#

-

• state: Readonly‹S›

-

Inherited from PageLayout.state

-

Defined in node_modules/@types/react/index.d.ts:499

-
-

Static Optional contextType#

-

▪ contextType? : Context‹any›

-

Inherited from PageLayout.contextType

-

Defined in node_modules/@types/react/index.d.ts:455

-

If set, this.context will be set at runtime to the current value of the given Context.

-

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
-
-class Foo extends React.Component {
-  static contextType = Ctx
-  context!: React.ContextType<typeof Ctx>
-  render () {
-    return <>My context's value: {this.context}</>;
-  }
-}
-
-

see https://reactjs.org/docs/context.html#classcontexttype

-
-

Static defaultProps#

-

▪ defaultProps: object = defaultProps as object

-

Defined in src/renderer/components/slider/slider.tsx:42

-

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹SliderProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹SliderProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹SliderProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹SliderProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

Optional componentDidMount#

-

▸ componentDidMount(): void

-

Inherited from WizardLayout.componentDidMount

-

Defined in node_modules/@types/react/index.d.ts:619

-

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

-

Returns: void

-
-

Optional componentDidUpdate#

-

▸ componentDidUpdate(prevProps: Readonly‹SliderProps›, prevState: Readonly‹S›, snapshot?: SS): void

-

Inherited from PageLayout.componentDidUpdate

-

Defined in node_modules/@types/react/index.d.ts:682

-

Called immediately after updating occurs. Not called for the initial render.

-

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹SliderProps›
prevStateReadonly‹S›
snapshot?SS
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹SliderProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹SliderProps›
nextContextany
-

Returns: void

-
-

Optional componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Inherited from WizardLayout.componentWillUnmount

-

Defined in node_modules/@types/react/index.d.ts:635

-

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as -cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹SliderProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹SliderProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

forceUpdate#

-

▸ forceUpdate(callback?: function): void

-

Inherited from PageLayout.forceUpdate

-

Defined in node_modules/@types/react/index.d.ts:490

-

Parameters:

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹SliderProps›, prevState: Readonly‹S›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹SliderProps›
prevStateReadonly‹S›
-

Returns: SS | null

-
-

render#

-

▸ render(): Element‹›

-

Overrides void

-

Defined in src/renderer/components/slider/slider.tsx:51

-

Returns: Element‹›

-
-

setState#

-

▸ setState‹K›(state: function | S | object, callback?: function): void

-

Inherited from PageLayout.setState

-

Defined in node_modules/@types/react/index.d.ts:485

-

Type parameters:

-

▪ K: keyof S

-

Parameters:

-

▪ state: function | S | object

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹SliderProps›, nextState: Readonly‹S›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹SliderProps›
nextStateReadonly‹S›
nextContextany
-

Returns: boolean

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.spinner/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.spinner/index.html deleted file mode 100644 index 86077d8485..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.spinner/index.html +++ /dev/null @@ -1,1453 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: Spinner ‹**SS**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: Spinner ‹SS›#

-

Type parameters#

-

▪ SS

-

Hierarchy#

- -

↳ Spinner

-

Index#

-

Constructors#

- -

Properties#

- -

Methods#

- -

Object literals#

- -

Constructors#

-

constructor#

-

+ new Spinner(props: Readonly‹SpinnerProps› | SpinnerProps): Spinner

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:473

-

Parameters:

- - - - - - - - - - - - - -
NameType
propsReadonly‹SpinnerProps› | SpinnerProps
-

Returns: Spinner

-

+ new Spinner(props: SpinnerProps, context: any): Spinner

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:475

-

deprecated

-

see https://reactjs.org/docs/legacy-context.html

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
propsSpinnerProps
contextany
-

Returns: Spinner

-

Properties#

-

context#

-

• context: any

-

Inherited from PageLayout.context

-

Defined in node_modules/@types/react/index.d.ts:473

-

If using the new style context, re-declare this in your class to be the -React.ContextType of your static contextType. -Should be used with type annotation or static contextType.

-
static contextType = MyContext
-// For TS pre-3.7:
-context!: React.ContextType<typeof MyContext>
-// For TS 3.7 and above:
-declare context: React.ContextType<typeof MyContext>
-
-

see https://reactjs.org/docs/context.html

-
-

props#

-

• props: Readonly‹SpinnerProps› & Readonly‹object›

-

Inherited from PageLayout.props

-

Defined in node_modules/@types/react/index.d.ts:498

-
-

refs#

-

• refs: object

-

Inherited from PageLayout.refs

-

Defined in node_modules/@types/react/index.d.ts:504

-

deprecated -https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

-

Type declaration:#

-
    -
  • [ key: string]: ReactInstance
    • -
-
-

state#

-

• state: Readonly‹object›

-

Inherited from PageLayout.state

-

Defined in node_modules/@types/react/index.d.ts:499

-
-

Static Optional contextType#

-

▪ contextType? : Context‹any›

-

Inherited from PageLayout.contextType

-

Defined in node_modules/@types/react/index.d.ts:455

-

If set, this.context will be set at runtime to the current value of the given Context.

-

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
-
-class Foo extends React.Component {
-  static contextType = Ctx
-  context!: React.ContextType<typeof Ctx>
-  render () {
-    return <>My context's value: {this.context}</>;
-  }
-}
-
-

see https://reactjs.org/docs/context.html#classcontexttype

-

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹SpinnerProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹SpinnerProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹SpinnerProps›, nextState: Readonly‹object›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹SpinnerProps›
nextStateReadonly‹object›
nextContextany
-

Returns: void

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

Optional componentDidMount#

-

▸ componentDidMount(): void

-

Inherited from WizardLayout.componentDidMount

-

Defined in node_modules/@types/react/index.d.ts:619

-

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

-

Returns: void

-
-

Optional componentDidUpdate#

-

▸ componentDidUpdate(prevProps: Readonly‹SpinnerProps›, prevState: Readonly‹object›, snapshot?: SS): void

-

Inherited from PageLayout.componentDidUpdate

-

Defined in node_modules/@types/react/index.d.ts:682

-

Called immediately after updating occurs. Not called for the initial render.

-

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹SpinnerProps›
prevStateReadonly‹object›
snapshot?SS
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹SpinnerProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹SpinnerProps›
nextContextany
-

Returns: void

-
-

Optional componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Inherited from WizardLayout.componentWillUnmount

-

Defined in node_modules/@types/react/index.d.ts:635

-

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as -cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹SpinnerProps›, nextState: Readonly‹object›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹SpinnerProps›
nextStateReadonly‹object›
nextContextany
-

Returns: void

-
-

forceUpdate#

-

▸ forceUpdate(callback?: function): void

-

Inherited from PageLayout.forceUpdate

-

Defined in node_modules/@types/react/index.d.ts:490

-

Parameters:

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹SpinnerProps›, prevState: Readonly‹object›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹SpinnerProps›
prevStateReadonly‹object›
-

Returns: SS | null

-
-

render#

-

▸ render(): Element‹›

-

Overrides void

-

Defined in src/renderer/components/spinner/spinner.tsx:38

-

Returns: Element‹›

-
-

setState#

-

▸ setState‹K›(state: function | S | object, callback?: function): void

-

Inherited from PageLayout.setState

-

Defined in node_modules/@types/react/index.d.ts:485

-

Type parameters:

-

▪ K: keyof object

-

Parameters:

-

▪ state: function | S | object

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹SpinnerProps›, nextState: Readonly‹object›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹SpinnerProps›
nextStateReadonly‹object›
nextContextany
-

Returns: boolean

-

Object literals#

-

Static defaultProps#

-

▪ defaultProps: object#

-

Defined in src/renderer/components/spinner/spinner.tsx:33

-

center#

-

• center: boolean = false

-

Defined in src/renderer/components/spinner/spinner.tsx:35

-

singleColor#

-

• singleColor: boolean = true

-

Defined in src/renderer/components/spinner/spinner.tsx:34

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.statusbrick/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.statusbrick/index.html deleted file mode 100644 index 4895e5dc84..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.statusbrick/index.html +++ /dev/null @@ -1,1393 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: StatusBrick ‹**S, SS, S**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: StatusBrick ‹S, SS, S›#

-

Type parameters#

-

▪ S

-

▪ SS

-

▪ S

-

Hierarchy#

- -

↳ StatusBrick

-

Index#

-

Constructors#

- -

Properties#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new StatusBrick(props: Readonly‹StatusBrickProps› | StatusBrickProps): StatusBrick

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:473

-

Parameters:

- - - - - - - - - - - - - -
NameType
propsReadonly‹StatusBrickProps› | StatusBrickProps
-

Returns: StatusBrick

-

+ new StatusBrick(props: StatusBrickProps, context: any): StatusBrick

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:475

-

deprecated

-

see https://reactjs.org/docs/legacy-context.html

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
propsStatusBrickProps
contextany
-

Returns: StatusBrick

-

Properties#

-

context#

-

• context: any

-

Inherited from PageLayout.context

-

Defined in node_modules/@types/react/index.d.ts:473

-

If using the new style context, re-declare this in your class to be the -React.ContextType of your static contextType. -Should be used with type annotation or static contextType.

-
static contextType = MyContext
-// For TS pre-3.7:
-context!: React.ContextType<typeof MyContext>
-// For TS 3.7 and above:
-declare context: React.ContextType<typeof MyContext>
-
-

see https://reactjs.org/docs/context.html

-
-

props#

-

• props: Readonly‹StatusBrickProps› & Readonly‹object›

-

Inherited from PageLayout.props

-

Defined in node_modules/@types/react/index.d.ts:498

-
-

refs#

-

• refs: object

-

Inherited from PageLayout.refs

-

Defined in node_modules/@types/react/index.d.ts:504

-

deprecated -https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

-

Type declaration:#

-
    -
  • [ key: string]: ReactInstance
    • -
-
-

state#

-

• state: Readonly‹S›

-

Inherited from PageLayout.state

-

Defined in node_modules/@types/react/index.d.ts:499

-
-

Static Optional contextType#

-

▪ contextType? : Context‹any›

-

Inherited from PageLayout.contextType

-

Defined in node_modules/@types/react/index.d.ts:455

-

If set, this.context will be set at runtime to the current value of the given Context.

-

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
-
-class Foo extends React.Component {
-  static contextType = Ctx
-  context!: React.ContextType<typeof Ctx>
-  render () {
-    return <>My context's value: {this.context}</>;
-  }
-}
-
-

see https://reactjs.org/docs/context.html#classcontexttype

-

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹StatusBrickProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹StatusBrickProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹StatusBrickProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹StatusBrickProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

Optional componentDidMount#

-

▸ componentDidMount(): void

-

Inherited from WizardLayout.componentDidMount

-

Defined in node_modules/@types/react/index.d.ts:619

-

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

-

Returns: void

-
-

Optional componentDidUpdate#

-

▸ componentDidUpdate(prevProps: Readonly‹StatusBrickProps›, prevState: Readonly‹S›, snapshot?: SS): void

-

Inherited from PageLayout.componentDidUpdate

-

Defined in node_modules/@types/react/index.d.ts:682

-

Called immediately after updating occurs. Not called for the initial render.

-

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹StatusBrickProps›
prevStateReadonly‹S›
snapshot?SS
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹StatusBrickProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹StatusBrickProps›
nextContextany
-

Returns: void

-
-

Optional componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Inherited from WizardLayout.componentWillUnmount

-

Defined in node_modules/@types/react/index.d.ts:635

-

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as -cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹StatusBrickProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹StatusBrickProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

forceUpdate#

-

▸ forceUpdate(callback?: function): void

-

Inherited from PageLayout.forceUpdate

-

Defined in node_modules/@types/react/index.d.ts:490

-

Parameters:

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹StatusBrickProps›, prevState: Readonly‹S›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹StatusBrickProps›
prevStateReadonly‹S›
-

Returns: SS | null

-
-

render#

-

▸ render(): Element‹›

-

Overrides void

-

Defined in src/renderer/components/status-brick/status-brick.tsx:33

-

Returns: Element‹›

-
-

setState#

-

▸ setState‹K›(state: function | S | object, callback?: function): void

-

Inherited from PageLayout.setState

-

Defined in node_modules/@types/react/index.d.ts:485

-

Type parameters:

-

▪ K: keyof S

-

Parameters:

-

▪ state: function | S | object

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹StatusBrickProps›, nextState: Readonly‹S›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹StatusBrickProps›
nextStateReadonly‹S›
nextContextany
-

Returns: boolean

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.stepper/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.stepper/index.html deleted file mode 100644 index fe3ee849d3..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.stepper/index.html +++ /dev/null @@ -1,1391 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: Stepper ‹**SS**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: Stepper ‹SS›#

-

Type parameters#

-

▪ SS

-

Hierarchy#

- -

↳ Stepper

-

Index#

-

Constructors#

- -

Properties#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new Stepper(props: Readonly‹StepperProps› | StepperProps): Stepper

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:473

-

Parameters:

- - - - - - - - - - - - - -
NameType
propsReadonly‹StepperProps› | StepperProps
-

Returns: Stepper

-

+ new Stepper(props: StepperProps, context: any): Stepper

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:475

-

deprecated

-

see https://reactjs.org/docs/legacy-context.html

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
propsStepperProps
contextany
-

Returns: Stepper

-

Properties#

-

context#

-

• context: any

-

Inherited from PageLayout.context

-

Defined in node_modules/@types/react/index.d.ts:473

-

If using the new style context, re-declare this in your class to be the -React.ContextType of your static contextType. -Should be used with type annotation or static contextType.

-
static contextType = MyContext
-// For TS pre-3.7:
-context!: React.ContextType<typeof MyContext>
-// For TS 3.7 and above:
-declare context: React.ContextType<typeof MyContext>
-
-

see https://reactjs.org/docs/context.html

-
-

props#

-

• props: Readonly‹StepperProps› & Readonly‹object›

-

Inherited from PageLayout.props

-

Defined in node_modules/@types/react/index.d.ts:498

-
-

refs#

-

• refs: object

-

Inherited from PageLayout.refs

-

Defined in node_modules/@types/react/index.d.ts:504

-

deprecated -https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

-

Type declaration:#

-
    -
  • [ key: string]: ReactInstance
    • -
-
-

state#

-

• state: Readonly‹object›

-

Inherited from PageLayout.state

-

Defined in node_modules/@types/react/index.d.ts:499

-
-

Static Optional contextType#

-

▪ contextType? : Context‹any›

-

Inherited from PageLayout.contextType

-

Defined in node_modules/@types/react/index.d.ts:455

-

If set, this.context will be set at runtime to the current value of the given Context.

-

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
-
-class Foo extends React.Component {
-  static contextType = Ctx
-  context!: React.ContextType<typeof Ctx>
-  render () {
-    return <>My context's value: {this.context}</>;
-  }
-}
-
-

see https://reactjs.org/docs/context.html#classcontexttype

-

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹StepperProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹StepperProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹StepperProps›, nextState: Readonly‹object›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹StepperProps›
nextStateReadonly‹object›
nextContextany
-

Returns: void

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

Optional componentDidMount#

-

▸ componentDidMount(): void

-

Inherited from WizardLayout.componentDidMount

-

Defined in node_modules/@types/react/index.d.ts:619

-

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

-

Returns: void

-
-

Optional componentDidUpdate#

-

▸ componentDidUpdate(prevProps: Readonly‹StepperProps›, prevState: Readonly‹object›, snapshot?: SS): void

-

Inherited from PageLayout.componentDidUpdate

-

Defined in node_modules/@types/react/index.d.ts:682

-

Called immediately after updating occurs. Not called for the initial render.

-

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹StepperProps›
prevStateReadonly‹object›
snapshot?SS
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹StepperProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹StepperProps›
nextContextany
-

Returns: void

-
-

Optional componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Inherited from WizardLayout.componentWillUnmount

-

Defined in node_modules/@types/react/index.d.ts:635

-

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as -cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹StepperProps›, nextState: Readonly‹object›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹StepperProps›
nextStateReadonly‹object›
nextContextany
-

Returns: void

-
-

forceUpdate#

-

▸ forceUpdate(callback?: function): void

-

Inherited from PageLayout.forceUpdate

-

Defined in node_modules/@types/react/index.d.ts:490

-

Parameters:

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹StepperProps›, prevState: Readonly‹object›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹StepperProps›
prevStateReadonly‹object›
-

Returns: SS | null

-
-

render#

-

▸ render(): Element‹›

-

Overrides void

-

Defined in src/renderer/components/stepper/stepper.tsx:36

-

Returns: Element‹›

-
-

setState#

-

▸ setState‹K›(state: function | S | object, callback?: function): void

-

Inherited from PageLayout.setState

-

Defined in node_modules/@types/react/index.d.ts:485

-

Type parameters:

-

▪ K: keyof object

-

Parameters:

-

▪ state: function | S | object

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹StepperProps›, nextState: Readonly‹object›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹StepperProps›
nextStateReadonly‹object›
nextContextany
-

Returns: boolean

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.tab/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.tab/index.html deleted file mode 100644 index 4b774f371f..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.tab/index.html +++ /dev/null @@ -1,1391 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: Tab ‹**S, SS**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: Tab ‹S, SS›#

-

Type parameters#

-

▪ S

-

▪ SS

-

Hierarchy#

- -

↳ Tab

-

Index#

-

Properties#

- -

Accessors#

- -

Methods#

- -

Properties#

-

context#

-

• context: TabsContextValue

-

Defined in src/renderer/components/tabs/tabs.tsx:86

-
-

elem#

-

• elem: HTMLElement

-

Defined in src/renderer/components/tabs/tabs.tsx:87

-
-

Static contextType#

-

▪ contextType: Context‹TabsContextValue‹any›› = TabsContext

-

Defined in src/renderer/components/tabs/tabs.tsx:85

-

Accessors#

-

isActive#

-

• get isActive(): boolean

-

Defined in src/renderer/components/tabs/tabs.tsx:89

-

Returns: boolean

-

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹TabProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹TabProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹TabProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹TabProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

Protected bindRef#

-

▸ bindRef(elem: HTMLElement): void

-

Defined in src/renderer/components/tabs/tabs.tsx:142

-

Parameters:

- - - - - - - - - - - - - -
NameType
elemHTMLElement
-

Returns: void

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

componentDidMount#

-

▸ componentDidMount(): void

-

Overrides WizardLayout.componentDidMount

-

Defined in src/renderer/components/tabs/tabs.tsx:135

-

Returns: void

-
-

Optional componentDidUpdate#

-

▸ componentDidUpdate(prevProps: Readonly‹TabProps›, prevState: Readonly‹S›, snapshot?: SS): void

-

Inherited from PageLayout.componentDidUpdate

-

Defined in node_modules/@types/react/index.d.ts:682

-

Called immediately after updating occurs. Not called for the initial render.

-

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹TabProps›
prevStateReadonly‹S›
snapshot?SS
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹TabProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹TabProps›
nextContextany
-

Returns: void

-
-

Optional componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Inherited from WizardLayout.componentWillUnmount

-

Defined in node_modules/@types/react/index.d.ts:635

-

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as -cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹TabProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹TabProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

focus#

-

▸ focus(): void

-

Defined in src/renderer/components/tabs/tabs.tsx:95

-

Returns: void

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹TabProps›, prevState: Readonly‹S›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹TabProps›
prevStateReadonly‹S›
-

Returns: SS | null

-
-

onClick#

-

▸ onClick(evt: MouseEvent‹HTMLElement›): void

-

Defined in src/renderer/components/tabs/tabs.tsx:107

-

Parameters:

- - - - - - - - - - - - - -
NameType
evtMouseEvent‹HTMLElement›
-

Returns: void

-
-

onFocus#

-

▸ onFocus(evt: FocusEvent‹HTMLElement›): void

-

Defined in src/renderer/components/tabs/tabs.tsx:117

-

Parameters:

- - - - - - - - - - - - - -
NameType
evtFocusEvent‹HTMLElement›
-

Returns: void

-
-

onKeyDown#

-

▸ onKeyDown(evt: KeyboardEvent‹HTMLElement›): void

-

Defined in src/renderer/components/tabs/tabs.tsx:125

-

Parameters:

- - - - - - - - - - - - - -
NameType
evtKeyboardEvent‹HTMLElement›
-

Returns: void

-
-

render#

-

▸ render(): Element‹›

-

Defined in src/renderer/components/tabs/tabs.tsx:146

-

Returns: Element‹›

-
-

scrollIntoView#

-

▸ scrollIntoView(): void

-

Defined in src/renderer/components/tabs/tabs.tsx:99

-

Returns: void

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹TabProps›, nextState: Readonly‹S›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹TabProps›
nextStateReadonly‹S›
nextContextany
-

Returns: boolean

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.table/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.table/index.html deleted file mode 100644 index 4a275da198..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.table/index.html +++ /dev/null @@ -1,1610 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: Table ‹**S, SS, S**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: Table ‹S, SS, S›#

-

Type parameters#

-

▪ S

-

▪ SS

-

▪ S

-

Hierarchy#

- -

↳ Table

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Object literals#

- -

Constructors#

-

constructor#

-

+ new Table(props: TableProps): Table

-

Overrides PageLayout.constructor

-

Defined in src/renderer/components/table/table.tsx:84

-

Parameters:

- - - - - - - - - - - - - -
NameType
propsTableProps
-

Returns: Table

-

Properties#

-

context#

-

• context: any

-

Inherited from PageLayout.context

-

Defined in node_modules/@types/react/index.d.ts:473

-

If using the new style context, re-declare this in your class to be the -React.ContextType of your static contextType. -Should be used with type annotation or static contextType.

-
static contextType = MyContext
-// For TS pre-3.7:
-context!: React.ContextType<typeof MyContext>
-// For TS 3.7 and above:
-declare context: React.ContextType<typeof MyContext>
-
-

see https://reactjs.org/docs/context.html

-
-

props#

-

• props: Readonly‹TableProps› & Readonly‹object›

-

Inherited from PageLayout.props

-

Defined in node_modules/@types/react/index.d.ts:498

-
-

refs#

-

• refs: object

-

Inherited from PageLayout.refs

-

Defined in node_modules/@types/react/index.d.ts:504

-

deprecated -https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

-

Type declaration:#

-
    -
  • [ key: string]: ReactInstance
    • -
-
-

state#

-

• state: Readonly‹S›

-

Inherited from PageLayout.state

-

Defined in node_modules/@types/react/index.d.ts:499

-
-

Static Optional contextType#

-

▪ contextType? : Context‹any›

-

Inherited from PageLayout.contextType

-

Defined in node_modules/@types/react/index.d.ts:455

-

If set, this.context will be set at runtime to the current value of the given Context.

-

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
-
-class Foo extends React.Component {
-  static contextType = Ctx
-  context!: React.ContextType<typeof Ctx>
-  render () {
-    return <>My context's value: {this.context}</>;
-  }
-}
-
-

see https://reactjs.org/docs/context.html#classcontexttype

-

Accessors#

-

sortParams#

-

• get sortParams(): object

-

Defined in src/renderer/components/table/table.tsx:99

-

Returns: object

-

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹TableProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹TableProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹TableProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹TableProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

componentDidMount#

-

▸ componentDidMount(): void

-

Overrides WizardLayout.componentDidMount

-

Defined in src/renderer/components/table/table.tsx:91

-

Returns: void

-
-

Optional componentDidUpdate#

-

▸ componentDidUpdate(prevProps: Readonly‹TableProps›, prevState: Readonly‹S›, snapshot?: SS): void

-

Inherited from PageLayout.componentDidUpdate

-

Defined in node_modules/@types/react/index.d.ts:682

-

Called immediately after updating occurs. Not called for the initial render.

-

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹TableProps›
prevStateReadonly‹S›
snapshot?SS
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹TableProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹TableProps›
nextContextany
-

Returns: void

-
-

Optional componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Inherited from WizardLayout.componentWillUnmount

-

Defined in node_modules/@types/react/index.d.ts:635

-

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as -cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹TableProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹TableProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

forceUpdate#

-

▸ forceUpdate(callback?: function): void

-

Inherited from PageLayout.forceUpdate

-

Defined in node_modules/@types/react/index.d.ts:490

-

Parameters:

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹TableProps›, prevState: Readonly‹S›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹TableProps›
prevStateReadonly‹S›
-

Returns: SS | null

-
-

getSorted#

-

▸ getSorted(items: any[]): any[]

-

Defined in src/renderer/components/table/table.tsx:139

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsany[]
-

Returns: any[]

-
-

Protected onSort#

-

▸ onSort(__namedParameters: object): void

-

Defined in src/renderer/components/table/table.tsx:147

-

Parameters:

-

▪ __namedParameters: object

- - - - - - - - - - - - - - - - - -
NameType
orderBystring
sortBystring
-

Returns: void

-
-

render#

-

▸ render(): Element‹›

-

Overrides void

-

Defined in src/renderer/components/table/table.tsx:219

-

Returns: Element‹›

-
-

renderHead#

-

▸ renderHead(): ReactElement‹TableHeadProps‹›, string | function | object›

-

Defined in src/renderer/components/table/table.tsx:103

-

Returns: ReactElement‹TableHeadProps‹›, string | function | object›

-
-

renderRows#

-

▸ renderRows(): object

-

Defined in src/renderer/components/table/table.tsx:174

-

Returns: object

-
-

setState#

-

▸ setState‹K›(state: function | S | object, callback?: function): void

-

Inherited from PageLayout.setState

-

Defined in node_modules/@types/react/index.d.ts:485

-

Type parameters:

-

▪ K: keyof S

-

Parameters:

-

▪ state: function | S | object

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹TableProps›, nextState: Readonly‹S›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹TableProps›
nextStateReadonly‹S›
nextContextany
-

Returns: boolean

-
-

sort#

-

▸ sort(colName: TableSortBy): void

-

Defined in src/renderer/components/table/table.tsx:162

-

Parameters:

- - - - - - - - - - - - - -
NameType
colNameTableSortBy
-

Returns: void

-

Object literals#

-

Static defaultProps#

-

▪ defaultProps: object#

-

Defined in src/renderer/components/table/table.tsx:78

-

autoSize#

-

• autoSize: true = true

-

Defined in src/renderer/components/table/table.tsx:80

-

rowLineHeight#

-

• rowLineHeight: string = "17px"

-

Defined in src/renderer/components/table/table.tsx:82

-

rowPadding#

-

• rowPadding: string = "8px"

-

Defined in src/renderer/components/table/table.tsx:81

-

scrollable#

-

• scrollable: true = true

-

Defined in src/renderer/components/table/table.tsx:79

-

sortSyncWithUrl#

-

• sortSyncWithUrl: true = true

-

Defined in src/renderer/components/table/table.tsx:83

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.tablehead/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.tablehead/index.html deleted file mode 100644 index a1c22418aa..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.tablehead/index.html +++ /dev/null @@ -1,1445 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: TableHead ‹**S, SS, S**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: TableHead ‹S, SS, S›#

-

Type parameters#

-

▪ S

-

▪ SS

-

▪ S

-

Hierarchy#

- -

↳ TableHead

-

Index#

-

Constructors#

- -

Properties#

- -

Methods#

- -

Object literals#

- -

Constructors#

-

constructor#

-

+ new TableHead(props: Readonly‹TableHeadProps› | TableHeadProps): TableHead

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:473

-

Parameters:

- - - - - - - - - - - - - -
NameType
propsReadonly‹TableHeadProps› | TableHeadProps
-

Returns: TableHead

-

+ new TableHead(props: TableHeadProps, context: any): TableHead

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:475

-

deprecated

-

see https://reactjs.org/docs/legacy-context.html

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
propsTableHeadProps
contextany
-

Returns: TableHead

-

Properties#

-

context#

-

• context: any

-

Inherited from PageLayout.context

-

Defined in node_modules/@types/react/index.d.ts:473

-

If using the new style context, re-declare this in your class to be the -React.ContextType of your static contextType. -Should be used with type annotation or static contextType.

-
static contextType = MyContext
-// For TS pre-3.7:
-context!: React.ContextType<typeof MyContext>
-// For TS 3.7 and above:
-declare context: React.ContextType<typeof MyContext>
-
-

see https://reactjs.org/docs/context.html

-
-

props#

-

• props: Readonly‹TableHeadProps› & Readonly‹object›

-

Inherited from PageLayout.props

-

Defined in node_modules/@types/react/index.d.ts:498

-
-

refs#

-

• refs: object

-

Inherited from PageLayout.refs

-

Defined in node_modules/@types/react/index.d.ts:504

-

deprecated -https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

-

Type declaration:#

-
    -
  • [ key: string]: ReactInstance
    • -
-
-

state#

-

• state: Readonly‹S›

-

Inherited from PageLayout.state

-

Defined in node_modules/@types/react/index.d.ts:499

-
-

Static Optional contextType#

-

▪ contextType? : Context‹any›

-

Inherited from PageLayout.contextType

-

Defined in node_modules/@types/react/index.d.ts:455

-

If set, this.context will be set at runtime to the current value of the given Context.

-

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
-
-class Foo extends React.Component {
-  static contextType = Ctx
-  context!: React.ContextType<typeof Ctx>
-  render () {
-    return <>My context's value: {this.context}</>;
-  }
-}
-
-

see https://reactjs.org/docs/context.html#classcontexttype

-

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹TableHeadProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹TableHeadProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹TableHeadProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹TableHeadProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

Optional componentDidMount#

-

▸ componentDidMount(): void

-

Inherited from WizardLayout.componentDidMount

-

Defined in node_modules/@types/react/index.d.ts:619

-

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

-

Returns: void

-
-

Optional componentDidUpdate#

-

▸ componentDidUpdate(prevProps: Readonly‹TableHeadProps›, prevState: Readonly‹S›, snapshot?: SS): void

-

Inherited from PageLayout.componentDidUpdate

-

Defined in node_modules/@types/react/index.d.ts:682

-

Called immediately after updating occurs. Not called for the initial render.

-

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹TableHeadProps›
prevStateReadonly‹S›
snapshot?SS
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹TableHeadProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹TableHeadProps›
nextContextany
-

Returns: void

-
-

Optional componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Inherited from WizardLayout.componentWillUnmount

-

Defined in node_modules/@types/react/index.d.ts:635

-

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as -cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹TableHeadProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹TableHeadProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

forceUpdate#

-

▸ forceUpdate(callback?: function): void

-

Inherited from PageLayout.forceUpdate

-

Defined in node_modules/@types/react/index.d.ts:490

-

Parameters:

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹TableHeadProps›, prevState: Readonly‹S›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹TableHeadProps›
prevStateReadonly‹S›
-

Returns: SS | null

-
-

render#

-

▸ render(): Element‹›

-

Overrides void

-

Defined in src/renderer/components/table/table-head.tsx:41

-

Returns: Element‹›

-
-

setState#

-

▸ setState‹K›(state: function | S | object, callback?: function): void

-

Inherited from PageLayout.setState

-

Defined in node_modules/@types/react/index.d.ts:485

-

Type parameters:

-

▪ K: keyof S

-

Parameters:

-

▪ state: function | S | object

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹TableHeadProps›, nextState: Readonly‹S›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹TableHeadProps›
nextStateReadonly‹S›
nextContextany
-

Returns: boolean

-

Object literals#

-

Static defaultProps#

-

▪ defaultProps: object#

-

Defined in src/renderer/components/table/table-head.tsx:37

-

sticky#

-

• sticky: true = true

-

Defined in src/renderer/components/table/table-head.tsx:38

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.tablerow/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.tablerow/index.html deleted file mode 100644 index f053ca69ce..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.tablerow/index.html +++ /dev/null @@ -1,1393 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: TableRow ‹**S, SS, S**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: TableRow ‹S, SS, S›#

-

Type parameters#

-

▪ S

-

▪ SS

-

▪ S

-

Hierarchy#

- -

↳ TableRow

-

Index#

-

Constructors#

- -

Properties#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new TableRow(props: Readonly‹TableRowProps› | TableRowProps): TableRow

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:473

-

Parameters:

- - - - - - - - - - - - - -
NameType
propsReadonly‹TableRowProps› | TableRowProps
-

Returns: TableRow

-

+ new TableRow(props: TableRowProps, context: any): TableRow

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:475

-

deprecated

-

see https://reactjs.org/docs/legacy-context.html

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
propsTableRowProps
contextany
-

Returns: TableRow

-

Properties#

-

context#

-

• context: any

-

Inherited from PageLayout.context

-

Defined in node_modules/@types/react/index.d.ts:473

-

If using the new style context, re-declare this in your class to be the -React.ContextType of your static contextType. -Should be used with type annotation or static contextType.

-
static contextType = MyContext
-// For TS pre-3.7:
-context!: React.ContextType<typeof MyContext>
-// For TS 3.7 and above:
-declare context: React.ContextType<typeof MyContext>
-
-

see https://reactjs.org/docs/context.html

-
-

props#

-

• props: Readonly‹TableRowProps› & Readonly‹object›

-

Inherited from PageLayout.props

-

Defined in node_modules/@types/react/index.d.ts:498

-
-

refs#

-

• refs: object

-

Inherited from PageLayout.refs

-

Defined in node_modules/@types/react/index.d.ts:504

-

deprecated -https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

-

Type declaration:#

-
    -
  • [ key: string]: ReactInstance
    • -
-
-

state#

-

• state: Readonly‹S›

-

Inherited from PageLayout.state

-

Defined in node_modules/@types/react/index.d.ts:499

-
-

Static Optional contextType#

-

▪ contextType? : Context‹any›

-

Inherited from PageLayout.contextType

-

Defined in node_modules/@types/react/index.d.ts:455

-

If set, this.context will be set at runtime to the current value of the given Context.

-

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
-
-class Foo extends React.Component {
-  static contextType = Ctx
-  context!: React.ContextType<typeof Ctx>
-  render () {
-    return <>My context's value: {this.context}</>;
-  }
-}
-
-

see https://reactjs.org/docs/context.html#classcontexttype

-

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹TableRowProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹TableRowProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹TableRowProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹TableRowProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

Optional componentDidMount#

-

▸ componentDidMount(): void

-

Inherited from WizardLayout.componentDidMount

-

Defined in node_modules/@types/react/index.d.ts:619

-

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

-

Returns: void

-
-

Optional componentDidUpdate#

-

▸ componentDidUpdate(prevProps: Readonly‹TableRowProps›, prevState: Readonly‹S›, snapshot?: SS): void

-

Inherited from PageLayout.componentDidUpdate

-

Defined in node_modules/@types/react/index.d.ts:682

-

Called immediately after updating occurs. Not called for the initial render.

-

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹TableRowProps›
prevStateReadonly‹S›
snapshot?SS
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹TableRowProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹TableRowProps›
nextContextany
-

Returns: void

-
-

Optional componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Inherited from WizardLayout.componentWillUnmount

-

Defined in node_modules/@types/react/index.d.ts:635

-

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as -cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹TableRowProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹TableRowProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

forceUpdate#

-

▸ forceUpdate(callback?: function): void

-

Inherited from PageLayout.forceUpdate

-

Defined in node_modules/@types/react/index.d.ts:490

-

Parameters:

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹TableRowProps›, prevState: Readonly‹S›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹TableRowProps›
prevStateReadonly‹S›
-

Returns: SS | null

-
-

render#

-

▸ render(): Element‹›

-

Overrides void

-

Defined in src/renderer/components/table/table-row.tsx:41

-

Returns: Element‹›

-
-

setState#

-

▸ setState‹K›(state: function | S | object, callback?: function): void

-

Inherited from PageLayout.setState

-

Defined in node_modules/@types/react/index.d.ts:485

-

Type parameters:

-

▪ K: keyof S

-

Parameters:

-

▪ state: function | S | object

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹TableRowProps›, nextState: Readonly‹S›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹TableRowProps›
nextStateReadonly‹S›
nextContextany
-

Returns: boolean

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.tabs/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.tabs/index.html deleted file mode 100644 index 9af1c953d6..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.tabs/index.html +++ /dev/null @@ -1,1222 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: Tabs ‹**S, SS**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: Tabs ‹S, SS›#

-

Type parameters#

-

▪ S

-

▪ SS

-

Hierarchy#

- -

↳ Tabs

-

Index#

-

Properties#

- -

Methods#

- -

Properties#

-

elem#

-

• elem: HTMLElement

-

Defined in src/renderer/components/tabs/tabs.tsx:46

-

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹TabsProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹TabsProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹TabsProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹TabsProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

Protected bindRef#

-

▸ bindRef(elem: HTMLElement): void

-

Defined in src/renderer/components/tabs/tabs.tsx:49

-

Parameters:

- - - - - - - - - - - - - -
NameType
elemHTMLElement
-

Returns: void

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

Optional componentDidMount#

-

▸ componentDidMount(): void

-

Inherited from WizardLayout.componentDidMount

-

Defined in node_modules/@types/react/index.d.ts:619

-

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

-

Returns: void

-
-

Optional componentDidUpdate#

-

▸ componentDidUpdate(prevProps: Readonly‹TabsProps›, prevState: Readonly‹S›, snapshot?: SS): void

-

Inherited from PageLayout.componentDidUpdate

-

Defined in node_modules/@types/react/index.d.ts:682

-

Called immediately after updating occurs. Not called for the initial render.

-

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹TabsProps›
prevStateReadonly‹S›
snapshot?SS
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹TabsProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹TabsProps›
nextContextany
-

Returns: void

-
-

Optional componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Inherited from WizardLayout.componentWillUnmount

-

Defined in node_modules/@types/react/index.d.ts:635

-

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as -cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹TabsProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹TabsProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹TabsProps›, prevState: Readonly‹S›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹TabsProps›
prevStateReadonly‹S›
-

Returns: SS | null

-
-

render#

-

▸ render(): Element‹›

-

Defined in src/renderer/components/tabs/tabs.tsx:53

-

Returns: Element‹›

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹TabsProps›, nextState: Readonly‹S›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹TabsProps›
nextStateReadonly‹S›
nextContextany
-

Returns: boolean

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.wizard/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.wizard/index.html deleted file mode 100644 index 4e32844232..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.wizard/index.html +++ /dev/null @@ -1,1604 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: Wizard ‹**SS**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: Wizard ‹SS›#

-

Type parameters#

-

▪ SS

-

Hierarchy#

- -

↳ Wizard

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Object literals#

- -

Constructors#

-

constructor#

-

+ new Wizard(props: Readonly‹WizardProps› | WizardProps): Wizard

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:473

-

Parameters:

- - - - - - - - - - - - - -
NameType
propsReadonly‹WizardProps› | WizardProps
-

Returns: Wizard

-

+ new Wizard(props: WizardProps, context: any): Wizard

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:475

-

deprecated

-

see https://reactjs.org/docs/legacy-context.html

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
propsWizardProps
contextany
-

Returns: Wizard

-

Properties#

-

context#

-

• context: any

-

Inherited from PageLayout.context

-

Defined in node_modules/@types/react/index.d.ts:473

-

If using the new style context, re-declare this in your class to be the -React.ContextType of your static contextType. -Should be used with type annotation or static contextType.

-
static contextType = MyContext
-// For TS pre-3.7:
-context!: React.ContextType<typeof MyContext>
-// For TS 3.7 and above:
-declare context: React.ContextType<typeof MyContext>
-
-

see https://reactjs.org/docs/context.html

-
-

props#

-

• props: Readonly‹WizardProps› & Readonly‹object›

-

Inherited from PageLayout.props

-

Defined in node_modules/@types/react/index.d.ts:498

-
-

refs#

-

• refs: object

-

Inherited from PageLayout.refs

-

Defined in node_modules/@types/react/index.d.ts:504

-

deprecated -https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

-

Type declaration:#

-
    -
  • [ key: string]: ReactInstance
    • -
-
-

Static Optional contextType#

-

▪ contextType? : Context‹any›

-

Inherited from PageLayout.contextType

-

Defined in node_modules/@types/react/index.d.ts:455

-

If set, this.context will be set at runtime to the current value of the given Context.

-

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
-
-class Foo extends React.Component {
-  static contextType = Ctx
-  context!: React.ContextType<typeof Ctx>
-  render () {
-    return <>My context's value: {this.context}</>;
-  }
-}
-
-

see https://reactjs.org/docs/context.html#classcontexttype

-

Accessors#

-

step#

-

• get step(): number

-

Defined in src/renderer/components/wizard/wizard.tsx:77

-

Returns: number

-

• set step(step: number): void

-

Defined in src/renderer/components/wizard/wizard.tsx:81

-

Parameters:

- - - - - - - - - - - - - -
NameType
stepnumber
-

Returns: void

-
-

steps#

-

• get steps(): ReactElement‹WizardStepProps‹any›, string | function | object›[]

-

Defined in src/renderer/components/wizard/wizard.tsx:55

-

Returns: ReactElement‹WizardStepProps‹any›, string | function | object›[]

-

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹WizardProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹WizardProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹WizardProps›, nextState: Readonly‹State›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹WizardProps›
nextStateReadonly‹State›
nextContextany
-

Returns: void

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

Optional componentDidMount#

-

▸ componentDidMount(): void

-

Inherited from WizardLayout.componentDidMount

-

Defined in node_modules/@types/react/index.d.ts:619

-

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

-

Returns: void

-
-

Optional componentDidUpdate#

-

▸ componentDidUpdate(prevProps: Readonly‹WizardProps›, prevState: Readonly‹State›, snapshot?: SS): void

-

Inherited from PageLayout.componentDidUpdate

-

Defined in node_modules/@types/react/index.d.ts:682

-

Called immediately after updating occurs. Not called for the initial render.

-

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹WizardProps›
prevStateReadonly‹State›
snapshot?SS
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹WizardProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹WizardProps›
nextContextany
-

Returns: void

-
-

Optional componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Inherited from WizardLayout.componentWillUnmount

-

Defined in node_modules/@types/react/index.d.ts:635

-

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as -cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹WizardProps›, nextState: Readonly‹State›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹WizardProps›
nextStateReadonly‹State›
nextContextany
-

Returns: void

-
-

firstStep#

-

▸ firstStep(): any

-

Defined in src/renderer/components/wizard/wizard.tsx:98

-

Returns: any

-
-

forceUpdate#

-

▸ forceUpdate(callback?: function): void

-

Inherited from PageLayout.forceUpdate

-

Defined in node_modules/@types/react/index.d.ts:490

-

Parameters:

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹WizardProps›, prevState: Readonly‹State›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹WizardProps›
prevStateReadonly‹State›
-

Returns: SS | null

-
-

Protected getValidStep#

-

▸ getValidStep(step: number): number

-

Defined in src/renderer/components/wizard/wizard.tsx:92

-

Parameters:

- - - - - - - - - - - - - -
NameType
stepnumber
-

Returns: number

-
-

isFirstStep#

-

▸ isFirstStep(): boolean

-

Defined in src/renderer/components/wizard/wizard.tsx:96

-

Returns: boolean

-
-

isLastStep#

-

▸ isLastStep(): boolean

-

Defined in src/renderer/components/wizard/wizard.tsx:97

-

Returns: boolean

-
-

lastStep#

-

▸ lastStep(): any

-

Defined in src/renderer/components/wizard/wizard.tsx:101

-

Returns: any

-
-

nextStep#

-

▸ nextStep(): any

-

Defined in src/renderer/components/wizard/wizard.tsx:99

-

Returns: any

-
-

prevStep#

-

▸ prevStep(): any

-

Defined in src/renderer/components/wizard/wizard.tsx:100

-

Returns: any

-
-

render#

-

▸ render(): Element‹›

-

Overrides void

-

Defined in src/renderer/components/wizard/wizard.tsx:103

-

Returns: Element‹›

-
-

setState#

-

▸ setState‹K›(state: function | S | object, callback?: function): void

-

Inherited from PageLayout.setState

-

Defined in node_modules/@types/react/index.d.ts:485

-

Type parameters:

-

▪ K: keyof State

-

Parameters:

-

▪ state: function | S | object

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹WizardProps›, nextState: Readonly‹State›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹WizardProps›
nextStateReadonly‹State›
nextContextany
-

Returns: boolean

-

Object literals#

-

state#

-

▪ state: object#

-

Overrides PageLayout.state

-

Defined in src/renderer/components/wizard/wizard.tsx:51

-

step#

-

• step: number = this.getValidStep(this.props.step)

-

Defined in src/renderer/components/wizard/wizard.tsx:52

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.wizardlayout/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.wizardlayout/index.html deleted file mode 100644 index 34bb7872cc..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.wizardlayout/index.html +++ /dev/null @@ -1,1393 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: WizardLayout ‹**S, SS, S**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: WizardLayout ‹S, SS, S›#

-

Type parameters#

-

▪ S

-

▪ SS

-

▪ S

-

Hierarchy#

- -

↳ WizardLayout

-

Index#

-

Constructors#

- -

Properties#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new WizardLayout(props: Readonly‹WizardLayoutProps› | WizardLayoutProps): WizardLayout

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:473

-

Parameters:

- - - - - - - - - - - - - -
NameType
propsReadonly‹WizardLayoutProps› | WizardLayoutProps
-

Returns: WizardLayout

-

+ new WizardLayout(props: WizardLayoutProps, context: any): WizardLayout

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:475

-

deprecated

-

see https://reactjs.org/docs/legacy-context.html

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
propsWizardLayoutProps
contextany
-

Returns: WizardLayout

-

Properties#

-

context#

-

• context: any

-

Inherited from PageLayout.context

-

Defined in node_modules/@types/react/index.d.ts:473

-

If using the new style context, re-declare this in your class to be the -React.ContextType of your static contextType. -Should be used with type annotation or static contextType.

-
static contextType = MyContext
-// For TS pre-3.7:
-context!: React.ContextType<typeof MyContext>
-// For TS 3.7 and above:
-declare context: React.ContextType<typeof MyContext>
-
-

see https://reactjs.org/docs/context.html

-
-

props#

-

• props: Readonly‹WizardLayoutProps› & Readonly‹object›

-

Inherited from PageLayout.props

-

Defined in node_modules/@types/react/index.d.ts:498

-
-

refs#

-

• refs: object

-

Inherited from PageLayout.refs

-

Defined in node_modules/@types/react/index.d.ts:504

-

deprecated -https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

-

Type declaration:#

-
    -
  • [ key: string]: ReactInstance
    • -
-
-

state#

-

• state: Readonly‹S›

-

Inherited from PageLayout.state

-

Defined in node_modules/@types/react/index.d.ts:499

-
-

Static Optional contextType#

-

▪ contextType? : Context‹any›

-

Inherited from PageLayout.contextType

-

Defined in node_modules/@types/react/index.d.ts:455

-

If set, this.context will be set at runtime to the current value of the given Context.

-

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
-
-class Foo extends React.Component {
-  static contextType = Ctx
-  context!: React.ContextType<typeof Ctx>
-  render () {
-    return <>My context's value: {this.context}</>;
-  }
-}
-
-

see https://reactjs.org/docs/context.html#classcontexttype

-

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹WizardLayoutProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹WizardLayoutProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹WizardLayoutProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹WizardLayoutProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

Optional componentDidMount#

-

▸ componentDidMount(): void

-

Inherited from WizardLayout.componentDidMount

-

Defined in node_modules/@types/react/index.d.ts:619

-

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

-

Returns: void

-
-

Optional componentDidUpdate#

-

▸ componentDidUpdate(prevProps: Readonly‹WizardLayoutProps›, prevState: Readonly‹S›, snapshot?: SS): void

-

Inherited from PageLayout.componentDidUpdate

-

Defined in node_modules/@types/react/index.d.ts:682

-

Called immediately after updating occurs. Not called for the initial render.

-

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹WizardLayoutProps›
prevStateReadonly‹S›
snapshot?SS
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹WizardLayoutProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹WizardLayoutProps›
nextContextany
-

Returns: void

-
-

Optional componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Inherited from WizardLayout.componentWillUnmount

-

Defined in node_modules/@types/react/index.d.ts:635

-

Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as -cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹WizardLayoutProps›, nextState: Readonly‹S›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹WizardLayoutProps›
nextStateReadonly‹S›
nextContextany
-

Returns: void

-
-

forceUpdate#

-

▸ forceUpdate(callback?: function): void

-

Inherited from PageLayout.forceUpdate

-

Defined in node_modules/@types/react/index.d.ts:490

-

Parameters:

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹WizardLayoutProps›, prevState: Readonly‹S›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹WizardLayoutProps›
prevStateReadonly‹S›
-

Returns: SS | null

-
-

render#

-

▸ render(): Element‹›

-

Overrides void

-

Defined in src/renderer/components/layout/wizard-layout.tsx:39

-

Returns: Element‹›

-
-

setState#

-

▸ setState‹K›(state: function | S | object, callback?: function): void

-

Inherited from PageLayout.setState

-

Defined in node_modules/@types/react/index.d.ts:485

-

Type parameters:

-

▪ K: keyof S

-

Parameters:

-

▪ state: function | S | object

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹WizardLayoutProps›, nextState: Readonly‹S›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹WizardLayoutProps›
nextStateReadonly‹S›
nextContextany
-

Returns: boolean

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.wizardstep/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.wizardstep/index.html deleted file mode 100644 index 3fb8416364..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_components_.wizardstep/index.html +++ /dev/null @@ -1,1493 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: WizardStep ‹**SS**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: WizardStep ‹SS›#

-

Type parameters#

-

▪ SS

-

Hierarchy#

- -

↳ WizardStep

-

Index#

-

Constructors#

- -

Properties#

- -

Methods#

- -

Object literals#

- -

Constructors#

-

constructor#

-

+ new WizardStep(props: Readonly‹WizardStepProps› | WizardStepProps): WizardStep

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:473

-

Parameters:

- - - - - - - - - - - - - -
NameType
propsReadonly‹WizardStepProps› | WizardStepProps
-

Returns: WizardStep

-

+ new WizardStep(props: WizardStepProps, context: any): WizardStep

-

Inherited from PageLayout.constructor

-

Defined in node_modules/@types/react/index.d.ts:475

-

deprecated

-

see https://reactjs.org/docs/legacy-context.html

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
propsWizardStepProps
contextany
-

Returns: WizardStep

-

Properties#

-

context#

-

• context: any

-

Inherited from PageLayout.context

-

Defined in node_modules/@types/react/index.d.ts:473

-

If using the new style context, re-declare this in your class to be the -React.ContextType of your static contextType. -Should be used with type annotation or static contextType.

-
static contextType = MyContext
-// For TS pre-3.7:
-context!: React.ContextType<typeof MyContext>
-// For TS 3.7 and above:
-declare context: React.ContextType<typeof MyContext>
-
-

see https://reactjs.org/docs/context.html

-
-

props#

-

• props: Readonly‹WizardStepProps› & Readonly‹object›

-

Inherited from PageLayout.props

-

Defined in node_modules/@types/react/index.d.ts:498

-
-

refs#

-

• refs: object

-

Inherited from PageLayout.refs

-

Defined in node_modules/@types/react/index.d.ts:504

-

deprecated -https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

-

Type declaration:#

-
    -
  • [ key: string]: ReactInstance
    • -
-
-

state#

-

• state: WizardStepState

-

Overrides PageLayout.state

-

Defined in src/renderer/components/wizard/wizard.tsx:157

-
-

Static Optional contextType#

-

▪ contextType? : Context‹any›

-

Inherited from PageLayout.contextType

-

Defined in node_modules/@types/react/index.d.ts:455

-

If set, this.context will be set at runtime to the current value of the given Context.

-

Usage:

-
type MyContext = number
-const Ctx = React.createContext<MyContext>(0)
-
-class Foo extends React.Component {
-  static contextType = Ctx
-  context!: React.ContextType<typeof Ctx>
-  render () {
-    return <>My context's value: {this.context}</>;
-  }
-}
-
-

see https://reactjs.org/docs/context.html#classcontexttype

-

Methods#

-

Optional UNSAFE_componentWillMount#

-

▸ UNSAFE_componentWillMount(): void

-

Inherited from PageLayout.UNSAFE_componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:711

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional UNSAFE_componentWillReceiveProps#

-

▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹WizardStepProps›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:743

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹WizardStepProps›
nextContextany
-

Returns: void

-
-

Optional UNSAFE_componentWillUpdate#

-

▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹WizardStepProps›, nextState: Readonly‹WizardStepState›, nextContext: any): void

-

Inherited from PageLayout.UNSAFE_componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:771

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

This method will not stop working in React 17.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹WizardStepProps›
nextStateReadonly‹WizardStepState›
nextContextany
-

Returns: void

-
-

Optional componentDidCatch#

-

▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

-

Inherited from PageLayout.componentDidCatch

-

Defined in node_modules/@types/react/index.d.ts:640

-

Catches exceptions generated in descendant components. Unhandled exceptions will cause -the entire component tree to unmount.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
errorError
errorInfoErrorInfo
-

Returns: void

-
-

Optional componentDidMount#

-

▸ componentDidMount(): void

-

Inherited from WizardLayout.componentDidMount

-

Defined in node_modules/@types/react/index.d.ts:619

-

Called immediately after a component is mounted. Setting state here will trigger re-rendering.

-

Returns: void

-
-

Optional componentDidUpdate#

-

▸ componentDidUpdate(prevProps: Readonly‹WizardStepProps›, prevState: Readonly‹WizardStepState›, snapshot?: SS): void

-

Inherited from PageLayout.componentDidUpdate

-

Defined in node_modules/@types/react/index.d.ts:682

-

Called immediately after updating occurs. Not called for the initial render.

-

The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹WizardStepProps›
prevStateReadonly‹WizardStepState›
snapshot?SS
-

Returns: void

-
-

Optional componentWillMount#

-

▸ componentWillMount(): void

-

Inherited from PageLayout.componentWillMount

-

Defined in node_modules/@types/react/index.d.ts:697

-

Called immediately before mounting occurs, and before Component#render. -Avoid introducing any side-effects or subscriptions in this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Returns: void

-
-

Optional componentWillReceiveProps#

-

▸ componentWillReceiveProps(nextProps: Readonly‹WizardStepProps›, nextContext: any): void

-

Inherited from PageLayout.componentWillReceiveProps

-

Defined in node_modules/@types/react/index.d.ts:726

-

Called when the component may be receiving new props. -React may call this even if props have not changed, so be sure to compare new and existing -props if you only want to handle changes.

-

Calling Component#setState generally does not trigger this method.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹WizardStepProps›
nextContextany
-

Returns: void

-
-

componentWillUnmount#

-

▸ componentWillUnmount(): void

-

Overrides WizardLayout.componentWillUnmount

-

Defined in src/renderer/components/wizard/wizard.tsx:164

-

Returns: void

-
-

Optional componentWillUpdate#

-

▸ componentWillUpdate(nextProps: Readonly‹WizardStepProps›, nextState: Readonly‹WizardStepState›, nextContext: any): void

-

Inherited from PageLayout.componentWillUpdate

-

Defined in node_modules/@types/react/index.d.ts:756

-

Called immediately before rendering when new props or state is received. Not called for the initial render.

-

Note: You cannot call Component#setState here.

-

Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps -prevents this from being invoked.

-

deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

-

see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹WizardStepProps›
nextStateReadonly‹WizardStepState›
nextContextany
-

Returns: void

-
-

forceUpdate#

-

▸ forceUpdate(callback?: function): void

-

Inherited from PageLayout.forceUpdate

-

Defined in node_modules/@types/react/index.d.ts:490

-

Parameters:

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional getSnapshotBeforeUpdate#

-

▸ getSnapshotBeforeUpdate(prevProps: Readonly‹WizardStepProps›, prevState: Readonly‹WizardStepState›): SS | null

-

Inherited from PageLayout.getSnapshotBeforeUpdate

-

Defined in node_modules/@types/react/index.d.ts:676

-

Runs before React applies the result of render to the document, and -returns an object to be given to componentDidUpdate. Useful for saving -things such as scroll position before render causes changes to it.

-

Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated -lifecycle events from running.

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
prevPropsReadonly‹WizardStepProps›
prevStateReadonly‹WizardStepState›
-

Returns: SS | null

-
-

next#

-

▸ next(): void

-

Defined in src/renderer/components/wizard/wizard.tsx:175

-

Returns: void

-
-

prev#

-

▸ prev(): void

-

Defined in src/renderer/components/wizard/wizard.tsx:168

-

Returns: void

-
-

render#

-

▸ render(): Element‹›

-

Overrides void

-

Defined in src/renderer/components/wizard/wizard.tsx:215

-

Returns: Element‹›

-
-

renderLoading#

-

▸ renderLoading(): Element‹›

-

Defined in src/renderer/components/wizard/wizard.tsx:207

-

Returns: Element‹›

-
-

setState#

-

▸ setState‹K›(state: function | S | object, callback?: function): void

-

Inherited from PageLayout.setState

-

Defined in node_modules/@types/react/index.d.ts:485

-

Type parameters:

-

▪ K: keyof WizardStepState

-

Parameters:

-

▪ state: function | S | object

-

▪Optional callback: function

-

▸ (): void

-

Returns: void

-
-

Optional shouldComponentUpdate#

-

▸ shouldComponentUpdate(nextProps: Readonly‹WizardStepProps›, nextState: Readonly‹WizardStepState›, nextContext: any): boolean

-

Inherited from PageLayout.shouldComponentUpdate

-

Defined in node_modules/@types/react/index.d.ts:630

-

Called to determine whether the change in props and state should trigger a re-render.

-

Component always returns true. -PureComponent implements a shallow comparison on props and state and returns true if any -props or states have changed.

-

If false is returned, Component#render, componentWillUpdate -and componentDidUpdate will not be called.

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - -
NameType
nextPropsReadonly‹WizardStepProps›
nextStateReadonly‹WizardStepState›
nextContextany
-

Returns: boolean

-
-

submit#

-

▸ submit(): void

-

Defined in src/renderer/components/wizard/wizard.tsx:198

-

Returns: void

-

Object literals#

-

Static defaultProps#

-

▪ defaultProps: object#

-

Defined in src/renderer/components/wizard/wizard.tsx:160

-

scrollable#

-

• scrollable: true = true

-

Defined in src/renderer/components/wizard/wizard.tsx:161

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.clusterrole/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.clusterrole/index.html deleted file mode 100644 index 4830efcdc0..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.clusterrole/index.html +++ /dev/null @@ -1,1535 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: ClusterRole ‹**Metadata, Status, Spec**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: ClusterRole ‹Metadata, Status, Spec›#

-

Type parameters#

-

▪ Metadata: IKubeObjectMetadata

-

▪ Status

-

▪ Spec

-

Hierarchy#

-

↳ Role

-

↳ ClusterRole

-

Implements#

-
    -
  • ItemObject
    • -
-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new ClusterRole(data: KubeJsonApiData): ClusterRole

-

Inherited from KubeObject.constructor

-

Defined in src/renderer/api/kube-object.ts:180

-

Parameters:

- - - - - - - - - - - - - -
NameType
dataKubeJsonApiData
-

Returns: ClusterRole

-

Properties#

-

apiVersion#

-

• apiVersion: string

-

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:94

-
-

kind#

-

• kind: string

-

Inherited from KubeObject.kind

-

Defined in src/renderer/api/kube-object.ts:95

-
-

metadata#

-

• metadata: Metadata

-

Inherited from KubeObject.metadata

-

Defined in src/renderer/api/kube-object.ts:96

-
-

rules#

-

• rules: object[]

-

Inherited from Role.rules

-

Defined in src/renderer/api/endpoints/role.api.ts:26

-
-

Optional spec#

-

• spec? : Spec

-

Inherited from KubeObject.spec

-

Defined in src/renderer/api/kube-object.ts:98

-
-

Optional status#

-

• status? : Status

-

Inherited from KubeObject.status

-

Defined in src/renderer/api/kube-object.ts:97

-
-

Static apiBase#

-

▪ apiBase: string = "/apis/rbac.authorization.k8s.io/v1/clusterroles"

-

Overrides Role.apiBase

-

Defined in src/renderer/api/endpoints/cluster-role.api.ts:28

-
-

Static kind#

-

▪ kind: string = "ClusterRole"

-

Overrides Role.kind

-

Defined in src/renderer/api/endpoints/cluster-role.api.ts:26

-
-

Static namespaced#

-

▪ namespaced: boolean = false

-

Overrides Role.namespaced

-

Defined in src/renderer/api/endpoints/cluster-role.api.ts:27

-

Accessors#

- -

• get selfLink(): string

-

Inherited from KubeObject.selfLink

-

Defined in src/renderer/api/kube-object.ts:187

-

Returns: string

-

Methods#

-

delete#

-

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

-

Inherited from KubeObject.delete

-

Defined in src/renderer/api/kube-object.ts:276

-

Parameters:

- - - - - - - - - - - - - -
NameType
params?JsonApiParams
-

Returns: Promise‹KubeJsonApiData›

-
-

getAge#

-

▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

-

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:212

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
-

Returns: string | number

-
-

getAnnotations#

-

▸ getAnnotations(filter: boolean): string[]

-

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:233

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleanfalse
-

Returns: string[]

-
-

getFinalizers#

-

▸ getFinalizers(): string[]

-

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:225

-

Returns: string[]

-
-

getId#

-

▸ getId(): string

-

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:191

-

Returns: string

-
-

getLabels#

-

▸ getLabels(): string[]

-

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:229

-

Returns: string[]

-
-

getName#

-

▸ getName(): string

-

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:199

-

Returns: string

-
-

getNs#

-

▸ getNs(): string

-

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:203

-

Returns: string

-
-

getOwnerRefs#

-

▸ getOwnerRefs(): object[]

-

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:243

-

Returns: object[]

-
-

getResourceVersion#

-

▸ getResourceVersion(): string

-

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:195

-

Returns: string

-
-

getRules#

-

▸ getRules(): object[]

-

Inherited from Role.getRules

-

Defined in src/renderer/api/endpoints/role.api.ts:39

-

Returns: object[]

-
-

getSearchFields#

-

▸ getSearchFields(): string[]

-

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:252

-

Returns: string[]

-
-

getTimeDiffFromNow#

-

▸ getTimeDiffFromNow(): number

-

Inherited from KubeObject.getTimeDiffFromNow

-

Defined in src/renderer/api/kube-object.ts:208

-

Returns: number

-
-

toPlainObject#

-

▸ toPlainObject(): object

-

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:264

-

Returns: object

-
-

update#

-

▸ update‹T›(data: Partial‹T›): Promise‹T›

-

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:269

-

Type parameters:

-

▪ T: KubeObject

-

Parameters:

- - - - - - - - - - - - - -
NameType
dataPartial‹T›
-

Returns: Promise‹T›

-
-

Static create#

-

▸ create(data: KubeJsonApiData): KubeObject‹IKubeObjectMetadata, any, any›

-

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:100

-

Parameters:

- - - - - - - - - - - - - -
NameType
dataKubeJsonApiData
-

Returns: KubeObject‹IKubeObjectMetadata, any, any›

-
-

Static isJsonApiData#

-

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

-

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:108

-

Parameters:

- - - - - - - - - - - - - -
NameType
objectunknown
-

Returns: object is KubeJsonApiData

-
-

Static isJsonApiDataList#

-

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

-

Inherited from KubeObject.isJsonApiDataList

-

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

-

Type parameters:

-

▪ T

-

Parameters:

-

▪ object: unknown

-

▪ verifyItem: function

-

▸ (val: unknown): val is T

-

Parameters:

- - - - - - - - - - - - - -
NameType
valunknown
-

Returns: object is KubeJsonApiDataList‹T›

-
-

Static isKubeJsonApiListMetadata#

-

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

-

Inherited from KubeObject.isKubeJsonApiListMetadata

-

Defined in src/renderer/api/kube-object.ts:117

-

Parameters:

- - - - - - - - - - - - - -
NameType
objectunknown
-

Returns: object is KubeJsonApiListMetadata

-
-

Static isKubeJsonApiMetadata#

-

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

-

Inherited from KubeObject.isKubeJsonApiMetadata

-

Defined in src/renderer/api/kube-object.ts:125

-

Parameters:

- - - - - - - - - - - - - -
NameType
objectunknown
-

Returns: object is KubeJsonApiMetadata

-
-

Static isNonSystem#

-

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

-

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:104

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemKubeJsonApiData | KubeObject
-

Returns: boolean

-
-

Static isPartialJsonApiData#

-

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

-

Inherited from KubeObject.isPartialJsonApiData

-

Defined in src/renderer/api/kube-object.ts:157

-

Parameters:

- - - - - - - - - - - - - -
NameType
objectunknown
-

Returns: object is Partial‹KubeJsonApiData›

-
-

Static isPartialJsonApiMetadata#

-

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

-

Inherited from KubeObject.isPartialJsonApiMetadata

-

Defined in src/renderer/api/kube-object.ts:141

-

Parameters:

- - - - - - - - - - - - - -
NameType
objectunknown
-

Returns: object is Partial‹KubeJsonApiMetadata›

-
-

Static stringifyLabels#

-

▸ stringifyLabels(labels?: object): string[]

-

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:176

-

Parameters:

- - - - - - - - - - - - - -
NameType
labels?object
-

Returns: string[]

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.clusterrolebinding/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.clusterrolebinding/index.html deleted file mode 100644 index 56a49b153a..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.clusterrolebinding/index.html +++ /dev/null @@ -1,1575 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: ClusterRoleBinding ‹**Metadata, Status, Spec**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: ClusterRoleBinding ‹Metadata, Status, Spec›#

-

Type parameters#

-

▪ Metadata: IKubeObjectMetadata

-

▪ Status

-

▪ Spec

-

Hierarchy#

-

↳ RoleBinding

-

↳ ClusterRoleBinding

-

Implements#

-
    -
  • ItemObject
    • -
-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new ClusterRoleBinding(data: KubeJsonApiData): ClusterRoleBinding

-

Inherited from RoleBinding.constructor

-

Overrides KubeObject.constructor

-

Defined in src/renderer/api/endpoints/role-binding.api.ts:46

-

Parameters:

- - - - - - - - - - - - - -
NameType
dataKubeJsonApiData
-

Returns: ClusterRoleBinding

-

Properties#

-

apiVersion#

-

• apiVersion: string

-

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:94

-
-

kind#

-

• kind: string

-

Inherited from KubeObject.kind

-

Defined in src/renderer/api/kube-object.ts:95

-
-

metadata#

-

• metadata: Metadata

-

Inherited from KubeObject.metadata

-

Defined in src/renderer/api/kube-object.ts:96

-
-

roleRef#

-

• roleRef: object

-

Inherited from RoleBinding.roleRef

-

Defined in src/renderer/api/endpoints/role-binding.api.ts:36

-

Type declaration:#

-
    -
  • -

    apiGroup? : string

    -
    • -
  • -

    kind: string

    -
    • -
  • -

    name: string

    -
    • -
-
-

Optional spec#

-

• spec? : Spec

-

Inherited from KubeObject.spec

-

Defined in src/renderer/api/kube-object.ts:98

-
-

Optional status#

-

• status? : Status

-

Inherited from KubeObject.status

-

Defined in src/renderer/api/kube-object.ts:97

-
-

Optional subjects#

-

• subjects? : IRoleBindingSubject[]

-

Inherited from RoleBinding.subjects

-

Defined in src/renderer/api/endpoints/role-binding.api.ts:35

-
-

Static apiBase#

-

▪ apiBase: string = "/apis/rbac.authorization.k8s.io/v1/clusterrolebindings"

-

Overrides RoleBinding.apiBase

-

Defined in src/renderer/api/endpoints/cluster-role-binding.api.ts:28

-
-

Static kind#

-

▪ kind: string = "ClusterRoleBinding"

-

Overrides RoleBinding.kind

-

Defined in src/renderer/api/endpoints/cluster-role-binding.api.ts:26

-
-

Static namespaced#

-

▪ namespaced: boolean = false

-

Overrides RoleBinding.namespaced

-

Defined in src/renderer/api/endpoints/cluster-role-binding.api.ts:27

-

Accessors#

- -

• get selfLink(): string

-

Inherited from KubeObject.selfLink

-

Defined in src/renderer/api/kube-object.ts:187

-

Returns: string

-

Methods#

-

delete#

-

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

-

Inherited from KubeObject.delete

-

Defined in src/renderer/api/kube-object.ts:276

-

Parameters:

- - - - - - - - - - - - - -
NameType
params?JsonApiParams
-

Returns: Promise‹KubeJsonApiData›

-
-

getAge#

-

▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

-

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:212

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
-

Returns: string | number

-
-

getAnnotations#

-

▸ getAnnotations(filter: boolean): string[]

-

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:233

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleanfalse
-

Returns: string[]

-
-

getFinalizers#

-

▸ getFinalizers(): string[]

-

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:225

-

Returns: string[]

-
-

getId#

-

▸ getId(): string

-

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:191

-

Returns: string

-
-

getLabels#

-

▸ getLabels(): string[]

-

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:229

-

Returns: string[]

-
-

getName#

-

▸ getName(): string

-

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:199

-

Returns: string

-
-

getNs#

-

▸ getNs(): string

-

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:203

-

Returns: string

-
-

getOwnerRefs#

-

▸ getOwnerRefs(): object[]

-

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:243

-

Returns: object[]

-
-

getResourceVersion#

-

▸ getResourceVersion(): string

-

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:195

-

Returns: string

-
-

getSearchFields#

-

▸ getSearchFields(): string[]

-

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:252

-

Returns: string[]

-
-

getSubjectNames#

-

▸ getSubjectNames(): string

-

Inherited from RoleBinding.getSubjectNames

-

Defined in src/renderer/api/endpoints/role-binding.api.ts:57

-

Returns: string

-
-

getSubjects#

-

▸ getSubjects(): IRoleBindingSubject[]

-

Inherited from RoleBinding.getSubjects

-

Defined in src/renderer/api/endpoints/role-binding.api.ts:53

-

Returns: IRoleBindingSubject[]

-
-

getTimeDiffFromNow#

-

▸ getTimeDiffFromNow(): number

-

Inherited from KubeObject.getTimeDiffFromNow

-

Defined in src/renderer/api/kube-object.ts:208

-

Returns: number

-
-

toPlainObject#

-

▸ toPlainObject(): object

-

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:264

-

Returns: object

-
-

update#

-

▸ update‹T›(data: Partial‹T›): Promise‹T›

-

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:269

-

Type parameters:

-

▪ T: KubeObject

-

Parameters:

- - - - - - - - - - - - - -
NameType
dataPartial‹T›
-

Returns: Promise‹T›

-
-

Static create#

-

▸ create(data: KubeJsonApiData): KubeObject‹IKubeObjectMetadata, any, any›

-

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:100

-

Parameters:

- - - - - - - - - - - - - -
NameType
dataKubeJsonApiData
-

Returns: KubeObject‹IKubeObjectMetadata, any, any›

-
-

Static isJsonApiData#

-

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

-

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:108

-

Parameters:

- - - - - - - - - - - - - -
NameType
objectunknown
-

Returns: object is KubeJsonApiData

-
-

Static isJsonApiDataList#

-

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

-

Inherited from KubeObject.isJsonApiDataList

-

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

-

Type parameters:

-

▪ T

-

Parameters:

-

▪ object: unknown

-

▪ verifyItem: function

-

▸ (val: unknown): val is T

-

Parameters:

- - - - - - - - - - - - - -
NameType
valunknown
-

Returns: object is KubeJsonApiDataList‹T›

-
-

Static isKubeJsonApiListMetadata#

-

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

-

Inherited from KubeObject.isKubeJsonApiListMetadata

-

Defined in src/renderer/api/kube-object.ts:117

-

Parameters:

- - - - - - - - - - - - - -
NameType
objectunknown
-

Returns: object is KubeJsonApiListMetadata

-
-

Static isKubeJsonApiMetadata#

-

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

-

Inherited from KubeObject.isKubeJsonApiMetadata

-

Defined in src/renderer/api/kube-object.ts:125

-

Parameters:

- - - - - - - - - - - - - -
NameType
objectunknown
-

Returns: object is KubeJsonApiMetadata

-
-

Static isNonSystem#

-

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

-

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:104

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemKubeJsonApiData | KubeObject
-

Returns: boolean

-
-

Static isPartialJsonApiData#

-

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

-

Inherited from KubeObject.isPartialJsonApiData

-

Defined in src/renderer/api/kube-object.ts:157

-

Parameters:

- - - - - - - - - - - - - -
NameType
objectunknown
-

Returns: object is Partial‹KubeJsonApiData›

-
-

Static isPartialJsonApiMetadata#

-

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

-

Inherited from KubeObject.isPartialJsonApiMetadata

-

Defined in src/renderer/api/kube-object.ts:141

-

Parameters:

- - - - - - - - - - - - - -
NameType
objectunknown
-

Returns: object is Partial‹KubeJsonApiMetadata›

-
-

Static stringifyLabels#

-

▸ stringifyLabels(labels?: object): string[]

-

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:176

-

Parameters:

- - - - - - - - - - - - - -
NameType
labels?object
-

Returns: string[]

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.configmapsstore/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.configmapsstore/index.html deleted file mode 100644 index 00b537aeeb..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.configmapsstore/index.html +++ /dev/null @@ -1,2166 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: ConfigMapsStore - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: ConfigMapsStore#

-

Hierarchy#

-

↳ KubeObjectStore‹ConfigMap›

-

↳ ConfigMapsStore

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new ConfigMapsStore(): ConfigMapsStore

-

Inherited from KubeObjectStore.constructor

-

Overrides void

-

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

-

Returns: ConfigMapsStore

-

Properties#

-

api#

-

• api: KubeApi‹ConfigMap‹›› = configMapApi

-

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+config-maps/config-maps.store.ts:27

-
-

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:304

-
-

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#

-

context#

-

• get context(): ClusterContext

-

Inherited from KubeObjectStore.context

-

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

-

Returns: ClusterContext

-
-

contextItems#

-

• get contextItems(): ConfigMap[]

-

Inherited from KubeObjectStore.contextItems

-

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

-

Returns: ConfigMap[]

-
-

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(): ConfigMap[]

-

Inherited from KubeObjectStore.selectedItems

-

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

-

Returns: ConfigMap[]

-

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:306

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
delaynumber1000
-

Returns: void

-
-

create#

-

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

-

Inherited from KubeObjectStore.create

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹ConfigMap›

-

Returns: Promise‹ConfigMap›

-
-

Protected createItem#

-

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

-

Inherited from KubeObjectStore.createItem

-

Overrides void

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹ConfigMap›

-

Returns: Promise‹ConfigMap›

-
-

Protected defaultSorting#

-

▸ defaultSorting(item: ConfigMap): string

-

Inherited from KubeObjectStore.defaultSorting

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemConfigMap
-

Returns: string

-
-

Protected filterItemsOnLoad#

-

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

-

Inherited from KubeObjectStore.filterItemsOnLoad

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsConfigMap[]
-

Returns: T[]

-
-

getAllByNs#

-

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

-

Inherited from KubeObjectStore.getAllByNs

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
namespacestring | string[]-
strictbooleanfalse
-

Returns: ConfigMap[]

-
-

getById#

-

▸ getById(id: string): T

-

Inherited from KubeObjectStore.getById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: T

-
-

getByLabel#

-

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

-

Inherited from KubeObjectStore.getByLabel

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
labelsstring[] | object
-

Returns: ConfigMap[]

-
-

getByName#

-

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

-

Inherited from KubeObjectStore.getByName

-

Overrides void

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: ConfigMap

-
-

getByPath#

-

▸ getByPath(path: string): ConfigMap

-

Inherited from KubeObjectStore.getByPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
pathstring
-

Returns: ConfigMap

-
-

getIndexById#

-

▸ getIndexById(id: string): number

-

Inherited from KubeObjectStore.getIndexById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: number

-
-

getItems#

-

▸ getItems(): ConfigMap[]

-

Inherited from KubeObjectStore.getItems

-

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

-

Returns: ConfigMap[]

-
-

Optional getStatuses#

-

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

-

Inherited from KubeObjectStore.getStatuses

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsConfigMap[]
-

Returns: Record‹string, number›

-
-

getSubscribeApis#

-

▸ getSubscribeApis(): KubeApi[]

-

Inherited from KubeObjectStore.getSubscribeApis

-

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

-

Returns: KubeApi[]

-
-

getTotalCount#

-

▸ getTotalCount(): number

-

Inherited from KubeObjectStore.getTotalCount

-

Overrides void

-

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

-

Returns: number

-
-

isSelected#

-

▸ isSelected(item: ConfigMap): boolean

-

Inherited from KubeObjectStore.isSelected

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemConfigMap
-

Returns: boolean

-
-

isSelectedAll#

-

▸ isSelectedAll(visibleItems: ConfigMap[]): boolean

-

Inherited from KubeObjectStore.isSelectedAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsConfigMap[]this.items
-

Returns: boolean

-
-

load#

-

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

-

Inherited from KubeObjectStore.load

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹ConfigMap›

-
-

loadAll#

-

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

-

Inherited from KubeObjectStore.loadAll

-

Overrides void

-

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

-

Parameters:

-

▪Default value options: object= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
merge?boolean
namespaces?string[]
reqInit?RequestInit
-

Returns: Promise‹void | ConfigMap[]›

-
-

loadFromPath#

-

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

-

Inherited from KubeObjectStore.loadFromPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
resourcePathstring
-

Returns: Promise‹T›

-
-

Protected loadItem#

-

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

-

Inherited from KubeObjectStore.loadItem

-

Overrides void

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹ConfigMap›

-
-

Protected loadItems#

-

▸ loadItems(__namedParameters: object): Promise‹ConfigMap[]›

-

Inherited from KubeObjectStore.loadItems

-

Overrides void

-

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

-

Parameters:

-

▪ __namedParameters: object

- - - - - - - - - - - - - - - - - - - - - -
NameType
apiKubeApi‹any›
namespacesstring[]
reqInitRequestInit
-

Returns: Promise‹ConfigMap[]›

-
-

Protected mergeItems#

-

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

-

Inherited from KubeObjectStore.mergeItems

-

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

-

Parameters:

-

▪ partialItems: ConfigMap[]

-

▪Default value __namedParameters: object= {}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleantrue
replacebooleanfalse
sortbooleantrue
updateStorebooleantrue
-

Returns: ConfigMap[]

-
-

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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
force?boolean
merge?boolean
namespaces?string[]
-

Returns: Promise‹void | T[]›

-
-

remove#

-

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

-

Inherited from KubeObjectStore.remove

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemConfigMap
-

Returns: Promise‹void›

-
-

Protected removeItem#

-

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

-

Inherited from KubeObjectStore.removeItem

-

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

-

Parameters:

-

▪ item: ConfigMap

-

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

-

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:

- - - - - - - - - - - - - -
NameType
errorany
-

Returns: void

-
-

resetSelection#

-

▸ resetSelection(): void

-

Inherited from KubeObjectStore.resetSelection

-

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

-

Returns: void

-
-

select#

-

▸ select(item: ConfigMap): void

-

Inherited from KubeObjectStore.select

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemConfigMap
-

Returns: void

-
-

Protected sortItems#

-

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

-

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:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
itemsConfigMap[]this.itemsthe items to be sorted (default: the current items in this store)
sortingfunction[][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: ConfigMap[]

-
-

subscribe#

-

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

-

Inherited from KubeObjectStore.subscribe

-

Overrides void

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
-

Returns: (Anonymous function)

-
-

toggleSelection#

-

▸ toggleSelection(item: ConfigMap): void

-

Inherited from KubeObjectStore.toggleSelection

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemConfigMap
-

Returns: void

-
-

toggleSelectionAll#

-

▸ toggleSelectionAll(visibleItems: ConfigMap[]): void

-

Inherited from KubeObjectStore.toggleSelectionAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsConfigMap[]this.items
-

Returns: void

-
-

unselect#

-

▸ unselect(item: ConfigMap): void

-

Inherited from KubeObjectStore.unselect

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemConfigMap
-

Returns: void

-
-

update#

-

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

-

Inherited from KubeObjectStore.update

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
itemConfigMap
dataPartial‹ConfigMap›
-

Returns: Promise‹ConfigMap›

-
-

Protected updateFromEventsBuffer#

-

▸ updateFromEventsBuffer(): void

-

Inherited from KubeObjectStore.updateFromEventsBuffer

-

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

-

Returns: void

-
-

Protected updateItem#

-

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

-

Inherited from KubeObjectStore.updateItem

-

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

-

Parameters:

-

▪ item: ConfigMap

-

▪ request: function

-

▸ (): Promise‹ConfigMap›

-

Returns: Promise‹T›

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.crdresourcestore/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.crdresourcestore/index.html deleted file mode 100644 index 270cc81e2d..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.crdresourcestore/index.html +++ /dev/null @@ -1,2189 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: CRDResourceStore ‹**T**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: CRDResourceStore ‹T›#

-

Type parameters#

-

▪ T: KubeObject

-

Hierarchy#

-

↳ KubeObjectStore‹T›

-

↳ CRDResourceStore

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new CRDResourceStore(api: KubeApi‹T›): CRDResourceStore

-

Overrides KubeObjectStore.constructor

-

Defined in src/renderer/components/+custom-resources/crd-resource.store.ts:27

-

Parameters:

- - - - - - - - - - - - - -
NameType
apiKubeApi‹T›
-

Returns: CRDResourceStore

-

Properties#

-

api#

-

• api: KubeApi

-

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+custom-resources/crd-resource.store.ts:27

-
-

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:304

-
-

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#

-

context#

-

• get context(): ClusterContext

-

Inherited from KubeObjectStore.context

-

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

-

Returns: ClusterContext

-
-

contextItems#

-

• get contextItems(): T[]

-

Inherited from KubeObjectStore.contextItems

-

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

-

Returns: T[]

-
-

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(): T[]

-

Inherited from KubeObjectStore.selectedItems

-

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

-

Returns: T[]

-

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:306

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
delaynumber1000
-

Returns: void

-
-

create#

-

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

-

Inherited from KubeObjectStore.create

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹T›

-

Returns: Promise‹T›

-
-

Protected createItem#

-

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

-

Inherited from KubeObjectStore.createItem

-

Overrides void

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹T›

-

Returns: Promise‹T›

-
-

Protected defaultSorting#

-

▸ defaultSorting(item: T): string

-

Inherited from KubeObjectStore.defaultSorting

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemT
-

Returns: string

-
-

Protected filterItemsOnLoad#

-

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

-

Inherited from KubeObjectStore.filterItemsOnLoad

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsT[]
-

Returns: T[]

-
-

getAllByNs#

-

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

-

Inherited from KubeObjectStore.getAllByNs

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
namespacestring | string[]-
strictbooleanfalse
-

Returns: T[]

-
-

getById#

-

▸ getById(id: string): T

-

Inherited from KubeObjectStore.getById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: T

-
-

getByLabel#

-

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

-

Inherited from KubeObjectStore.getByLabel

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
labelsstring[] | object
-

Returns: T[]

-
-

getByName#

-

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

-

Inherited from KubeObjectStore.getByName

-

Overrides void

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: T

-
-

getByPath#

-

▸ getByPath(path: string): T

-

Inherited from KubeObjectStore.getByPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
pathstring
-

Returns: T

-
-

getIndexById#

-

▸ getIndexById(id: string): number

-

Inherited from KubeObjectStore.getIndexById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: number

-
-

getItems#

-

▸ getItems(): T[]

-

Inherited from KubeObjectStore.getItems

-

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

-

Returns: T[]

-
-

Optional getStatuses#

-

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

-

Inherited from KubeObjectStore.getStatuses

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsT[]
-

Returns: Record‹string, number›

-
-

getSubscribeApis#

-

▸ getSubscribeApis(): KubeApi[]

-

Inherited from KubeObjectStore.getSubscribeApis

-

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

-

Returns: KubeApi[]

-
-

getTotalCount#

-

▸ getTotalCount(): number

-

Inherited from KubeObjectStore.getTotalCount

-

Overrides void

-

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

-

Returns: number

-
-

isSelected#

-

▸ isSelected(item: T): boolean

-

Inherited from KubeObjectStore.isSelected

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemT
-

Returns: boolean

-
-

isSelectedAll#

-

▸ isSelectedAll(visibleItems: T[]): boolean

-

Inherited from KubeObjectStore.isSelectedAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsT[]this.items
-

Returns: boolean

-
-

load#

-

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

-

Inherited from KubeObjectStore.load

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹T›

-
-

loadAll#

-

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

-

Inherited from KubeObjectStore.loadAll

-

Overrides void

-

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

-

Parameters:

-

▪Default value options: object= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
merge?boolean
namespaces?string[]
reqInit?RequestInit
-

Returns: Promise‹void | T[]›

-
-

loadFromPath#

-

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

-

Inherited from KubeObjectStore.loadFromPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
resourcePathstring
-

Returns: Promise‹T›

-
-

Protected loadItem#

-

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

-

Inherited from KubeObjectStore.loadItem

-

Overrides void

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹T›

-
-

Protected loadItems#

-

▸ loadItems(__namedParameters: object): Promise‹T[]›

-

Inherited from KubeObjectStore.loadItems

-

Overrides void

-

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

-

Parameters:

-

▪ __namedParameters: object

- - - - - - - - - - - - - - - - - - - - - -
NameType
apiKubeApi‹any›
namespacesstring[]
reqInitRequestInit
-

Returns: Promise‹T[]›

-
-

Protected mergeItems#

-

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

-

Inherited from KubeObjectStore.mergeItems

-

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

-

Parameters:

-

▪ partialItems: T[]

-

▪Default value __namedParameters: object= {}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleantrue
replacebooleanfalse
sortbooleantrue
updateStorebooleantrue
-

Returns: T[]

-
-

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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
force?boolean
merge?boolean
namespaces?string[]
-

Returns: Promise‹void | T[]›

-
-

remove#

-

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

-

Inherited from KubeObjectStore.remove

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemT
-

Returns: Promise‹void›

-
-

Protected removeItem#

-

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

-

Inherited from KubeObjectStore.removeItem

-

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

-

Parameters:

-

▪ item: T

-

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

-

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:

- - - - - - - - - - - - - -
NameType
errorany
-

Returns: void

-
-

resetSelection#

-

▸ resetSelection(): void

-

Inherited from KubeObjectStore.resetSelection

-

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

-

Returns: void

-
-

select#

-

▸ select(item: T): void

-

Inherited from KubeObjectStore.select

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemT
-

Returns: void

-
-

Protected sortItems#

-

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

-

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:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
itemsT[]this.itemsthe items to be sorted (default: the current items in this store)
sortingfunction[][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: T[]

-
-

subscribe#

-

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

-

Inherited from KubeObjectStore.subscribe

-

Overrides void

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
-

Returns: (Anonymous function)

-
-

toggleSelection#

-

▸ toggleSelection(item: T): void

-

Inherited from KubeObjectStore.toggleSelection

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemT
-

Returns: void

-
-

toggleSelectionAll#

-

▸ toggleSelectionAll(visibleItems: T[]): void

-

Inherited from KubeObjectStore.toggleSelectionAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsT[]this.items
-

Returns: void

-
-

unselect#

-

▸ unselect(item: T): void

-

Inherited from KubeObjectStore.unselect

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemT
-

Returns: void

-
-

update#

-

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

-

Inherited from KubeObjectStore.update

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
itemT
dataPartial‹T›
-

Returns: Promise‹T›

-
-

Protected updateFromEventsBuffer#

-

▸ updateFromEventsBuffer(): void

-

Inherited from KubeObjectStore.updateFromEventsBuffer

-

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

-

Returns: void

-
-

Protected updateItem#

-

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

-

Inherited from KubeObjectStore.updateItem

-

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

-

Parameters:

-

▪ item: T

-

▪ request: function

-

▸ (): Promise‹T›

-

Returns: Promise‹T›

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.crdstore/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.crdstore/index.html deleted file mode 100644 index 3aedca8850..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.crdstore/index.html +++ /dev/null @@ -1,2218 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: CRDStore - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: CRDStore#

-

Hierarchy#

-

↳ KubeObjectStore‹CustomResourceDefinition›

-

↳ CRDStore

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new CRDStore(): CRDStore

-

Overrides KubeObjectStore.constructor

-

Defined in src/renderer/components/+custom-resources/crd.store.ts:43

-

Returns: CRDStore

-

Properties#

-

api#

-

• api: KubeApi‹CustomResourceDefinition‹›› = crdApi

-

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+custom-resources/crd.store.ts:43

-
-

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:304

-
-

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#

-

context#

-

• get context(): ClusterContext

-

Inherited from KubeObjectStore.context

-

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

-

Returns: ClusterContext

-
-

contextItems#

-

• get contextItems(): CustomResourceDefinition[]

-

Inherited from KubeObjectStore.contextItems

-

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

-

Returns: CustomResourceDefinition[]

-
-

contextReady#

-

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

-

Inherited from KubeObjectStore.contextReady

-

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

-

Returns: Promise‹void› & object

-
-

groups#

-

• get groups(): object

-

Defined in src/renderer/components/+custom-resources/crd.store.ts:62

-

Returns: 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(): CustomResourceDefinition[]

-

Inherited from KubeObjectStore.selectedItems

-

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

-

Returns: CustomResourceDefinition[]

-

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:306

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
delaynumber1000
-

Returns: void

-
-

create#

-

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

-

Inherited from KubeObjectStore.create

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹CustomResourceDefinition›

-

Returns: Promise‹CustomResourceDefinition›

-
-

Protected createItem#

-

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

-

Inherited from KubeObjectStore.createItem

-

Overrides void

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹CustomResourceDefinition›

-

Returns: Promise‹CustomResourceDefinition›

-
-

Protected defaultSorting#

-

▸ defaultSorting(item: CustomResourceDefinition): string

-

Inherited from KubeObjectStore.defaultSorting

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemCustomResourceDefinition
-

Returns: string

-
-

Protected filterItemsOnLoad#

-

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

-

Inherited from KubeObjectStore.filterItemsOnLoad

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsCustomResourceDefinition[]
-

Returns: T[]

-
-

getAllByNs#

-

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

-

Inherited from KubeObjectStore.getAllByNs

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
namespacestring | string[]-
strictbooleanfalse
-

Returns: CustomResourceDefinition[]

-
-

getByGroup#

-

▸ getByGroup(group: string, pluralName: string): CustomResourceDefinition‹›

-

Defined in src/renderer/components/+custom-resources/crd.store.ts:75

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
groupstring
pluralNamestring
-

Returns: CustomResourceDefinition‹›

-
-

getById#

-

▸ getById(id: string): T

-

Inherited from KubeObjectStore.getById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: T

-
-

getByLabel#

-

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

-

Inherited from KubeObjectStore.getByLabel

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
labelsstring[] | object
-

Returns: CustomResourceDefinition[]

-
-

getByName#

-

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

-

Inherited from KubeObjectStore.getByName

-

Overrides void

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: CustomResourceDefinition

-
-

getByObject#

-

▸ getByObject(obj: KubeObject): CustomResourceDefinition‹›

-

Defined in src/renderer/components/+custom-resources/crd.store.ts:83

-

Parameters:

- - - - - - - - - - - - - -
NameType
objKubeObject
-

Returns: CustomResourceDefinition‹›

-
-

getByPath#

-

▸ getByPath(path: string): CustomResourceDefinition

-

Inherited from KubeObjectStore.getByPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
pathstring
-

Returns: CustomResourceDefinition

-
-

getIndexById#

-

▸ getIndexById(id: string): number

-

Inherited from KubeObjectStore.getIndexById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: number

-
-

getItems#

-

▸ getItems(): CustomResourceDefinition[]

-

Inherited from KubeObjectStore.getItems

-

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

-

Returns: CustomResourceDefinition[]

-
-

Optional getStatuses#

-

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

-

Inherited from KubeObjectStore.getStatuses

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsCustomResourceDefinition[]
-

Returns: Record‹string, number›

-
-

getSubscribeApis#

-

▸ getSubscribeApis(): KubeApi[]

-

Inherited from KubeObjectStore.getSubscribeApis

-

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

-

Returns: KubeApi[]

-
-

getTotalCount#

-

▸ getTotalCount(): number

-

Inherited from KubeObjectStore.getTotalCount

-

Overrides void

-

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

-

Returns: number

-
-

isSelected#

-

▸ isSelected(item: CustomResourceDefinition): boolean

-

Inherited from KubeObjectStore.isSelected

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemCustomResourceDefinition
-

Returns: boolean

-
-

isSelectedAll#

-

▸ isSelectedAll(visibleItems: CustomResourceDefinition[]): boolean

-

Inherited from KubeObjectStore.isSelectedAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsCustomResourceDefinition[]this.items
-

Returns: boolean

-
-

load#

-

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

-

Inherited from KubeObjectStore.load

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹CustomResourceDefinition›

-
-

loadAll#

-

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

-

Inherited from KubeObjectStore.loadAll

-

Overrides void

-

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

-

Parameters:

-

▪Default value options: object= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
merge?boolean
namespaces?string[]
reqInit?RequestInit
-

Returns: Promise‹void | CustomResourceDefinition[]›

-
-

loadFromPath#

-

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

-

Inherited from KubeObjectStore.loadFromPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
resourcePathstring
-

Returns: Promise‹T›

-
-

Protected loadItem#

-

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

-

Inherited from KubeObjectStore.loadItem

-

Overrides void

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹CustomResourceDefinition›

-
-

Protected loadItems#

-

▸ loadItems(__namedParameters: object): Promise‹CustomResourceDefinition[]›

-

Inherited from KubeObjectStore.loadItems

-

Overrides void

-

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

-

Parameters:

-

▪ __namedParameters: object

- - - - - - - - - - - - - - - - - - - - - -
NameType
apiKubeApi‹any›
namespacesstring[]
reqInitRequestInit
-

Returns: Promise‹CustomResourceDefinition[]›

-
-

Protected mergeItems#

-

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

-

Inherited from KubeObjectStore.mergeItems

-

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

-

Parameters:

-

▪ partialItems: CustomResourceDefinition[]

-

▪Default value __namedParameters: object= {}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleantrue
replacebooleanfalse
sortbooleantrue
updateStorebooleantrue
-

Returns: CustomResourceDefinition[]

-
-

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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
force?boolean
merge?boolean
namespaces?string[]
-

Returns: Promise‹void | T[]›

-
-

remove#

-

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

-

Inherited from KubeObjectStore.remove

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemCustomResourceDefinition
-

Returns: Promise‹void›

-
-

Protected removeItem#

-

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

-

Inherited from KubeObjectStore.removeItem

-

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

-

Parameters:

-

▪ item: CustomResourceDefinition

-

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

-

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:

- - - - - - - - - - - - - -
NameType
errorany
-

Returns: void

-
-

resetSelection#

-

▸ resetSelection(): void

-

Inherited from KubeObjectStore.resetSelection

-

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

-

Returns: void

-
-

select#

-

▸ select(item: CustomResourceDefinition): void

-

Inherited from KubeObjectStore.select

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemCustomResourceDefinition
-

Returns: void

-
-

Protected sortItems#

-

▸ sortItems(items: CustomResourceDefinition[]): CustomResourceDefinition‹›[]

-

Overrides KubeObjectStore.sortItems

-

Defined in src/renderer/components/+custom-resources/crd.store.ts:55

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsCustomResourceDefinition[]
-

Returns: CustomResourceDefinition‹›[]

-
-

subscribe#

-

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

-

Inherited from KubeObjectStore.subscribe

-

Overrides void

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
-

Returns: (Anonymous function)

-
-

toggleSelection#

-

▸ toggleSelection(item: CustomResourceDefinition): void

-

Inherited from KubeObjectStore.toggleSelection

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemCustomResourceDefinition
-

Returns: void

-
-

toggleSelectionAll#

-

▸ toggleSelectionAll(visibleItems: CustomResourceDefinition[]): void

-

Inherited from KubeObjectStore.toggleSelectionAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsCustomResourceDefinition[]this.items
-

Returns: void

-
-

unselect#

-

▸ unselect(item: CustomResourceDefinition): void

-

Inherited from KubeObjectStore.unselect

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemCustomResourceDefinition
-

Returns: void

-
-

update#

-

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

-

Inherited from KubeObjectStore.update

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
itemCustomResourceDefinition
dataPartial‹CustomResourceDefinition›
-

Returns: Promise‹CustomResourceDefinition›

-
-

Protected updateFromEventsBuffer#

-

▸ updateFromEventsBuffer(): void

-

Inherited from KubeObjectStore.updateFromEventsBuffer

-

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

-

Returns: void

-
-

Protected updateItem#

-

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

-

Inherited from KubeObjectStore.updateItem

-

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

-

Parameters:

-

▪ item: CustomResourceDefinition

-

▪ request: function

-

▸ (): Promise‹CustomResourceDefinition›

-

Returns: Promise‹T›

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.cronjobstore/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.cronjobstore/index.html deleted file mode 100644 index 6111c29d56..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.cronjobstore/index.html +++ /dev/null @@ -1,2201 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: CronJobStore - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: CronJobStore#

-

Hierarchy#

-

↳ KubeObjectStore‹CronJob›

-

↳ CronJobStore

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new CronJobStore(): CronJobStore

-

Overrides KubeObjectStore.constructor

-

Defined in src/renderer/components/+workloads-cronjobs/cronjob.store.ts:29

-

Returns: CronJobStore

-

Properties#

-

api#

-

• api: CronJobApi‹› = cronJobApi

-

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+workloads-cronjobs/cronjob.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:304

-
-

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#

-

context#

-

• get context(): ClusterContext

-

Inherited from KubeObjectStore.context

-

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

-

Returns: ClusterContext

-
-

contextItems#

-

• get contextItems(): CronJob[]

-

Inherited from KubeObjectStore.contextItems

-

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

-

Returns: CronJob[]

-
-

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(): CronJob[]

-

Inherited from KubeObjectStore.selectedItems

-

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

-

Returns: CronJob[]

-

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:306

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
delaynumber1000
-

Returns: void

-
-

create#

-

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

-

Inherited from KubeObjectStore.create

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹CronJob›

-

Returns: Promise‹CronJob›

-
-

Protected createItem#

-

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

-

Inherited from KubeObjectStore.createItem

-

Overrides void

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹CronJob›

-

Returns: Promise‹CronJob›

-
-

Protected defaultSorting#

-

▸ defaultSorting(item: CronJob): string

-

Inherited from KubeObjectStore.defaultSorting

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemCronJob
-

Returns: string

-
-

Protected filterItemsOnLoad#

-

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

-

Inherited from KubeObjectStore.filterItemsOnLoad

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsCronJob[]
-

Returns: T[]

-
-

getActiveJobsNum#

-

▸ getActiveJobsNum(cronJob: CronJob): number

-

Defined in src/renderer/components/+workloads-cronjobs/cronjob.store.ts:51

-

Parameters:

- - - - - - - - - - - - - -
NameType
cronJobCronJob
-

Returns: number

-
-

getAllByNs#

-

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

-

Inherited from KubeObjectStore.getAllByNs

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
namespacestring | string[]-
strictbooleanfalse
-

Returns: CronJob[]

-
-

getById#

-

▸ getById(id: string): T

-

Inherited from KubeObjectStore.getById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: T

-
-

getByLabel#

-

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

-

Inherited from KubeObjectStore.getByLabel

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
labelsstring[] | object
-

Returns: CronJob[]

-
-

getByName#

-

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

-

Inherited from KubeObjectStore.getByName

-

Overrides void

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: CronJob

-
-

getByPath#

-

▸ getByPath(path: string): CronJob

-

Inherited from KubeObjectStore.getByPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
pathstring
-

Returns: CronJob

-
-

getIndexById#

-

▸ getIndexById(id: string): number

-

Inherited from KubeObjectStore.getIndexById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: number

-
-

getItems#

-

▸ getItems(): CronJob[]

-

Inherited from KubeObjectStore.getItems

-

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

-

Returns: CronJob[]

-
-

getStatuses#

-

▸ getStatuses(cronJobs?: CronJob[]): object

-

Overrides KubeObjectStore.getStatuses

-

Defined in src/renderer/components/+workloads-cronjobs/cronjob.store.ts:36

-

Parameters:

- - - - - - - - - - - - - -
NameType
cronJobs?CronJob[]
-

Returns: object

-
    -
  • -

    scheduled: number = 0

    -
    • -
  • -

    suspended: number = 0

    -
    • -
-
-

getSubscribeApis#

-

▸ getSubscribeApis(): KubeApi[]

-

Inherited from KubeObjectStore.getSubscribeApis

-

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

-

Returns: KubeApi[]

-
-

getTotalCount#

-

▸ getTotalCount(): number

-

Inherited from KubeObjectStore.getTotalCount

-

Overrides void

-

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

-

Returns: number

-
-

isSelected#

-

▸ isSelected(item: CronJob): boolean

-

Inherited from KubeObjectStore.isSelected

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemCronJob
-

Returns: boolean

-
-

isSelectedAll#

-

▸ isSelectedAll(visibleItems: CronJob[]): boolean

-

Inherited from KubeObjectStore.isSelectedAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsCronJob[]this.items
-

Returns: boolean

-
-

load#

-

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

-

Inherited from KubeObjectStore.load

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹CronJob›

-
-

loadAll#

-

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

-

Inherited from KubeObjectStore.loadAll

-

Overrides void

-

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

-

Parameters:

-

▪Default value options: object= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
merge?boolean
namespaces?string[]
reqInit?RequestInit
-

Returns: Promise‹void | CronJob[]›

-
-

loadFromPath#

-

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

-

Inherited from KubeObjectStore.loadFromPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
resourcePathstring
-

Returns: Promise‹T›

-
-

Protected loadItem#

-

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

-

Inherited from KubeObjectStore.loadItem

-

Overrides void

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹CronJob›

-
-

Protected loadItems#

-

▸ loadItems(__namedParameters: object): Promise‹CronJob[]›

-

Inherited from KubeObjectStore.loadItems

-

Overrides void

-

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

-

Parameters:

-

▪ __namedParameters: object

- - - - - - - - - - - - - - - - - - - - - -
NameType
apiKubeApi‹any›
namespacesstring[]
reqInitRequestInit
-

Returns: Promise‹CronJob[]›

-
-

Protected mergeItems#

-

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

-

Inherited from KubeObjectStore.mergeItems

-

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

-

Parameters:

-

▪ partialItems: CronJob[]

-

▪Default value __namedParameters: object= {}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleantrue
replacebooleanfalse
sortbooleantrue
updateStorebooleantrue
-

Returns: CronJob[]

-
-

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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
force?boolean
merge?boolean
namespaces?string[]
-

Returns: Promise‹void | T[]›

-
-

remove#

-

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

-

Inherited from KubeObjectStore.remove

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemCronJob
-

Returns: Promise‹void›

-
-

Protected removeItem#

-

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

-

Inherited from KubeObjectStore.removeItem

-

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

-

Parameters:

-

▪ item: CronJob

-

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

-

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:

- - - - - - - - - - - - - -
NameType
errorany
-

Returns: void

-
-

resetSelection#

-

▸ resetSelection(): void

-

Inherited from KubeObjectStore.resetSelection

-

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

-

Returns: void

-
-

select#

-

▸ select(item: CronJob): void

-

Inherited from KubeObjectStore.select

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemCronJob
-

Returns: void

-
-

Protected sortItems#

-

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

-

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:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
itemsCronJob[]this.itemsthe items to be sorted (default: the current items in this store)
sortingfunction[][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: CronJob[]

-
-

subscribe#

-

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

-

Inherited from KubeObjectStore.subscribe

-

Overrides void

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
-

Returns: (Anonymous function)

-
-

toggleSelection#

-

▸ toggleSelection(item: CronJob): void

-

Inherited from KubeObjectStore.toggleSelection

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemCronJob
-

Returns: void

-
-

toggleSelectionAll#

-

▸ toggleSelectionAll(visibleItems: CronJob[]): void

-

Inherited from KubeObjectStore.toggleSelectionAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsCronJob[]this.items
-

Returns: void

-
-

unselect#

-

▸ unselect(item: CronJob): void

-

Inherited from KubeObjectStore.unselect

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemCronJob
-

Returns: void

-
-

update#

-

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

-

Inherited from KubeObjectStore.update

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
itemCronJob
dataPartial‹CronJob›
-

Returns: Promise‹CronJob›

-
-

Protected updateFromEventsBuffer#

-

▸ updateFromEventsBuffer(): void

-

Inherited from KubeObjectStore.updateFromEventsBuffer

-

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

-

Returns: void

-
-

Protected updateItem#

-

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

-

Inherited from KubeObjectStore.updateItem

-

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

-

Parameters:

-

▪ item: CronJob

-

▪ request: function

-

▸ (): Promise‹CronJob›

-

Returns: Promise‹T›

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.daemonsetstore/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.daemonsetstore/index.html deleted file mode 100644 index 2a0f366f0c..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.daemonsetstore/index.html +++ /dev/null @@ -1,2244 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: DaemonSetStore - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: DaemonSetStore#

-

Hierarchy#

-

↳ KubeObjectStore‹DaemonSet›

-

↳ DaemonSetStore

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new DaemonSetStore(): DaemonSetStore

-

Overrides KubeObjectStore.constructor

-

Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:32

-

Returns: DaemonSetStore

-

Properties#

-

api#

-

• api: KubeApi‹DaemonSet‹›› = daemonSetApi

-

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:30

-
-

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:304

-
-

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

-
-

metrics#

-

• metrics: IPodMetrics = null

-

Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:32

-
-

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(): DaemonSet[]

-

Inherited from KubeObjectStore.contextItems

-

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

-

Returns: DaemonSet[]

-
-

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(): DaemonSet[]

-

Inherited from KubeObjectStore.selectedItems

-

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

-

Returns: DaemonSet[]

-

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:306

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
delaynumber1000
-

Returns: void

-
-

create#

-

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

-

Inherited from KubeObjectStore.create

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹DaemonSet›

-

Returns: Promise‹DaemonSet›

-
-

Protected createItem#

-

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

-

Inherited from KubeObjectStore.createItem

-

Overrides void

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹DaemonSet›

-

Returns: Promise‹DaemonSet›

-
-

Protected defaultSorting#

-

▸ defaultSorting(item: DaemonSet): string

-

Inherited from KubeObjectStore.defaultSorting

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemDaemonSet
-

Returns: string

-
-

Protected filterItemsOnLoad#

-

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

-

Inherited from KubeObjectStore.filterItemsOnLoad

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsDaemonSet[]
-

Returns: T[]

-
-

getAllByNs#

-

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

-

Inherited from KubeObjectStore.getAllByNs

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
namespacestring | string[]-
strictbooleanfalse
-

Returns: DaemonSet[]

-
-

getById#

-

▸ getById(id: string): T

-

Inherited from KubeObjectStore.getById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: T

-
-

getByLabel#

-

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

-

Inherited from KubeObjectStore.getByLabel

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
labelsstring[] | object
-

Returns: DaemonSet[]

-
-

getByName#

-

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

-

Inherited from KubeObjectStore.getByName

-

Overrides void

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: DaemonSet

-
-

getByPath#

-

▸ getByPath(path: string): DaemonSet

-

Inherited from KubeObjectStore.getByPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
pathstring
-

Returns: DaemonSet

-
-

getChildPods#

-

▸ getChildPods(daemonSet: DaemonSet): Pod[]

-

Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:47

-

Parameters:

- - - - - - - - - - - - - -
NameType
daemonSetDaemonSet
-

Returns: Pod[]

-
-

getIndexById#

-

▸ getIndexById(id: string): number

-

Inherited from KubeObjectStore.getIndexById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: number

-
-

getItems#

-

▸ getItems(): DaemonSet[]

-

Inherited from KubeObjectStore.getItems

-

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

-

Returns: DaemonSet[]

-
-

getStatuses#

-

▸ getStatuses(daemonSets?: DaemonSet[]): object

-

Overrides KubeObjectStore.getStatuses

-

Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:51

-

Parameters:

- - - - - - - - - - - - - -
NameType
daemonSets?DaemonSet[]
-

Returns: object

-
    -
  • -

    failed: number = 0

    -
    • -
  • -

    pending: number = 0

    -
    • -
  • -

    running: number = 0

    -
    • -
-
-

getSubscribeApis#

-

▸ getSubscribeApis(): KubeApi[]

-

Inherited from KubeObjectStore.getSubscribeApis

-

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

-

Returns: KubeApi[]

-
-

getTotalCount#

-

▸ getTotalCount(): number

-

Inherited from KubeObjectStore.getTotalCount

-

Overrides void

-

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

-

Returns: number

-
-

isSelected#

-

▸ isSelected(item: DaemonSet): boolean

-

Inherited from KubeObjectStore.isSelected

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemDaemonSet
-

Returns: boolean

-
-

isSelectedAll#

-

▸ isSelectedAll(visibleItems: DaemonSet[]): boolean

-

Inherited from KubeObjectStore.isSelectedAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsDaemonSet[]this.items
-

Returns: boolean

-
-

load#

-

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

-

Inherited from KubeObjectStore.load

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹DaemonSet›

-
-

loadAll#

-

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

-

Inherited from KubeObjectStore.loadAll

-

Overrides void

-

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

-

Parameters:

-

▪Default value options: object= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
merge?boolean
namespaces?string[]
reqInit?RequestInit
-

Returns: Promise‹void | DaemonSet[]›

-
-

loadFromPath#

-

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

-

Inherited from KubeObjectStore.loadFromPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
resourcePathstring
-

Returns: Promise‹T›

-
-

Protected loadItem#

-

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

-

Inherited from KubeObjectStore.loadItem

-

Overrides void

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹DaemonSet›

-
-

Protected loadItems#

-

▸ loadItems(__namedParameters: object): Promise‹DaemonSet[]›

-

Inherited from KubeObjectStore.loadItems

-

Overrides void

-

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

-

Parameters:

-

▪ __namedParameters: object

- - - - - - - - - - - - - - - - - - - - - -
NameType
apiKubeApi‹any›
namespacesstring[]
reqInitRequestInit
-

Returns: Promise‹DaemonSet[]›

-
-

loadMetrics#

-

▸ loadMetrics(daemonSet: DaemonSet): Promise‹void›

-

Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:41

-

Parameters:

- - - - - - - - - - - - - -
NameType
daemonSetDaemonSet
-

Returns: Promise‹void›

-
-

Protected mergeItems#

-

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

-

Inherited from KubeObjectStore.mergeItems

-

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

-

Parameters:

-

▪ partialItems: DaemonSet[]

-

▪Default value __namedParameters: object= {}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleantrue
replacebooleanfalse
sortbooleantrue
updateStorebooleantrue
-

Returns: DaemonSet[]

-
-

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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
force?boolean
merge?boolean
namespaces?string[]
-

Returns: Promise‹void | T[]›

-
-

remove#

-

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

-

Inherited from KubeObjectStore.remove

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemDaemonSet
-

Returns: Promise‹void›

-
-

Protected removeItem#

-

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

-

Inherited from KubeObjectStore.removeItem

-

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

-

Parameters:

-

▪ item: DaemonSet

-

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

-

Returns: Promise‹void[]›

-
-

reset#

-

▸ reset(): void

-

Overrides KubeObjectStore.reset

-

Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:71

-

Returns: void

-
-

Protected resetOnError#

-

▸ resetOnError(error: any): void

-

Inherited from KubeObjectStore.resetOnError

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
errorany
-

Returns: void

-
-

resetSelection#

-

▸ resetSelection(): void

-

Inherited from KubeObjectStore.resetSelection

-

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

-

Returns: void

-
-

select#

-

▸ select(item: DaemonSet): void

-

Inherited from KubeObjectStore.select

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemDaemonSet
-

Returns: void

-
-

Protected sortItems#

-

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

-

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:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
itemsDaemonSet[]this.itemsthe items to be sorted (default: the current items in this store)
sortingfunction[][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: DaemonSet[]

-
-

subscribe#

-

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

-

Inherited from KubeObjectStore.subscribe

-

Overrides void

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
-

Returns: (Anonymous function)

-
-

toggleSelection#

-

▸ toggleSelection(item: DaemonSet): void

-

Inherited from KubeObjectStore.toggleSelection

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemDaemonSet
-

Returns: void

-
-

toggleSelectionAll#

-

▸ toggleSelectionAll(visibleItems: DaemonSet[]): void

-

Inherited from KubeObjectStore.toggleSelectionAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsDaemonSet[]this.items
-

Returns: void

-
-

unselect#

-

▸ unselect(item: DaemonSet): void

-

Inherited from KubeObjectStore.unselect

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemDaemonSet
-

Returns: void

-
-

update#

-

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

-

Inherited from KubeObjectStore.update

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
itemDaemonSet
dataPartial‹DaemonSet›
-

Returns: Promise‹DaemonSet›

-
-

Protected updateFromEventsBuffer#

-

▸ updateFromEventsBuffer(): void

-

Inherited from KubeObjectStore.updateFromEventsBuffer

-

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

-

Returns: void

-
-

Protected updateItem#

-

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

-

Inherited from KubeObjectStore.updateItem

-

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

-

Parameters:

-

▪ item: DaemonSet

-

▪ request: function

-

▸ (): Promise‹DaemonSet›

-

Returns: Promise‹T›

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.deploymentstore/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.deploymentstore/index.html deleted file mode 100644 index 812b014db6..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.deploymentstore/index.html +++ /dev/null @@ -1,2224 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: DeploymentStore - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: DeploymentStore#

-

Hierarchy#

-

↳ KubeObjectStore‹Deployment›

-

↳ DeploymentStore

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new DeploymentStore(): DeploymentStore

-

Overrides KubeObjectStore.constructor

-

Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:31

-

Returns: DeploymentStore

-

Properties#

-

api#

-

• api: DeploymentApi‹› = deploymentApi

-

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:30

-
-

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:304

-
-

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

-
-

metrics#

-

• metrics: IPodMetrics = null

-

Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:31

-
-

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(): Deployment[]

-

Inherited from KubeObjectStore.contextItems

-

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

-

Returns: Deployment[]

-
-

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(): Deployment[]

-

Inherited from KubeObjectStore.selectedItems

-

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

-

Returns: Deployment[]

-

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:306

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
delaynumber1000
-

Returns: void

-
-

create#

-

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

-

Inherited from KubeObjectStore.create

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹Deployment›

-

Returns: Promise‹Deployment›

-
-

Protected createItem#

-

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

-

Inherited from KubeObjectStore.createItem

-

Overrides void

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹Deployment›

-

Returns: Promise‹Deployment›

-
-

Protected defaultSorting#

-

▸ defaultSorting(item: Deployment): string

-

Inherited from KubeObjectStore.defaultSorting

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemDeployment
-

Returns: string

-
-

Protected filterItemsOnLoad#

-

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

-

Inherited from KubeObjectStore.filterItemsOnLoad

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsDeployment[]
-

Returns: T[]

-
-

getAllByNs#

-

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

-

Inherited from KubeObjectStore.getAllByNs

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
namespacestring | string[]-
strictbooleanfalse
-

Returns: Deployment[]

-
-

getById#

-

▸ getById(id: string): T

-

Inherited from KubeObjectStore.getById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: T

-
-

getByLabel#

-

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

-

Inherited from KubeObjectStore.getByLabel

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
labelsstring[] | object
-

Returns: Deployment[]

-
-

getByName#

-

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

-

Inherited from KubeObjectStore.getByName

-

Overrides void

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Deployment

-
-

getByPath#

-

▸ getByPath(path: string): Deployment

-

Inherited from KubeObjectStore.getByPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
pathstring
-

Returns: Deployment

-
-

getChildPods#

-

▸ getChildPods(deployment: Deployment): Pod‹›[]

-

Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:72

-

Parameters:

- - - - - - - - - - - - - -
NameType
deploymentDeployment
-

Returns: Pod‹›[]

-
-

getIndexById#

-

▸ getIndexById(id: string): number

-

Inherited from KubeObjectStore.getIndexById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: number

-
-

getItems#

-

▸ getItems(): Deployment[]

-

Inherited from KubeObjectStore.getItems

-

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

-

Returns: Deployment[]

-
-

getStatuses#

-

▸ getStatuses(deployments?: Deployment[]): object

-

Overrides KubeObjectStore.getStatuses

-

Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:52

-

Parameters:

- - - - - - - - - - - - - -
NameType
deployments?Deployment[]
-

Returns: object

-
    -
  • -

    failed: number = 0

    -
    • -
  • -

    pending: number = 0

    -
    • -
  • -

    running: number = 0

    -
    • -
-
-

getSubscribeApis#

-

▸ getSubscribeApis(): KubeApi[]

-

Inherited from KubeObjectStore.getSubscribeApis

-

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

-

Returns: KubeApi[]

-
-

getTotalCount#

-

▸ getTotalCount(): number

-

Inherited from KubeObjectStore.getTotalCount

-

Overrides void

-

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

-

Returns: number

-
-

isSelected#

-

▸ isSelected(item: Deployment): boolean

-

Inherited from KubeObjectStore.isSelected

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemDeployment
-

Returns: boolean

-
-

isSelectedAll#

-

▸ isSelectedAll(visibleItems: Deployment[]): boolean

-

Inherited from KubeObjectStore.isSelectedAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsDeployment[]this.items
-

Returns: boolean

-
-

load#

-

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

-

Inherited from KubeObjectStore.load

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹Deployment›

-
-

loadAll#

-

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

-

Inherited from KubeObjectStore.loadAll

-

Overrides void

-

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

-

Parameters:

-

▪Default value options: object= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
merge?boolean
namespaces?string[]
reqInit?RequestInit
-

Returns: Promise‹void | Deployment[]›

-
-

loadFromPath#

-

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

-

Inherited from KubeObjectStore.loadFromPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
resourcePathstring
-

Returns: Promise‹T›

-
-

Protected loadItem#

-

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

-

Inherited from KubeObjectStore.loadItem

-

Overrides void

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹Deployment›

-
-

Protected loadItems#

-

▸ loadItems(__namedParameters: object): Promise‹Deployment[]›

-

Inherited from KubeObjectStore.loadItems

-

Overrides void

-

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

-

Parameters:

-

▪ __namedParameters: object

- - - - - - - - - - - - - - - - - - - - - -
NameType
apiKubeApi‹any›
namespacesstring[]
reqInitRequestInit
-

Returns: Promise‹Deployment[]›

-
-

loadMetrics#

-

▸ loadMetrics(deployment: Deployment): Promise‹void›

-

Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:46

-

Parameters:

- - - - - - - - - - - - - -
NameType
deploymentDeployment
-

Returns: Promise‹void›

-
-

Protected mergeItems#

-

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

-

Inherited from KubeObjectStore.mergeItems

-

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

-

Parameters:

-

▪ partialItems: Deployment[]

-

▪Default value __namedParameters: object= {}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleantrue
replacebooleanfalse
sortbooleantrue
updateStorebooleantrue
-

Returns: Deployment[]

-
-

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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
force?boolean
merge?boolean
namespaces?string[]
-

Returns: Promise‹void | T[]›

-
-

remove#

-

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

-

Inherited from KubeObjectStore.remove

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemDeployment
-

Returns: Promise‹void›

-
-

Protected removeItem#

-

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

-

Inherited from KubeObjectStore.removeItem

-

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

-

Parameters:

-

▪ item: Deployment

-

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

-

Returns: Promise‹void[]›

-
-

reset#

-

▸ reset(): void

-

Overrides KubeObjectStore.reset

-

Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:78

-

Returns: void

-
-

Protected resetOnError#

-

▸ resetOnError(error: any): void

-

Inherited from KubeObjectStore.resetOnError

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
errorany
-

Returns: void

-
-

resetSelection#

-

▸ resetSelection(): void

-

Inherited from KubeObjectStore.resetSelection

-

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

-

Returns: void

-
-

select#

-

▸ select(item: Deployment): void

-

Inherited from KubeObjectStore.select

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemDeployment
-

Returns: void

-
-

Protected sortItems#

-

▸ sortItems(items: Deployment[]): Deployment‹›[]

-

Overrides KubeObjectStore.sortItems

-

Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:40

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsDeployment[]
-

Returns: Deployment‹›[]

-
-

subscribe#

-

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

-

Inherited from KubeObjectStore.subscribe

-

Overrides void

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
-

Returns: (Anonymous function)

-
-

toggleSelection#

-

▸ toggleSelection(item: Deployment): void

-

Inherited from KubeObjectStore.toggleSelection

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemDeployment
-

Returns: void

-
-

toggleSelectionAll#

-

▸ toggleSelectionAll(visibleItems: Deployment[]): void

-

Inherited from KubeObjectStore.toggleSelectionAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsDeployment[]this.items
-

Returns: void

-
-

unselect#

-

▸ unselect(item: Deployment): void

-

Inherited from KubeObjectStore.unselect

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemDeployment
-

Returns: void

-
-

update#

-

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

-

Inherited from KubeObjectStore.update

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
itemDeployment
dataPartial‹Deployment›
-

Returns: Promise‹Deployment›

-
-

Protected updateFromEventsBuffer#

-

▸ updateFromEventsBuffer(): void

-

Inherited from KubeObjectStore.updateFromEventsBuffer

-

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

-

Returns: void

-
-

Protected updateItem#

-

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

-

Inherited from KubeObjectStore.updateItem

-

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

-

Parameters:

-

▪ item: Deployment

-

▪ request: function

-

▸ (): Promise‹Deployment›

-

Returns: Promise‹T›

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.endpointstore/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.endpointstore/index.html deleted file mode 100644 index d6eaf33483..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.endpointstore/index.html +++ /dev/null @@ -1,2166 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: EndpointStore - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: EndpointStore#

-

Hierarchy#

-

↳ KubeObjectStore‹Endpoint›

-

↳ EndpointStore

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new EndpointStore(): EndpointStore

-

Inherited from KubeObjectStore.constructor

-

Overrides void

-

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

-

Returns: EndpointStore

-

Properties#

-

api#

-

• api: KubeApi‹Endpoint‹›› = endpointApi

-

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+network-endpoints/endpoints.store.ts:27

-
-

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:304

-
-

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#

-

context#

-

• get context(): ClusterContext

-

Inherited from KubeObjectStore.context

-

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

-

Returns: ClusterContext

-
-

contextItems#

-

• get contextItems(): Endpoint[]

-

Inherited from KubeObjectStore.contextItems

-

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

-

Returns: Endpoint[]

-
-

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(): Endpoint[]

-

Inherited from KubeObjectStore.selectedItems

-

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

-

Returns: Endpoint[]

-

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:306

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
delaynumber1000
-

Returns: void

-
-

create#

-

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

-

Inherited from KubeObjectStore.create

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹Endpoint›

-

Returns: Promise‹Endpoint›

-
-

Protected createItem#

-

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

-

Inherited from KubeObjectStore.createItem

-

Overrides void

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹Endpoint›

-

Returns: Promise‹Endpoint›

-
-

Protected defaultSorting#

-

▸ defaultSorting(item: Endpoint): string

-

Inherited from KubeObjectStore.defaultSorting

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemEndpoint
-

Returns: string

-
-

Protected filterItemsOnLoad#

-

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

-

Inherited from KubeObjectStore.filterItemsOnLoad

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsEndpoint[]
-

Returns: T[]

-
-

getAllByNs#

-

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

-

Inherited from KubeObjectStore.getAllByNs

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
namespacestring | string[]-
strictbooleanfalse
-

Returns: Endpoint[]

-
-

getById#

-

▸ getById(id: string): T

-

Inherited from KubeObjectStore.getById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: T

-
-

getByLabel#

-

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

-

Inherited from KubeObjectStore.getByLabel

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
labelsstring[] | object
-

Returns: Endpoint[]

-
-

getByName#

-

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

-

Inherited from KubeObjectStore.getByName

-

Overrides void

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Endpoint

-
-

getByPath#

-

▸ getByPath(path: string): Endpoint

-

Inherited from KubeObjectStore.getByPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
pathstring
-

Returns: Endpoint

-
-

getIndexById#

-

▸ getIndexById(id: string): number

-

Inherited from KubeObjectStore.getIndexById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: number

-
-

getItems#

-

▸ getItems(): Endpoint[]

-

Inherited from KubeObjectStore.getItems

-

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

-

Returns: Endpoint[]

-
-

Optional getStatuses#

-

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

-

Inherited from KubeObjectStore.getStatuses

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsEndpoint[]
-

Returns: Record‹string, number›

-
-

getSubscribeApis#

-

▸ getSubscribeApis(): KubeApi[]

-

Inherited from KubeObjectStore.getSubscribeApis

-

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

-

Returns: KubeApi[]

-
-

getTotalCount#

-

▸ getTotalCount(): number

-

Inherited from KubeObjectStore.getTotalCount

-

Overrides void

-

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

-

Returns: number

-
-

isSelected#

-

▸ isSelected(item: Endpoint): boolean

-

Inherited from KubeObjectStore.isSelected

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemEndpoint
-

Returns: boolean

-
-

isSelectedAll#

-

▸ isSelectedAll(visibleItems: Endpoint[]): boolean

-

Inherited from KubeObjectStore.isSelectedAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsEndpoint[]this.items
-

Returns: boolean

-
-

load#

-

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

-

Inherited from KubeObjectStore.load

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹Endpoint›

-
-

loadAll#

-

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

-

Inherited from KubeObjectStore.loadAll

-

Overrides void

-

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

-

Parameters:

-

▪Default value options: object= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
merge?boolean
namespaces?string[]
reqInit?RequestInit
-

Returns: Promise‹void | Endpoint[]›

-
-

loadFromPath#

-

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

-

Inherited from KubeObjectStore.loadFromPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
resourcePathstring
-

Returns: Promise‹T›

-
-

Protected loadItem#

-

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

-

Inherited from KubeObjectStore.loadItem

-

Overrides void

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹Endpoint›

-
-

Protected loadItems#

-

▸ loadItems(__namedParameters: object): Promise‹Endpoint[]›

-

Inherited from KubeObjectStore.loadItems

-

Overrides void

-

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

-

Parameters:

-

▪ __namedParameters: object

- - - - - - - - - - - - - - - - - - - - - -
NameType
apiKubeApi‹any›
namespacesstring[]
reqInitRequestInit
-

Returns: Promise‹Endpoint[]›

-
-

Protected mergeItems#

-

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

-

Inherited from KubeObjectStore.mergeItems

-

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

-

Parameters:

-

▪ partialItems: Endpoint[]

-

▪Default value __namedParameters: object= {}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleantrue
replacebooleanfalse
sortbooleantrue
updateStorebooleantrue
-

Returns: Endpoint[]

-
-

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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
force?boolean
merge?boolean
namespaces?string[]
-

Returns: Promise‹void | T[]›

-
-

remove#

-

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

-

Inherited from KubeObjectStore.remove

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemEndpoint
-

Returns: Promise‹void›

-
-

Protected removeItem#

-

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

-

Inherited from KubeObjectStore.removeItem

-

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

-

Parameters:

-

▪ item: Endpoint

-

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

-

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:

- - - - - - - - - - - - - -
NameType
errorany
-

Returns: void

-
-

resetSelection#

-

▸ resetSelection(): void

-

Inherited from KubeObjectStore.resetSelection

-

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

-

Returns: void

-
-

select#

-

▸ select(item: Endpoint): void

-

Inherited from KubeObjectStore.select

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemEndpoint
-

Returns: void

-
-

Protected sortItems#

-

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

-

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:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
itemsEndpoint[]this.itemsthe items to be sorted (default: the current items in this store)
sortingfunction[][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: Endpoint[]

-
-

subscribe#

-

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

-

Inherited from KubeObjectStore.subscribe

-

Overrides void

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
-

Returns: (Anonymous function)

-
-

toggleSelection#

-

▸ toggleSelection(item: Endpoint): void

-

Inherited from KubeObjectStore.toggleSelection

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemEndpoint
-

Returns: void

-
-

toggleSelectionAll#

-

▸ toggleSelectionAll(visibleItems: Endpoint[]): void

-

Inherited from KubeObjectStore.toggleSelectionAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsEndpoint[]this.items
-

Returns: void

-
-

unselect#

-

▸ unselect(item: Endpoint): void

-

Inherited from KubeObjectStore.unselect

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemEndpoint
-

Returns: void

-
-

update#

-

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

-

Inherited from KubeObjectStore.update

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
itemEndpoint
dataPartial‹Endpoint›
-

Returns: Promise‹Endpoint›

-
-

Protected updateFromEventsBuffer#

-

▸ updateFromEventsBuffer(): void

-

Inherited from KubeObjectStore.updateFromEventsBuffer

-

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

-

Returns: void

-
-

Protected updateItem#

-

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

-

Inherited from KubeObjectStore.updateItem

-

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

-

Parameters:

-

▪ item: Endpoint

-

▪ request: function

-

▸ (): Promise‹Endpoint›

-

Returns: Promise‹T›

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.eventstore/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.eventstore/index.html deleted file mode 100644 index 5e02208ae1..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.eventstore/index.html +++ /dev/null @@ -1,2194 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: EventStore - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: EventStore#

-

Hierarchy#

-

↳ KubeObjectStore‹KubeEvent›

-

↳ EventStore

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new EventStore(): EventStore

-

Overrides KubeObjectStore.constructor

-

Defined in src/renderer/components/+events/event.store.ts:35

-

Returns: EventStore

-

Properties#

-

api#

-

• api: KubeApi‹KubeEvent‹›› = eventApi

-

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+events/event.store.ts:33

-
-

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:304

-
-

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

-
-

limit#

-

• limit: number = 1000

-

Overrides KubeObjectStore.limit

-

Defined in src/renderer/components/+events/event.store.ts:34

-
-

saveLimit#

-

• saveLimit: number = 50000

-

Defined in src/renderer/components/+events/event.store.ts:35

-
-

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(): KubeEvent[]

-

Inherited from KubeObjectStore.contextItems

-

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

-

Returns: KubeEvent[]

-
-

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(): KubeEvent[]

-

Inherited from KubeObjectStore.selectedItems

-

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

-

Returns: KubeEvent[]

-

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(): void

-

Overrides KubeObjectStore.bindWatchEventsUpdater

-

Defined in src/renderer/components/+events/event.store.ts:42

-

Returns: void

-
-

create#

-

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

-

Inherited from KubeObjectStore.create

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹KubeEvent›

-

Returns: Promise‹KubeEvent›

-
-

Protected createItem#

-

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

-

Inherited from KubeObjectStore.createItem

-

Overrides void

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹KubeEvent›

-

Returns: Promise‹KubeEvent›

-
-

Protected defaultSorting#

-

▸ defaultSorting(item: KubeEvent): string

-

Inherited from KubeObjectStore.defaultSorting

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemKubeEvent
-

Returns: string

-
-

Protected filterItemsOnLoad#

-

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

-

Inherited from KubeObjectStore.filterItemsOnLoad

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsKubeEvent[]
-

Returns: T[]

-
-

getAllByNs#

-

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

-

Inherited from KubeObjectStore.getAllByNs

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
namespacestring | string[]-
strictbooleanfalse
-

Returns: KubeEvent[]

-
-

getById#

-

▸ getById(id: string): T

-

Inherited from KubeObjectStore.getById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: T

-
-

getByLabel#

-

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

-

Inherited from KubeObjectStore.getByLabel

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
labelsstring[] | object
-

Returns: KubeEvent[]

-
-

getByName#

-

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

-

Inherited from KubeObjectStore.getByName

-

Overrides void

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: KubeEvent

-
-

getByPath#

-

▸ getByPath(path: string): KubeEvent

-

Inherited from KubeObjectStore.getByPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
pathstring
-

Returns: KubeEvent

-
-

getEventsByObject#

-

▸ getEventsByObject(obj: KubeObject): KubeEvent[]

-

Defined in src/renderer/components/+events/event.store.ts:52

-

Parameters:

- - - - - - - - - - - - - -
NameType
objKubeObject
-

Returns: KubeEvent[]

-
-

getIndexById#

-

▸ getIndexById(id: string): number

-

Inherited from KubeObjectStore.getIndexById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: number

-
-

getItems#

-

▸ getItems(): KubeEvent[]

-

Inherited from KubeObjectStore.getItems

-

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

-

Returns: KubeEvent[]

-
-

Optional getStatuses#

-

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

-

Inherited from KubeObjectStore.getStatuses

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsKubeEvent[]
-

Returns: Record‹string, number›

-
-

getSubscribeApis#

-

▸ getSubscribeApis(): KubeApi[]

-

Inherited from KubeObjectStore.getSubscribeApis

-

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

-

Returns: KubeApi[]

-
-

getTotalCount#

-

▸ getTotalCount(): number

-

Inherited from KubeObjectStore.getTotalCount

-

Overrides void

-

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

-

Returns: number

-
-

getWarnings#

-

▸ getWarnings(): KubeEvent‹›[]

-

Defined in src/renderer/components/+events/event.store.ts:62

-

Returns: KubeEvent‹›[]

-
-

getWarningsCount#

-

▸ getWarningsCount(): number

-

Defined in src/renderer/components/+events/event.store.ts:81

-

Returns: number

-
-

isSelected#

-

▸ isSelected(item: KubeEvent): boolean

-

Inherited from KubeObjectStore.isSelected

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemKubeEvent
-

Returns: boolean

-
-

isSelectedAll#

-

▸ isSelectedAll(visibleItems: KubeEvent[]): boolean

-

Inherited from KubeObjectStore.isSelectedAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsKubeEvent[]this.items
-

Returns: boolean

-
-

load#

-

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

-

Inherited from KubeObjectStore.load

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹KubeEvent›

-
-

loadAll#

-

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

-

Inherited from KubeObjectStore.loadAll

-

Overrides void

-

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

-

Parameters:

-

▪Default value options: object= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
merge?boolean
namespaces?string[]
reqInit?RequestInit
-

Returns: Promise‹void | KubeEvent[]›

-
-

loadFromPath#

-

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

-

Inherited from KubeObjectStore.loadFromPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
resourcePathstring
-

Returns: Promise‹T›

-
-

Protected loadItem#

-

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

-

Inherited from KubeObjectStore.loadItem

-

Overrides void

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹KubeEvent›

-
-

Protected loadItems#

-

▸ loadItems(__namedParameters: object): Promise‹KubeEvent[]›

-

Inherited from KubeObjectStore.loadItems

-

Overrides void

-

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

-

Parameters:

-

▪ __namedParameters: object

- - - - - - - - - - - - - - - - - - - - - -
NameType
apiKubeApi‹any›
namespacesstring[]
reqInitRequestInit
-

Returns: Promise‹KubeEvent[]›

-
-

Protected mergeItems#

-

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

-

Inherited from KubeObjectStore.mergeItems

-

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

-

Parameters:

-

▪ partialItems: KubeEvent[]

-

▪Default value __namedParameters: object= {}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleantrue
replacebooleanfalse
sortbooleantrue
updateStorebooleantrue
-

Returns: KubeEvent[]

-
-

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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
force?boolean
merge?boolean
namespaces?string[]
-

Returns: Promise‹void | T[]›

-
-

remove#

-

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

-

Inherited from KubeObjectStore.remove

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemKubeEvent
-

Returns: Promise‹void›

-
-

Protected removeItem#

-

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

-

Inherited from KubeObjectStore.removeItem

-

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

-

Parameters:

-

▪ item: KubeEvent

-

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

-

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:

- - - - - - - - - - - - - -
NameType
errorany
-

Returns: void

-
-

resetSelection#

-

▸ resetSelection(): void

-

Inherited from KubeObjectStore.resetSelection

-

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

-

Returns: void

-
-

select#

-

▸ select(item: KubeEvent): void

-

Inherited from KubeObjectStore.select

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemKubeEvent
-

Returns: void

-
-

Protected sortItems#

-

▸ sortItems(items: KubeEvent[]): KubeEvent‹›[]

-

Overrides KubeObjectStore.sortItems

-

Defined in src/renderer/components/+events/event.store.ts:46

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsKubeEvent[]
-

Returns: KubeEvent‹›[]

-
-

subscribe#

-

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

-

Inherited from KubeObjectStore.subscribe

-

Overrides void

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
-

Returns: (Anonymous function)

-
-

toggleSelection#

-

▸ toggleSelection(item: KubeEvent): void

-

Inherited from KubeObjectStore.toggleSelection

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemKubeEvent
-

Returns: void

-
-

toggleSelectionAll#

-

▸ toggleSelectionAll(visibleItems: KubeEvent[]): void

-

Inherited from KubeObjectStore.toggleSelectionAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsKubeEvent[]this.items
-

Returns: void

-
-

unselect#

-

▸ unselect(item: KubeEvent): void

-

Inherited from KubeObjectStore.unselect

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemKubeEvent
-

Returns: void

-
-

update#

-

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

-

Inherited from KubeObjectStore.update

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
itemKubeEvent
dataPartial‹KubeEvent›
-

Returns: Promise‹KubeEvent›

-
-

Protected updateFromEventsBuffer#

-

▸ updateFromEventsBuffer(): void

-

Inherited from KubeObjectStore.updateFromEventsBuffer

-

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

-

Returns: void

-
-

Protected updateItem#

-

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

-

Inherited from KubeObjectStore.updateItem

-

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

-

Parameters:

-

▪ item: KubeEvent

-

▪ request: function

-

▸ (): Promise‹KubeEvent›

-

Returns: Promise‹T›

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.hpastore/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.hpastore/index.html deleted file mode 100644 index b7ba33fe58..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.hpastore/index.html +++ /dev/null @@ -1,2166 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: HPAStore - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: HPAStore#

-

Hierarchy#

-

↳ KubeObjectStore‹HorizontalPodAutoscaler›

-

↳ HPAStore

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new HPAStore(): HPAStore

-

Inherited from KubeObjectStore.constructor

-

Overrides void

-

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

-

Returns: HPAStore

-

Properties#

-

api#

-

• api: KubeApi‹HorizontalPodAutoscaler‹›› = hpaApi

-

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+config-autoscalers/hpa.store.ts:27

-
-

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:304

-
-

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#

-

context#

-

• get context(): ClusterContext

-

Inherited from KubeObjectStore.context

-

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

-

Returns: ClusterContext

-
-

contextItems#

-

• get contextItems(): HorizontalPodAutoscaler[]

-

Inherited from KubeObjectStore.contextItems

-

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

-

Returns: HorizontalPodAutoscaler[]

-
-

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(): HorizontalPodAutoscaler[]

-

Inherited from KubeObjectStore.selectedItems

-

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

-

Returns: HorizontalPodAutoscaler[]

-

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:306

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
delaynumber1000
-

Returns: void

-
-

create#

-

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

-

Inherited from KubeObjectStore.create

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹HorizontalPodAutoscaler›

-

Returns: Promise‹HorizontalPodAutoscaler›

-
-

Protected createItem#

-

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

-

Inherited from KubeObjectStore.createItem

-

Overrides void

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹HorizontalPodAutoscaler›

-

Returns: Promise‹HorizontalPodAutoscaler›

-
-

Protected defaultSorting#

-

▸ defaultSorting(item: HorizontalPodAutoscaler): string

-

Inherited from KubeObjectStore.defaultSorting

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemHorizontalPodAutoscaler
-

Returns: string

-
-

Protected filterItemsOnLoad#

-

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

-

Inherited from KubeObjectStore.filterItemsOnLoad

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsHorizontalPodAutoscaler[]
-

Returns: T[]

-
-

getAllByNs#

-

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

-

Inherited from KubeObjectStore.getAllByNs

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
namespacestring | string[]-
strictbooleanfalse
-

Returns: HorizontalPodAutoscaler[]

-
-

getById#

-

▸ getById(id: string): T

-

Inherited from KubeObjectStore.getById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: T

-
-

getByLabel#

-

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

-

Inherited from KubeObjectStore.getByLabel

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
labelsstring[] | object
-

Returns: HorizontalPodAutoscaler[]

-
-

getByName#

-

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

-

Inherited from KubeObjectStore.getByName

-

Overrides void

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: HorizontalPodAutoscaler

-
-

getByPath#

-

▸ getByPath(path: string): HorizontalPodAutoscaler

-

Inherited from KubeObjectStore.getByPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
pathstring
-

Returns: HorizontalPodAutoscaler

-
-

getIndexById#

-

▸ getIndexById(id: string): number

-

Inherited from KubeObjectStore.getIndexById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: number

-
-

getItems#

-

▸ getItems(): HorizontalPodAutoscaler[]

-

Inherited from KubeObjectStore.getItems

-

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

-

Returns: HorizontalPodAutoscaler[]

-
-

Optional getStatuses#

-

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

-

Inherited from KubeObjectStore.getStatuses

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsHorizontalPodAutoscaler[]
-

Returns: Record‹string, number›

-
-

getSubscribeApis#

-

▸ getSubscribeApis(): KubeApi[]

-

Inherited from KubeObjectStore.getSubscribeApis

-

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

-

Returns: KubeApi[]

-
-

getTotalCount#

-

▸ getTotalCount(): number

-

Inherited from KubeObjectStore.getTotalCount

-

Overrides void

-

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

-

Returns: number

-
-

isSelected#

-

▸ isSelected(item: HorizontalPodAutoscaler): boolean

-

Inherited from KubeObjectStore.isSelected

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemHorizontalPodAutoscaler
-

Returns: boolean

-
-

isSelectedAll#

-

▸ isSelectedAll(visibleItems: HorizontalPodAutoscaler[]): boolean

-

Inherited from KubeObjectStore.isSelectedAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsHorizontalPodAutoscaler[]this.items
-

Returns: boolean

-
-

load#

-

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

-

Inherited from KubeObjectStore.load

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹HorizontalPodAutoscaler›

-
-

loadAll#

-

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

-

Inherited from KubeObjectStore.loadAll

-

Overrides void

-

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

-

Parameters:

-

▪Default value options: object= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
merge?boolean
namespaces?string[]
reqInit?RequestInit
-

Returns: Promise‹void | HorizontalPodAutoscaler[]›

-
-

loadFromPath#

-

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

-

Inherited from KubeObjectStore.loadFromPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
resourcePathstring
-

Returns: Promise‹T›

-
-

Protected loadItem#

-

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

-

Inherited from KubeObjectStore.loadItem

-

Overrides void

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹HorizontalPodAutoscaler›

-
-

Protected loadItems#

-

▸ loadItems(__namedParameters: object): Promise‹HorizontalPodAutoscaler[]›

-

Inherited from KubeObjectStore.loadItems

-

Overrides void

-

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

-

Parameters:

-

▪ __namedParameters: object

- - - - - - - - - - - - - - - - - - - - - -
NameType
apiKubeApi‹any›
namespacesstring[]
reqInitRequestInit
-

Returns: Promise‹HorizontalPodAutoscaler[]›

-
-

Protected mergeItems#

-

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

-

Inherited from KubeObjectStore.mergeItems

-

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

-

Parameters:

-

▪ partialItems: HorizontalPodAutoscaler[]

-

▪Default value __namedParameters: object= {}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleantrue
replacebooleanfalse
sortbooleantrue
updateStorebooleantrue
-

Returns: HorizontalPodAutoscaler[]

-
-

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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
force?boolean
merge?boolean
namespaces?string[]
-

Returns: Promise‹void | T[]›

-
-

remove#

-

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

-

Inherited from KubeObjectStore.remove

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemHorizontalPodAutoscaler
-

Returns: Promise‹void›

-
-

Protected removeItem#

-

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

-

Inherited from KubeObjectStore.removeItem

-

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

-

Parameters:

-

▪ item: HorizontalPodAutoscaler

-

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

-

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:

- - - - - - - - - - - - - -
NameType
errorany
-

Returns: void

-
-

resetSelection#

-

▸ resetSelection(): void

-

Inherited from KubeObjectStore.resetSelection

-

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

-

Returns: void

-
-

select#

-

▸ select(item: HorizontalPodAutoscaler): void

-

Inherited from KubeObjectStore.select

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemHorizontalPodAutoscaler
-

Returns: void

-
-

Protected sortItems#

-

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

-

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:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
itemsHorizontalPodAutoscaler[]this.itemsthe items to be sorted (default: the current items in this store)
sortingfunction[][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: HorizontalPodAutoscaler[]

-
-

subscribe#

-

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

-

Inherited from KubeObjectStore.subscribe

-

Overrides void

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
-

Returns: (Anonymous function)

-
-

toggleSelection#

-

▸ toggleSelection(item: HorizontalPodAutoscaler): void

-

Inherited from KubeObjectStore.toggleSelection

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemHorizontalPodAutoscaler
-

Returns: void

-
-

toggleSelectionAll#

-

▸ toggleSelectionAll(visibleItems: HorizontalPodAutoscaler[]): void

-

Inherited from KubeObjectStore.toggleSelectionAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsHorizontalPodAutoscaler[]this.items
-

Returns: void

-
-

unselect#

-

▸ unselect(item: HorizontalPodAutoscaler): void

-

Inherited from KubeObjectStore.unselect

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemHorizontalPodAutoscaler
-

Returns: void

-
-

update#

-

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

-

Inherited from KubeObjectStore.update

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
itemHorizontalPodAutoscaler
dataPartial‹HorizontalPodAutoscaler›
-

Returns: Promise‹HorizontalPodAutoscaler›

-
-

Protected updateFromEventsBuffer#

-

▸ updateFromEventsBuffer(): void

-

Inherited from KubeObjectStore.updateFromEventsBuffer

-

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

-

Returns: void

-
-

Protected updateItem#

-

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

-

Inherited from KubeObjectStore.updateItem

-

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

-

Parameters:

-

▪ item: HorizontalPodAutoscaler

-

▪ request: function

-

▸ (): Promise‹HorizontalPodAutoscaler›

-

Returns: Promise‹T›

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.ingressstore/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.ingressstore/index.html deleted file mode 100644 index b7a17e93be..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.ingressstore/index.html +++ /dev/null @@ -1,2205 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: IngressStore - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: IngressStore#

-

Hierarchy#

-

↳ KubeObjectStore‹Ingress›

-

↳ IngressStore

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new IngressStore(): IngressStore

-

Overrides KubeObjectStore.constructor

-

Defined in src/renderer/components/+network-ingresses/ingress.store.ts:30

-

Returns: IngressStore

-

Properties#

-

api#

-

• api: IngressApi‹› = ingressApi

-

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+network-ingresses/ingress.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:304

-
-

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

-
-

metrics#

-

• metrics: IIngressMetrics = null

-

Defined in src/renderer/components/+network-ingresses/ingress.store.ts:30

-
-

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(): Ingress[]

-

Inherited from KubeObjectStore.contextItems

-

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

-

Returns: Ingress[]

-
-

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(): Ingress[]

-

Inherited from KubeObjectStore.selectedItems

-

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

-

Returns: Ingress[]

-

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:306

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
delaynumber1000
-

Returns: void

-
-

create#

-

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

-

Inherited from KubeObjectStore.create

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹Ingress›

-

Returns: Promise‹Ingress›

-
-

Protected createItem#

-

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

-

Inherited from KubeObjectStore.createItem

-

Overrides void

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹Ingress›

-

Returns: Promise‹Ingress›

-
-

Protected defaultSorting#

-

▸ defaultSorting(item: Ingress): string

-

Inherited from KubeObjectStore.defaultSorting

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemIngress
-

Returns: string

-
-

Protected filterItemsOnLoad#

-

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

-

Inherited from KubeObjectStore.filterItemsOnLoad

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsIngress[]
-

Returns: T[]

-
-

getAllByNs#

-

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

-

Inherited from KubeObjectStore.getAllByNs

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
namespacestring | string[]-
strictbooleanfalse
-

Returns: Ingress[]

-
-

getById#

-

▸ getById(id: string): T

-

Inherited from KubeObjectStore.getById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: T

-
-

getByLabel#

-

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

-

Inherited from KubeObjectStore.getByLabel

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
labelsstring[] | object
-

Returns: Ingress[]

-
-

getByName#

-

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

-

Inherited from KubeObjectStore.getByName

-

Overrides void

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Ingress

-
-

getByPath#

-

▸ getByPath(path: string): Ingress

-

Inherited from KubeObjectStore.getByPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
pathstring
-

Returns: Ingress

-
-

getIndexById#

-

▸ getIndexById(id: string): number

-

Inherited from KubeObjectStore.getIndexById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: number

-
-

getItems#

-

▸ getItems(): Ingress[]

-

Inherited from KubeObjectStore.getItems

-

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

-

Returns: Ingress[]

-
-

Optional getStatuses#

-

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

-

Inherited from KubeObjectStore.getStatuses

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsIngress[]
-

Returns: Record‹string, number›

-
-

getSubscribeApis#

-

▸ getSubscribeApis(): KubeApi[]

-

Inherited from KubeObjectStore.getSubscribeApis

-

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

-

Returns: KubeApi[]

-
-

getTotalCount#

-

▸ getTotalCount(): number

-

Inherited from KubeObjectStore.getTotalCount

-

Overrides void

-

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

-

Returns: number

-
-

isSelected#

-

▸ isSelected(item: Ingress): boolean

-

Inherited from KubeObjectStore.isSelected

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemIngress
-

Returns: boolean

-
-

isSelectedAll#

-

▸ isSelectedAll(visibleItems: Ingress[]): boolean

-

Inherited from KubeObjectStore.isSelectedAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsIngress[]this.items
-

Returns: boolean

-
-

load#

-

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

-

Inherited from KubeObjectStore.load

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹Ingress›

-
-

loadAll#

-

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

-

Inherited from KubeObjectStore.loadAll

-

Overrides void

-

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

-

Parameters:

-

▪Default value options: object= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
merge?boolean
namespaces?string[]
reqInit?RequestInit
-

Returns: Promise‹void | Ingress[]›

-
-

loadFromPath#

-

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

-

Inherited from KubeObjectStore.loadFromPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
resourcePathstring
-

Returns: Promise‹T›

-
-

Protected loadItem#

-

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

-

Inherited from KubeObjectStore.loadItem

-

Overrides void

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹Ingress›

-
-

Protected loadItems#

-

▸ loadItems(__namedParameters: object): Promise‹Ingress[]›

-

Inherited from KubeObjectStore.loadItems

-

Overrides void

-

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

-

Parameters:

-

▪ __namedParameters: object

- - - - - - - - - - - - - - - - - - - - - -
NameType
apiKubeApi‹any›
namespacesstring[]
reqInitRequestInit
-

Returns: Promise‹Ingress[]›

-
-

loadMetrics#

-

▸ loadMetrics(ingress: Ingress): Promise‹void›

-

Defined in src/renderer/components/+network-ingresses/ingress.store.ts:39

-

Parameters:

- - - - - - - - - - - - - -
NameType
ingressIngress
-

Returns: Promise‹void›

-
-

Protected mergeItems#

-

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

-

Inherited from KubeObjectStore.mergeItems

-

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

-

Parameters:

-

▪ partialItems: Ingress[]

-

▪Default value __namedParameters: object= {}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleantrue
replacebooleanfalse
sortbooleantrue
updateStorebooleantrue
-

Returns: Ingress[]

-
-

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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
force?boolean
merge?boolean
namespaces?string[]
-

Returns: Promise‹void | T[]›

-
-

remove#

-

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

-

Inherited from KubeObjectStore.remove

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemIngress
-

Returns: Promise‹void›

-
-

Protected removeItem#

-

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

-

Inherited from KubeObjectStore.removeItem

-

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

-

Parameters:

-

▪ item: Ingress

-

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

-

Returns: Promise‹void[]›

-
-

reset#

-

▸ reset(): void

-

Overrides KubeObjectStore.reset

-

Defined in src/renderer/components/+network-ingresses/ingress.store.ts:43

-

Returns: void

-
-

Protected resetOnError#

-

▸ resetOnError(error: any): void

-

Inherited from KubeObjectStore.resetOnError

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
errorany
-

Returns: void

-
-

resetSelection#

-

▸ resetSelection(): void

-

Inherited from KubeObjectStore.resetSelection

-

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

-

Returns: void

-
-

select#

-

▸ select(item: Ingress): void

-

Inherited from KubeObjectStore.select

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemIngress
-

Returns: void

-
-

Protected sortItems#

-

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

-

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:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
itemsIngress[]this.itemsthe items to be sorted (default: the current items in this store)
sortingfunction[][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: Ingress[]

-
-

subscribe#

-

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

-

Inherited from KubeObjectStore.subscribe

-

Overrides void

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
-

Returns: (Anonymous function)

-
-

toggleSelection#

-

▸ toggleSelection(item: Ingress): void

-

Inherited from KubeObjectStore.toggleSelection

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemIngress
-

Returns: void

-
-

toggleSelectionAll#

-

▸ toggleSelectionAll(visibleItems: Ingress[]): void

-

Inherited from KubeObjectStore.toggleSelectionAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsIngress[]this.items
-

Returns: void

-
-

unselect#

-

▸ unselect(item: Ingress): void

-

Inherited from KubeObjectStore.unselect

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemIngress
-

Returns: void

-
-

update#

-

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

-

Inherited from KubeObjectStore.update

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
itemIngress
dataPartial‹Ingress›
-

Returns: Promise‹Ingress›

-
-

Protected updateFromEventsBuffer#

-

▸ updateFromEventsBuffer(): void

-

Inherited from KubeObjectStore.updateFromEventsBuffer

-

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

-

Returns: void

-
-

Protected updateItem#

-

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

-

Inherited from KubeObjectStore.updateItem

-

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

-

Parameters:

-

▪ item: Ingress

-

▪ request: function

-

▸ (): Promise‹Ingress›

-

Returns: Promise‹T›

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.job/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.job/index.html deleted file mode 100644 index 30d18303e5..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.job/index.html +++ /dev/null @@ -1,1763 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: Job ‹**Metadata, Status, Spec**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: Job ‹Metadata, Status, Spec›#

-

Type parameters#

-

▪ Metadata: IKubeObjectMetadata

-

▪ Status

-

▪ Spec

-

Hierarchy#

-
    -
  • WorkloadKubeObject
    • -
-

↳ Job

-

Implements#

-
    -
  • ItemObject
    • -
-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new Job(data: KubeJsonApiData): Job

-

Overrides KubeObject.constructor

-

Defined in src/renderer/api/endpoints/job.api.ts:33

-

Parameters:

- - - - - - - - - - - - - -
NameType
dataKubeJsonApiData
-

Returns: Job

-

Properties#

-

apiVersion#

-

• apiVersion: string

-

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:94

-
-

kind#

-

• kind: string

-

Inherited from KubeObject.kind

-

Defined in src/renderer/api/kube-object.ts:95

-
-

metadata#

-

• metadata: Metadata

-

Inherited from KubeObject.metadata

-

Defined in src/renderer/api/kube-object.ts:96

-
-

spec#

-

• spec: object

-

Overrides KubeObject.spec

-

Defined in src/renderer/api/endpoints/job.api.ts:40

-

Type declaration:#

-
    -
  • -

    backoffLimit? : number

    -
    • -
  • -

    completions? : number

    -
    • -
  • -

    containers? : IPodContainer[]

    -
    • -
  • -

    dnsPolicy? : string

    -
    • -
  • -

    parallelism? : number

    -
    • -
  • -

    restartPolicy? : string

    -
    • -
  • -

    schedulerName? : string

    -
    • -
  • -

    selector(): object

    -
    • -
  • -

    matchLabels(): object

    -
    • -
  • -

    serviceAccount? : string

    -
    • -
  • -

    serviceAccountName? : string

    -
    • -
  • -

    template(): object

    -
    • -
  • -

    metadata(): object

    -
      -
    • -

      annotations(): object

      -
      • -
    • -

      creationTimestamp? : string

      -
      • -
    • -

      labels(): object

      -
      • -
    -
    • -
  • -

    spec(): object

    -
      -
    • -

      affinity? : IAffinity

      -
      • -
    • -

      containers: IPodContainer[]

      -
      • -
    • -

      dnsPolicy: string

      -
      • -
    • -

      hostPID: boolean

      -
      • -
    • -

      nodeSelector(): object

      -
      • -
    • -

      restartPolicy: string

      -
      • -
    • -

      schedulerName: string

      -
      • -
    • -

      terminationGracePeriodSeconds: number

      -
      • -
    • -

      tolerations? : object[]

      -
      • -
    -
    • -
  • -

    terminationGracePeriodSeconds? : number

    -
    • -
-
-

status#

-

• status: object

-

Overrides KubeObject.status

-

Defined in src/renderer/api/endpoints/job.api.ts:86

-

Type declaration:#

-
    -
  • -

    completionTime: string

    -
    • -
  • -

    conditions: object[]

    -
    • -
  • -

    startTime: string

    -
    • -
  • -

    succeeded: number

    -
    • -
-
-

Static apiBase#

-

▪ apiBase: string = "/apis/batch/v1/jobs"

-

Defined in src/renderer/api/endpoints/job.api.ts:33

-
-

Static kind#

-

▪ kind: string = "Job"

-

Overrides KubeObject.kind

-

Defined in src/renderer/api/endpoints/job.api.ts:31

-
-

Static namespaced#

-

▪ namespaced: boolean = true

-

Overrides KubeObject.namespaced

-

Defined in src/renderer/api/endpoints/job.api.ts:32

-

Accessors#

- -

• get selfLink(): string

-

Inherited from KubeObject.selfLink

-

Defined in src/renderer/api/kube-object.ts:187

-

Returns: string

-

Methods#

-

delete#

-

▸ delete(): Promise‹KubeJsonApiData›

-

Overrides KubeObject.delete

-

Defined in src/renderer/api/endpoints/job.api.ts:123

-

Returns: Promise‹KubeJsonApiData›

-
-

getAffinity#

-

▸ getAffinity(): IAffinity

-

Inherited from Deployment.getAffinity

-

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

-

Returns: IAffinity

-
-

getAffinityNumber#

-

▸ getAffinityNumber(): number

-

Inherited from Pod.getAffinityNumber

-

Defined in src/renderer/api/workload-kube-object.ts:97

-

Returns: number

-
-

getAge#

-

▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

-

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:212

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
-

Returns: string | number

-
-

getAnnotations#

-

▸ getAnnotations(filter: boolean): string[]

-

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:233

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleanfalse
-

Returns: string[]

-
-

getCompletions#

-

▸ getCompletions(): number

-

Defined in src/renderer/api/endpoints/job.api.ts:103

-

Returns: number

-
-

getCondition#

-

▸ getCondition(): object

-

Defined in src/renderer/api/endpoints/job.api.ts:111

-

Returns: object

-
    -
  • -

    lastProbeTime: string

    -
    • -
  • -

    lastTransitionTime: string

    -
    • -
  • -

    message? : string

    -
    • -
  • -

    status: string

    -
    • -
  • -

    type: string

    -
    • -
-
-

getDesiredCompletions#

-

▸ getDesiredCompletions(): number

-

Defined in src/renderer/api/endpoints/job.api.ts:99

-

Returns: number

-
-

getFinalizers#

-

▸ getFinalizers(): string[]

-

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:225

-

Returns: string[]

-
-

getId#

-

▸ getId(): string

-

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:191

-

Returns: string

-
-

getImages#

-

▸ getImages(): string[]

-

Defined in src/renderer/api/endpoints/job.api.ts:117

-

Returns: string[]

-
-

getLabels#

-

▸ getLabels(): string[]

-

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:229

-

Returns: string[]

-
-

getName#

-

▸ getName(): string

-

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:199

-

Returns: string

-
-

getNodeSelectors#

-

▸ getNodeSelectors(): string[]

-

Inherited from Deployment.getNodeSelectors

-

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

-

Returns: string[]

-
-

getNs#

-

▸ getNs(): string

-

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:203

-

Returns: string

-
-

getOwnerRefs#

-

▸ getOwnerRefs(): object[]

-

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:243

-

Returns: object[]

-
-

getParallelism#

-

▸ getParallelism(): number

-

Defined in src/renderer/api/endpoints/job.api.ts:107

-

Returns: number

-
-

getResourceVersion#

-

▸ getResourceVersion(): string

-

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:195

-

Returns: string

-
-

getSearchFields#

-

▸ getSearchFields(): string[]

-

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:252

-

Returns: string[]

-
-

getSelectors#

-

▸ getSelectors(): string[]

-

Inherited from Pod.getSelectors

-

Defined in src/renderer/api/workload-kube-object.ts:71

-

Returns: string[]

-
-

getTemplateLabels#

-

▸ getTemplateLabels(): string[]

-

Inherited from Pod.getTemplateLabels

-

Defined in src/renderer/api/workload-kube-object.ts:83

-

Returns: string[]

-
-

getTimeDiffFromNow#

-

▸ getTimeDiffFromNow(): number

-

Inherited from KubeObject.getTimeDiffFromNow

-

Defined in src/renderer/api/kube-object.ts:208

-

Returns: number

-
-

getTolerations#

-

▸ getTolerations(): IToleration[]

-

Inherited from Deployment.getTolerations

-

Defined in src/renderer/api/workload-kube-object.ts:89

-

Returns: IToleration[]

-
-

toPlainObject#

-

▸ toPlainObject(): object

-

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:264

-

Returns: object

-
-

update#

-

▸ update‹T›(data: Partial‹T›): Promise‹T›

-

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:269

-

Type parameters:

-

▪ T: KubeObject

-

Parameters:

- - - - - - - - - - - - - -
NameType
dataPartial‹T›
-

Returns: Promise‹T›

-
-

Static create#

-

▸ create(data: KubeJsonApiData): KubeObject‹IKubeObjectMetadata, any, any›

-

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:100

-

Parameters:

- - - - - - - - - - - - - -
NameType
dataKubeJsonApiData
-

Returns: KubeObject‹IKubeObjectMetadata, any, any›

-
-

Static isJsonApiData#

-

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

-

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:108

-

Parameters:

- - - - - - - - - - - - - -
NameType
objectunknown
-

Returns: object is KubeJsonApiData

-
-

Static isJsonApiDataList#

-

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

-

Inherited from KubeObject.isJsonApiDataList

-

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

-

Type parameters:

-

▪ T

-

Parameters:

-

▪ object: unknown

-

▪ verifyItem: function

-

▸ (val: unknown): val is T

-

Parameters:

- - - - - - - - - - - - - -
NameType
valunknown
-

Returns: object is KubeJsonApiDataList‹T›

-
-

Static isKubeJsonApiListMetadata#

-

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

-

Inherited from KubeObject.isKubeJsonApiListMetadata

-

Defined in src/renderer/api/kube-object.ts:117

-

Parameters:

- - - - - - - - - - - - - -
NameType
objectunknown
-

Returns: object is KubeJsonApiListMetadata

-
-

Static isKubeJsonApiMetadata#

-

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

-

Inherited from KubeObject.isKubeJsonApiMetadata

-

Defined in src/renderer/api/kube-object.ts:125

-

Parameters:

- - - - - - - - - - - - - -
NameType
objectunknown
-

Returns: object is KubeJsonApiMetadata

-
-

Static isNonSystem#

-

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

-

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:104

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemKubeJsonApiData | KubeObject
-

Returns: boolean

-
-

Static isPartialJsonApiData#

-

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

-

Inherited from KubeObject.isPartialJsonApiData

-

Defined in src/renderer/api/kube-object.ts:157

-

Parameters:

- - - - - - - - - - - - - -
NameType
objectunknown
-

Returns: object is Partial‹KubeJsonApiData›

-
-

Static isPartialJsonApiMetadata#

-

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

-

Inherited from KubeObject.isPartialJsonApiMetadata

-

Defined in src/renderer/api/kube-object.ts:141

-

Parameters:

- - - - - - - - - - - - - -
NameType
objectunknown
-

Returns: object is Partial‹KubeJsonApiMetadata›

-
-

Static stringifyLabels#

-

▸ stringifyLabels(labels?: object): string[]

-

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:176

-

Parameters:

- - - - - - - - - - - - - -
NameType
labels?object
-

Returns: string[]

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.jobstore/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.jobstore/index.html deleted file mode 100644 index 47622dafb9..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.jobstore/index.html +++ /dev/null @@ -1,2235 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: JobStore - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: JobStore#

-

Hierarchy#

-

↳ KubeObjectStore‹Job›

-

↳ JobStore

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new JobStore(): JobStore

-

Overrides KubeObjectStore.constructor

-

Defined in src/renderer/components/+workloads-jobs/job.store.ts:30

-

Returns: JobStore

-

Properties#

-

api#

-

• api: KubeApi‹Job‹›› = jobApi

-

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+workloads-jobs/job.store.ts:30

-
-

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:304

-
-

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#

-

context#

-

• get context(): ClusterContext

-

Inherited from KubeObjectStore.context

-

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

-

Returns: ClusterContext

-
-

contextItems#

-

• get contextItems(): Job[]

-

Inherited from KubeObjectStore.contextItems

-

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

-

Returns: Job[]

-
-

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(): Job[]

-

Inherited from KubeObjectStore.selectedItems

-

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

-

Returns: Job[]

-

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:306

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
delaynumber1000
-

Returns: void

-
-

create#

-

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

-

Inherited from KubeObjectStore.create

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹Job›

-

Returns: Promise‹Job›

-
-

Protected createItem#

-

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

-

Inherited from KubeObjectStore.createItem

-

Overrides void

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹Job›

-

Returns: Promise‹Job›

-
-

Protected defaultSorting#

-

▸ defaultSorting(item: Job): string

-

Inherited from KubeObjectStore.defaultSorting

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemJob
-

Returns: string

-
-

Protected filterItemsOnLoad#

-

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

-

Inherited from KubeObjectStore.filterItemsOnLoad

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsJob[]
-

Returns: T[]

-
-

getAllByNs#

-

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

-

Inherited from KubeObjectStore.getAllByNs

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
namespacestring | string[]-
strictbooleanfalse
-

Returns: Job[]

-
-

getById#

-

▸ getById(id: string): T

-

Inherited from KubeObjectStore.getById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: T

-
-

getByLabel#

-

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

-

Inherited from KubeObjectStore.getByLabel

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
labelsstring[] | object
-

Returns: Job[]

-
-

getByName#

-

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

-

Inherited from KubeObjectStore.getByName

-

Overrides void

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Job

-
-

getByPath#

-

▸ getByPath(path: string): Job

-

Inherited from KubeObjectStore.getByPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
pathstring
-

Returns: Job

-
-

getChildPods#

-

▸ getChildPods(job: Job): Pod[]

-

Defined in src/renderer/components/+workloads-jobs/job.store.ts:37

-

Parameters:

- - - - - - - - - - - - - -
NameType
jobJob
-

Returns: Pod[]

-
-

getIndexById#

-

▸ getIndexById(id: string): number

-

Inherited from KubeObjectStore.getIndexById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: number

-
-

getItems#

-

▸ getItems(): Job[]

-

Inherited from KubeObjectStore.getItems

-

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

-

Returns: Job[]

-
-

getJobsByOwner#

-

▸ getJobsByOwner(cronJob: CronJob): Job‹›[]

-

Defined in src/renderer/components/+workloads-jobs/job.store.ts:41

-

Parameters:

- - - - - - - - - - - - - -
NameType
cronJobCronJob
-

Returns: Job‹›[]

-
-

getStatuses#

-

▸ getStatuses(jobs?: Job[]): object

-

Overrides KubeObjectStore.getStatuses

-

Defined in src/renderer/components/+workloads-jobs/job.store.ts:48

-

Parameters:

- - - - - - - - - - - - - -
NameType
jobs?Job[]
-

Returns: object

-
    -
  • -

    failed: number = 0

    -
    • -
  • -

    pending: number = 0

    -
    • -
  • -

    running: number = 0

    -
    • -
  • -

    succeeded: number = 0

    -
    • -
-
-

getSubscribeApis#

-

▸ getSubscribeApis(): KubeApi[]

-

Inherited from KubeObjectStore.getSubscribeApis

-

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

-

Returns: KubeApi[]

-
-

getTotalCount#

-

▸ getTotalCount(): number

-

Inherited from KubeObjectStore.getTotalCount

-

Overrides void

-

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

-

Returns: number

-
-

isSelected#

-

▸ isSelected(item: Job): boolean

-

Inherited from KubeObjectStore.isSelected

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemJob
-

Returns: boolean

-
-

isSelectedAll#

-

▸ isSelectedAll(visibleItems: Job[]): boolean

-

Inherited from KubeObjectStore.isSelectedAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsJob[]this.items
-

Returns: boolean

-
-

load#

-

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

-

Inherited from KubeObjectStore.load

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹Job›

-
-

loadAll#

-

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

-

Inherited from KubeObjectStore.loadAll

-

Overrides void

-

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

-

Parameters:

-

▪Default value options: object= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
merge?boolean
namespaces?string[]
reqInit?RequestInit
-

Returns: Promise‹void | Job[]›

-
-

loadFromPath#

-

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

-

Inherited from KubeObjectStore.loadFromPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
resourcePathstring
-

Returns: Promise‹T›

-
-

Protected loadItem#

-

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

-

Inherited from KubeObjectStore.loadItem

-

Overrides void

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹Job›

-
-

Protected loadItems#

-

▸ loadItems(__namedParameters: object): Promise‹Job[]›

-

Inherited from KubeObjectStore.loadItems

-

Overrides void

-

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

-

Parameters:

-

▪ __namedParameters: object

- - - - - - - - - - - - - - - - - - - - - -
NameType
apiKubeApi‹any›
namespacesstring[]
reqInitRequestInit
-

Returns: Promise‹Job[]›

-
-

Protected mergeItems#

-

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

-

Inherited from KubeObjectStore.mergeItems

-

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

-

Parameters:

-

▪ partialItems: Job[]

-

▪Default value __namedParameters: object= {}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleantrue
replacebooleanfalse
sortbooleantrue
updateStorebooleantrue
-

Returns: Job[]

-
-

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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
force?boolean
merge?boolean
namespaces?string[]
-

Returns: Promise‹void | T[]›

-
-

remove#

-

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

-

Inherited from KubeObjectStore.remove

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemJob
-

Returns: Promise‹void›

-
-

Protected removeItem#

-

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

-

Inherited from KubeObjectStore.removeItem

-

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

-

Parameters:

-

▪ item: Job

-

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

-

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:

- - - - - - - - - - - - - -
NameType
errorany
-

Returns: void

-
-

resetSelection#

-

▸ resetSelection(): void

-

Inherited from KubeObjectStore.resetSelection

-

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

-

Returns: void

-
-

select#

-

▸ select(item: Job): void

-

Inherited from KubeObjectStore.select

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemJob
-

Returns: void

-
-

Protected sortItems#

-

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

-

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:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
itemsJob[]this.itemsthe items to be sorted (default: the current items in this store)
sortingfunction[][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: Job[]

-
-

subscribe#

-

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

-

Inherited from KubeObjectStore.subscribe

-

Overrides void

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
-

Returns: (Anonymous function)

-
-

toggleSelection#

-

▸ toggleSelection(item: Job): void

-

Inherited from KubeObjectStore.toggleSelection

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemJob
-

Returns: void

-
-

toggleSelectionAll#

-

▸ toggleSelectionAll(visibleItems: Job[]): void

-

Inherited from KubeObjectStore.toggleSelectionAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsJob[]this.items
-

Returns: void

-
-

unselect#

-

▸ unselect(item: Job): void

-

Inherited from KubeObjectStore.unselect

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemJob
-

Returns: void

-
-

update#

-

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

-

Inherited from KubeObjectStore.update

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
itemJob
dataPartial‹Job›
-

Returns: Promise‹Job›

-
-

Protected updateFromEventsBuffer#

-

▸ updateFromEventsBuffer(): void

-

Inherited from KubeObjectStore.updateFromEventsBuffer

-

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

-

Returns: void

-
-

Protected updateItem#

-

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

-

Inherited from KubeObjectStore.updateItem

-

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

-

Parameters:

-

▪ item: Job

-

▪ request: function

-

▸ (): Promise‹Job›

-

Returns: Promise‹T›

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.limitrangesstore/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.limitrangesstore/index.html deleted file mode 100644 index d66b76a573..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.limitrangesstore/index.html +++ /dev/null @@ -1,2166 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: LimitRangesStore - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: LimitRangesStore#

-

Hierarchy#

-

↳ KubeObjectStore‹LimitRange›

-

↳ LimitRangesStore

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new LimitRangesStore(): LimitRangesStore

-

Inherited from KubeObjectStore.constructor

-

Overrides void

-

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

-

Returns: LimitRangesStore

-

Properties#

-

api#

-

• api: KubeApi‹LimitRange‹›› = limitRangeApi

-

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+config-limit-ranges/limit-ranges.store.ts:27

-
-

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:304

-
-

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#

-

context#

-

• get context(): ClusterContext

-

Inherited from KubeObjectStore.context

-

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

-

Returns: ClusterContext

-
-

contextItems#

-

• get contextItems(): LimitRange[]

-

Inherited from KubeObjectStore.contextItems

-

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

-

Returns: LimitRange[]

-
-

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(): LimitRange[]

-

Inherited from KubeObjectStore.selectedItems

-

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

-

Returns: LimitRange[]

-

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:306

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
delaynumber1000
-

Returns: void

-
-

create#

-

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

-

Inherited from KubeObjectStore.create

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹LimitRange›

-

Returns: Promise‹LimitRange›

-
-

Protected createItem#

-

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

-

Inherited from KubeObjectStore.createItem

-

Overrides void

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹LimitRange›

-

Returns: Promise‹LimitRange›

-
-

Protected defaultSorting#

-

▸ defaultSorting(item: LimitRange): string

-

Inherited from KubeObjectStore.defaultSorting

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemLimitRange
-

Returns: string

-
-

Protected filterItemsOnLoad#

-

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

-

Inherited from KubeObjectStore.filterItemsOnLoad

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsLimitRange[]
-

Returns: T[]

-
-

getAllByNs#

-

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

-

Inherited from KubeObjectStore.getAllByNs

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
namespacestring | string[]-
strictbooleanfalse
-

Returns: LimitRange[]

-
-

getById#

-

▸ getById(id: string): T

-

Inherited from KubeObjectStore.getById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: T

-
-

getByLabel#

-

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

-

Inherited from KubeObjectStore.getByLabel

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
labelsstring[] | object
-

Returns: LimitRange[]

-
-

getByName#

-

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

-

Inherited from KubeObjectStore.getByName

-

Overrides void

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: LimitRange

-
-

getByPath#

-

▸ getByPath(path: string): LimitRange

-

Inherited from KubeObjectStore.getByPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
pathstring
-

Returns: LimitRange

-
-

getIndexById#

-

▸ getIndexById(id: string): number

-

Inherited from KubeObjectStore.getIndexById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: number

-
-

getItems#

-

▸ getItems(): LimitRange[]

-

Inherited from KubeObjectStore.getItems

-

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

-

Returns: LimitRange[]

-
-

Optional getStatuses#

-

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

-

Inherited from KubeObjectStore.getStatuses

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsLimitRange[]
-

Returns: Record‹string, number›

-
-

getSubscribeApis#

-

▸ getSubscribeApis(): KubeApi[]

-

Inherited from KubeObjectStore.getSubscribeApis

-

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

-

Returns: KubeApi[]

-
-

getTotalCount#

-

▸ getTotalCount(): number

-

Inherited from KubeObjectStore.getTotalCount

-

Overrides void

-

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

-

Returns: number

-
-

isSelected#

-

▸ isSelected(item: LimitRange): boolean

-

Inherited from KubeObjectStore.isSelected

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemLimitRange
-

Returns: boolean

-
-

isSelectedAll#

-

▸ isSelectedAll(visibleItems: LimitRange[]): boolean

-

Inherited from KubeObjectStore.isSelectedAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsLimitRange[]this.items
-

Returns: boolean

-
-

load#

-

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

-

Inherited from KubeObjectStore.load

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹LimitRange›

-
-

loadAll#

-

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

-

Inherited from KubeObjectStore.loadAll

-

Overrides void

-

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

-

Parameters:

-

▪Default value options: object= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
merge?boolean
namespaces?string[]
reqInit?RequestInit
-

Returns: Promise‹void | LimitRange[]›

-
-

loadFromPath#

-

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

-

Inherited from KubeObjectStore.loadFromPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
resourcePathstring
-

Returns: Promise‹T›

-
-

Protected loadItem#

-

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

-

Inherited from KubeObjectStore.loadItem

-

Overrides void

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹LimitRange›

-
-

Protected loadItems#

-

▸ loadItems(__namedParameters: object): Promise‹LimitRange[]›

-

Inherited from KubeObjectStore.loadItems

-

Overrides void

-

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

-

Parameters:

-

▪ __namedParameters: object

- - - - - - - - - - - - - - - - - - - - - -
NameType
apiKubeApi‹any›
namespacesstring[]
reqInitRequestInit
-

Returns: Promise‹LimitRange[]›

-
-

Protected mergeItems#

-

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

-

Inherited from KubeObjectStore.mergeItems

-

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

-

Parameters:

-

▪ partialItems: LimitRange[]

-

▪Default value __namedParameters: object= {}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleantrue
replacebooleanfalse
sortbooleantrue
updateStorebooleantrue
-

Returns: LimitRange[]

-
-

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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
force?boolean
merge?boolean
namespaces?string[]
-

Returns: Promise‹void | T[]›

-
-

remove#

-

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

-

Inherited from KubeObjectStore.remove

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemLimitRange
-

Returns: Promise‹void›

-
-

Protected removeItem#

-

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

-

Inherited from KubeObjectStore.removeItem

-

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

-

Parameters:

-

▪ item: LimitRange

-

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

-

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:

- - - - - - - - - - - - - -
NameType
errorany
-

Returns: void

-
-

resetSelection#

-

▸ resetSelection(): void

-

Inherited from KubeObjectStore.resetSelection

-

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

-

Returns: void

-
-

select#

-

▸ select(item: LimitRange): void

-

Inherited from KubeObjectStore.select

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemLimitRange
-

Returns: void

-
-

Protected sortItems#

-

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

-

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:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
itemsLimitRange[]this.itemsthe items to be sorted (default: the current items in this store)
sortingfunction[][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: LimitRange[]

-
-

subscribe#

-

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

-

Inherited from KubeObjectStore.subscribe

-

Overrides void

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
-

Returns: (Anonymous function)

-
-

toggleSelection#

-

▸ toggleSelection(item: LimitRange): void

-

Inherited from KubeObjectStore.toggleSelection

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemLimitRange
-

Returns: void

-
-

toggleSelectionAll#

-

▸ toggleSelectionAll(visibleItems: LimitRange[]): void

-

Inherited from KubeObjectStore.toggleSelectionAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsLimitRange[]this.items
-

Returns: void

-
-

unselect#

-

▸ unselect(item: LimitRange): void

-

Inherited from KubeObjectStore.unselect

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemLimitRange
-

Returns: void

-
-

update#

-

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

-

Inherited from KubeObjectStore.update

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
itemLimitRange
dataPartial‹LimitRange›
-

Returns: Promise‹LimitRange›

-
-

Protected updateFromEventsBuffer#

-

▸ updateFromEventsBuffer(): void

-

Inherited from KubeObjectStore.updateFromEventsBuffer

-

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

-

Returns: void

-
-

Protected updateItem#

-

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

-

Inherited from KubeObjectStore.updateItem

-

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

-

Parameters:

-

▪ item: LimitRange

-

▪ request: function

-

▸ (): Promise‹LimitRange›

-

Returns: Promise‹T›

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.namespacestore/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.namespacestore/index.html deleted file mode 100644 index 84db71f1bb..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.namespacestore/index.html +++ /dev/null @@ -1,2379 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: NamespaceStore - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - 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:304

-
-

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:306

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
delaynumber1000
-

Returns: void

-
-

clearSelected#

-

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

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
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

- - - - - - - - - - - - - - - - - -
NameType
namestring
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

- - - - - - - - - - - - - - - - - -
NameType
namestring
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:

- - - - - - - - - - - - - -
NameType
itemNamespace
-

Returns: string

-
-

Protected filterItemsOnLoad#

-

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

-

Inherited from KubeObjectStore.filterItemsOnLoad

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsNamespace[]
-

Returns: T[]

-
-

getAllByNs#

-

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

-

Inherited from KubeObjectStore.getAllByNs

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
namespacestring | string[]-
strictbooleanfalse
-

Returns: Namespace[]

-
-

getById#

-

▸ getById(id: string): T

-

Inherited from KubeObjectStore.getById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: T

-
-

getByLabel#

-

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

-

Inherited from KubeObjectStore.getByLabel

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
labelsstring[] | 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:

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Namespace

-
-

getByPath#

-

▸ getByPath(path: string): Namespace

-

Inherited from KubeObjectStore.getByPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
pathstring
-

Returns: Namespace

-
-

getIndexById#

-

▸ getIndexById(id: string): number

-

Inherited from KubeObjectStore.getIndexById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

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:

- - - - - - - - - - - - - -
NameType
itemsNamespace[]
-

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:

- - - - - - - - - - - - - -
NameType
namespacesstring | string[]
-

Returns: boolean

-
-

isSelected#

-

▸ isSelected(item: Namespace): boolean

-

Inherited from KubeObjectStore.isSelected

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemNamespace
-

Returns: boolean

-
-

isSelectedAll#

-

▸ isSelectedAll(visibleItems: Namespace[]): boolean

-

Inherited from KubeObjectStore.isSelectedAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsNamespace[]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

- - - - - - - - - - - - - - - - - -
NameType
namestring
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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
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:

- - - - - - - - - - - - - -
NameType
resourcePathstring
-

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

- - - - - - - - - - - - - - - - - -
NameType
namestring
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:

- - - - - - - - - - - - - -
NameType
paramsKubeObjectStoreLoadingParams
-

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= {}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleantrue
replacebooleanfalse
sortbooleantrue
updateStorebooleantrue
-

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:

- - - - - - - - - - - - - -
NameType
namespacesstring[]
-

▪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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
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:

- - - - - - - - - - - - - -
NameType
itemNamespace
-

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:299

-

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:

- - - - - - - - - - - - - -
NameType
errorany
-

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:

- - - - - - - - - - - - - -
NameType
itemNamespace
-

Returns: void

-
-

selectNamespaces#

-

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

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
namespacestring | 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:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
itemsNamespace[]this.itemsthe items to be sorted (default: the current items in this store)
sortingfunction[][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:316

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
-

Returns: (Anonymous function)

-
-

toggleAll#

-

▸ toggleAll(showAll?: boolean): void

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
showAll?boolean
-

Returns: void

-
-

toggleContext#

-

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

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
namespacesstring | string[]
-

Returns: void

-
-

toggleSelection#

-

▸ toggleSelection(item: Namespace): void

-

Inherited from KubeObjectStore.toggleSelection

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemNamespace
-

Returns: void

-
-

toggleSelectionAll#

-

▸ toggleSelectionAll(visibleItems: Namespace[]): void

-

Inherited from KubeObjectStore.toggleSelectionAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsNamespace[]this.items
-

Returns: void

-
-

unselect#

-

▸ unselect(item: Namespace): void

-

Inherited from KubeObjectStore.unselect

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemNamespace
-

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:

- - - - - - - - - - - - - - - - - -
NameType
itemNamespace
dataPartial‹Namespace›
-

Returns: Promise‹Namespace›

-
-

Protected updateFromEventsBuffer#

-

▸ updateFromEventsBuffer(): void

-

Inherited from KubeObjectStore.updateFromEventsBuffer

-

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

-

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›

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.networkpolicystore/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.networkpolicystore/index.html deleted file mode 100644 index c90cd54d23..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.networkpolicystore/index.html +++ /dev/null @@ -1,2166 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: NetworkPolicyStore - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: NetworkPolicyStore#

-

Hierarchy#

-

↳ KubeObjectStore‹NetworkPolicy›

-

↳ NetworkPolicyStore

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new NetworkPolicyStore(): NetworkPolicyStore

-

Inherited from KubeObjectStore.constructor

-

Overrides void

-

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

-

Returns: NetworkPolicyStore

-

Properties#

-

api#

-

• api: KubeApi‹NetworkPolicy‹›› = networkPolicyApi

-

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+network-policies/network-policy.store.ts:27

-
-

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:304

-
-

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#

-

context#

-

• get context(): ClusterContext

-

Inherited from KubeObjectStore.context

-

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

-

Returns: ClusterContext

-
-

contextItems#

-

• get contextItems(): NetworkPolicy[]

-

Inherited from KubeObjectStore.contextItems

-

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

-

Returns: NetworkPolicy[]

-
-

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(): NetworkPolicy[]

-

Inherited from KubeObjectStore.selectedItems

-

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

-

Returns: NetworkPolicy[]

-

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:306

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
delaynumber1000
-

Returns: void

-
-

create#

-

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

-

Inherited from KubeObjectStore.create

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹NetworkPolicy›

-

Returns: Promise‹NetworkPolicy›

-
-

Protected createItem#

-

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

-

Inherited from KubeObjectStore.createItem

-

Overrides void

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹NetworkPolicy›

-

Returns: Promise‹NetworkPolicy›

-
-

Protected defaultSorting#

-

▸ defaultSorting(item: NetworkPolicy): string

-

Inherited from KubeObjectStore.defaultSorting

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemNetworkPolicy
-

Returns: string

-
-

Protected filterItemsOnLoad#

-

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

-

Inherited from KubeObjectStore.filterItemsOnLoad

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsNetworkPolicy[]
-

Returns: T[]

-
-

getAllByNs#

-

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

-

Inherited from KubeObjectStore.getAllByNs

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
namespacestring | string[]-
strictbooleanfalse
-

Returns: NetworkPolicy[]

-
-

getById#

-

▸ getById(id: string): T

-

Inherited from KubeObjectStore.getById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: T

-
-

getByLabel#

-

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

-

Inherited from KubeObjectStore.getByLabel

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
labelsstring[] | object
-

Returns: NetworkPolicy[]

-
-

getByName#

-

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

-

Inherited from KubeObjectStore.getByName

-

Overrides void

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: NetworkPolicy

-
-

getByPath#

-

▸ getByPath(path: string): NetworkPolicy

-

Inherited from KubeObjectStore.getByPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
pathstring
-

Returns: NetworkPolicy

-
-

getIndexById#

-

▸ getIndexById(id: string): number

-

Inherited from KubeObjectStore.getIndexById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: number

-
-

getItems#

-

▸ getItems(): NetworkPolicy[]

-

Inherited from KubeObjectStore.getItems

-

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

-

Returns: NetworkPolicy[]

-
-

Optional getStatuses#

-

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

-

Inherited from KubeObjectStore.getStatuses

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsNetworkPolicy[]
-

Returns: Record‹string, number›

-
-

getSubscribeApis#

-

▸ getSubscribeApis(): KubeApi[]

-

Inherited from KubeObjectStore.getSubscribeApis

-

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

-

Returns: KubeApi[]

-
-

getTotalCount#

-

▸ getTotalCount(): number

-

Inherited from KubeObjectStore.getTotalCount

-

Overrides void

-

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

-

Returns: number

-
-

isSelected#

-

▸ isSelected(item: NetworkPolicy): boolean

-

Inherited from KubeObjectStore.isSelected

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemNetworkPolicy
-

Returns: boolean

-
-

isSelectedAll#

-

▸ isSelectedAll(visibleItems: NetworkPolicy[]): boolean

-

Inherited from KubeObjectStore.isSelectedAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsNetworkPolicy[]this.items
-

Returns: boolean

-
-

load#

-

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

-

Inherited from KubeObjectStore.load

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹NetworkPolicy›

-
-

loadAll#

-

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

-

Inherited from KubeObjectStore.loadAll

-

Overrides void

-

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

-

Parameters:

-

▪Default value options: object= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
merge?boolean
namespaces?string[]
reqInit?RequestInit
-

Returns: Promise‹void | NetworkPolicy[]›

-
-

loadFromPath#

-

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

-

Inherited from KubeObjectStore.loadFromPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
resourcePathstring
-

Returns: Promise‹T›

-
-

Protected loadItem#

-

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

-

Inherited from KubeObjectStore.loadItem

-

Overrides void

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹NetworkPolicy›

-
-

Protected loadItems#

-

▸ loadItems(__namedParameters: object): Promise‹NetworkPolicy[]›

-

Inherited from KubeObjectStore.loadItems

-

Overrides void

-

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

-

Parameters:

-

▪ __namedParameters: object

- - - - - - - - - - - - - - - - - - - - - -
NameType
apiKubeApi‹any›
namespacesstring[]
reqInitRequestInit
-

Returns: Promise‹NetworkPolicy[]›

-
-

Protected mergeItems#

-

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

-

Inherited from KubeObjectStore.mergeItems

-

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

-

Parameters:

-

▪ partialItems: NetworkPolicy[]

-

▪Default value __namedParameters: object= {}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleantrue
replacebooleanfalse
sortbooleantrue
updateStorebooleantrue
-

Returns: NetworkPolicy[]

-
-

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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
force?boolean
merge?boolean
namespaces?string[]
-

Returns: Promise‹void | T[]›

-
-

remove#

-

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

-

Inherited from KubeObjectStore.remove

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemNetworkPolicy
-

Returns: Promise‹void›

-
-

Protected removeItem#

-

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

-

Inherited from KubeObjectStore.removeItem

-

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

-

Parameters:

-

▪ item: NetworkPolicy

-

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

-

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:

- - - - - - - - - - - - - -
NameType
errorany
-

Returns: void

-
-

resetSelection#

-

▸ resetSelection(): void

-

Inherited from KubeObjectStore.resetSelection

-

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

-

Returns: void

-
-

select#

-

▸ select(item: NetworkPolicy): void

-

Inherited from KubeObjectStore.select

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemNetworkPolicy
-

Returns: void

-
-

Protected sortItems#

-

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

-

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:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
itemsNetworkPolicy[]this.itemsthe items to be sorted (default: the current items in this store)
sortingfunction[][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: NetworkPolicy[]

-
-

subscribe#

-

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

-

Inherited from KubeObjectStore.subscribe

-

Overrides void

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
-

Returns: (Anonymous function)

-
-

toggleSelection#

-

▸ toggleSelection(item: NetworkPolicy): void

-

Inherited from KubeObjectStore.toggleSelection

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemNetworkPolicy
-

Returns: void

-
-

toggleSelectionAll#

-

▸ toggleSelectionAll(visibleItems: NetworkPolicy[]): void

-

Inherited from KubeObjectStore.toggleSelectionAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsNetworkPolicy[]this.items
-

Returns: void

-
-

unselect#

-

▸ unselect(item: NetworkPolicy): void

-

Inherited from KubeObjectStore.unselect

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemNetworkPolicy
-

Returns: void

-
-

update#

-

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

-

Inherited from KubeObjectStore.update

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
itemNetworkPolicy
dataPartial‹NetworkPolicy›
-

Returns: Promise‹NetworkPolicy›

-
-

Protected updateFromEventsBuffer#

-

▸ updateFromEventsBuffer(): void

-

Inherited from KubeObjectStore.updateFromEventsBuffer

-

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

-

Returns: void

-
-

Protected updateItem#

-

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

-

Inherited from KubeObjectStore.updateItem

-

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

-

Parameters:

-

▪ item: NetworkPolicy

-

▪ request: function

-

▸ (): Promise‹NetworkPolicy›

-

Returns: Promise‹T›

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.nodesstore/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.nodesstore/index.html deleted file mode 100644 index d9168994f0..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.nodesstore/index.html +++ /dev/null @@ -1,2325 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: NodesStore - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: NodesStore#

-

Hierarchy#

-

↳ KubeObjectStore‹Node›

-

↳ NodesStore

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new NodesStore(): NodesStore

-

Overrides KubeObjectStore.constructor

-

Defined in src/renderer/components/+nodes/nodes.store.ts:35

-

Returns: NodesStore

-

Properties#

-

api#

-

• api: NodesApi‹› = nodesApi

-

Overrides KubeObjectStore.api

-

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

-
-

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:304

-
-

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

-
-

metrics#

-

• metrics: Partial‹INodeMetrics›

-

Defined in src/renderer/components/+nodes/nodes.store.ts:32

-
-

metricsLoaded#

-

• metricsLoaded: boolean = false

-

Defined in src/renderer/components/+nodes/nodes.store.ts:35

-
-

metricsLoading#

-

• metricsLoading: boolean = false

-

Defined in src/renderer/components/+nodes/nodes.store.ts:34

-
-

nodeMetrics#

-

• nodeMetrics: Partial‹IClusterMetrics› = null

-

Defined in src/renderer/components/+nodes/nodes.store.ts:33

-
-

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(): Node[]

-

Inherited from KubeObjectStore.contextItems

-

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

-

Returns: Node[]

-
-

contextReady#

-

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

-

Inherited from KubeObjectStore.contextReady

-

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

-

Returns: Promise‹void› & object

-
-

masterNodes#

-

• get masterNodes(): Node‹›[]

-

Defined in src/renderer/components/+nodes/nodes.store.ts:61

-

Returns: Node‹›[]

-
-

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(): Node[]

-

Inherited from KubeObjectStore.selectedItems

-

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

-

Returns: Node[]

-
-

workerNodes#

-

• get workerNodes(): Node‹›[]

-

Defined in src/renderer/components/+nodes/nodes.store.ts:65

-

Returns: Node‹›[]

-

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:306

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
delaynumber1000
-

Returns: void

-
-

create#

-

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

-

Inherited from KubeObjectStore.create

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹Node›

-

Returns: Promise‹Node›

-
-

Protected createItem#

-

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

-

Inherited from KubeObjectStore.createItem

-

Overrides void

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹Node›

-

Returns: Promise‹Node›

-
-

Protected defaultSorting#

-

▸ defaultSorting(item: Node): string

-

Inherited from KubeObjectStore.defaultSorting

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemNode
-

Returns: string

-
-

Protected filterItemsOnLoad#

-

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

-

Inherited from KubeObjectStore.filterItemsOnLoad

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsNode[]
-

Returns: T[]

-
-

getAllByNs#

-

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

-

Inherited from KubeObjectStore.getAllByNs

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
namespacestring | string[]-
strictbooleanfalse
-

Returns: Node[]

-
-

getById#

-

▸ getById(id: string): T

-

Inherited from KubeObjectStore.getById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: T

-
-

getByLabel#

-

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

-

Inherited from KubeObjectStore.getByLabel

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
labelsstring[] | object
-

Returns: Node[]

-
-

getByName#

-

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

-

Inherited from KubeObjectStore.getByName

-

Overrides void

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Node

-
-

getByPath#

-

▸ getByPath(path: string): Node

-

Inherited from KubeObjectStore.getByPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
pathstring
-

Returns: Node

-
-

getIndexById#

-

▸ getIndexById(id: string): number

-

Inherited from KubeObjectStore.getIndexById

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: number

-
-

getItems#

-

▸ getItems(): Node[]

-

Inherited from KubeObjectStore.getItems

-

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

-

Returns: Node[]

-
-

getLastMetricValues#

-

▸ getLastMetricValues(node: Node, metricNames: string[]): number[]

-

Defined in src/renderer/components/+nodes/nodes.store.ts:69

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
nodeNode
metricNamesstring[]
-

Returns: number[]

-
-

Optional getStatuses#

-

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

-

Inherited from KubeObjectStore.getStatuses

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsNode[]
-

Returns: Record‹string, number›

-
-

getSubscribeApis#

-

▸ getSubscribeApis(): KubeApi[]

-

Inherited from KubeObjectStore.getSubscribeApis

-

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

-

Returns: KubeApi[]

-
-

getTotalCount#

-

▸ getTotalCount(): number

-

Inherited from KubeObjectStore.getTotalCount

-

Overrides void

-

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

-

Returns: number

-
-

getWarningsCount#

-

▸ getWarningsCount(): number

-

Defined in src/renderer/components/+nodes/nodes.store.ts:93

-

Returns: number

-
-

isSelected#

-

▸ isSelected(item: Node): boolean

-

Inherited from KubeObjectStore.isSelected

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemNode
-

Returns: boolean

-
-

isSelectedAll#

-

▸ isSelectedAll(visibleItems: Node[]): boolean

-

Inherited from KubeObjectStore.isSelectedAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsNode[]this.items
-

Returns: boolean

-
-

load#

-

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

-

Inherited from KubeObjectStore.load

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹Node›

-
-

loadAll#

-

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

-

Inherited from KubeObjectStore.loadAll

-

Overrides void

-

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

-

Parameters:

-

▪Default value options: object= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
merge?boolean
namespaces?string[]
reqInit?RequestInit
-

Returns: Promise‹void | Node[]›

-
-

loadFromPath#

-

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

-

Inherited from KubeObjectStore.loadFromPath

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
resourcePathstring
-

Returns: Promise‹T›

-
-

Protected loadItem#

-

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

-

Inherited from KubeObjectStore.loadItem

-

Overrides void

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹Node›

-
-

Protected loadItems#

-

▸ loadItems(__namedParameters: object): Promise‹Node[]›

-

Inherited from KubeObjectStore.loadItems

-

Overrides void

-

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

-

Parameters:

-

▪ __namedParameters: object

- - - - - - - - - - - - - - - - - - - - - -
NameType
apiKubeApi‹any›
namespacesstring[]
reqInitRequestInit
-

Returns: Promise‹Node[]›

-
-

loadMetrics#

-

▸ loadMetrics(nodeName: string): Promise‹void›

-

Defined in src/renderer/components/+nodes/nodes.store.ts:57

-

Parameters:

- - - - - - - - - - - - - -
NameType
nodeNamestring
-

Returns: Promise‹void›

-
-

loadUsageMetrics#

-

▸ loadUsageMetrics(): Promise‹void›

-

Defined in src/renderer/components/+nodes/nodes.store.ts:45

-

Returns: Promise‹void›

-
-

Protected mergeItems#

-

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

-

Inherited from KubeObjectStore.mergeItems

-

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

-

Parameters:

-

▪ partialItems: Node[]

-

▪Default value __namedParameters: object= {}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleantrue
replacebooleanfalse
sortbooleantrue
updateStorebooleantrue
-

Returns: Node[]

-
-

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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
force?boolean
merge?boolean
namespaces?string[]
-

Returns: Promise‹void | T[]›

-
-

remove#

-

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

-

Inherited from KubeObjectStore.remove

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemNode
-

Returns: Promise‹void›

-
-

Protected removeItem#

-

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

-

Inherited from KubeObjectStore.removeItem

-

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

-

Parameters:

-

▪ item: Node

-

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

-

Returns: Promise‹void[]›

-
-

reset#

-

▸ reset(): void

-

Overrides KubeObjectStore.reset

-

Defined in src/renderer/components/+nodes/nodes.store.ts:97

-

Returns: void

-
-

Protected resetOnError#

-

▸ resetOnError(error: any): void

-

Inherited from KubeObjectStore.resetOnError

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
errorany
-

Returns: void

-
-

resetSelection#

-

▸ resetSelection(): void

-

Inherited from KubeObjectStore.resetSelection

-

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

-

Returns: void

-
-

select#

-

▸ select(item: Node): void

-

Inherited from KubeObjectStore.select

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemNode
-

Returns: void

-
-

Protected sortItems#

-

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

-

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:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
itemsNode[]this.itemsthe items to be sorted (default: the current items in this store)
sortingfunction[][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: Node[]

-
-

subscribe#

-

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

-

Inherited from KubeObjectStore.subscribe

-

Overrides void

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
-

Returns: (Anonymous function)

-
-

toggleSelection#

-

▸ toggleSelection(item: Node): void

-

Inherited from KubeObjectStore.toggleSelection

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemNode
-

Returns: void

-
-

toggleSelectionAll#

-

▸ toggleSelectionAll(visibleItems: Node[]): void

-

Inherited from KubeObjectStore.toggleSelectionAll

-

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

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsNode[]this.items
-

Returns: void

-
-

unselect#

-

▸ unselect(item: Node): void

-

Inherited from KubeObjectStore.unselect

-

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

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemNode
-

Returns: void

-
-

update#

-

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

-

Inherited from KubeObjectStore.update

-

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

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
itemNode
dataPartial‹Node›
-

Returns: Promise‹Node›

-
-

Protected updateFromEventsBuffer#

-

▸ updateFromEventsBuffer(): void

-

Inherited from KubeObjectStore.updateFromEventsBuffer

-

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

-

Returns: void

-
-

Protected updateItem#

-

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

-

Inherited from KubeObjectStore.updateItem

-

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

-

Parameters:

-

▪ item: Node

-

▪ request: function

-

▸ (): Promise‹Node›

-

Returns: Promise‹T›

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.persistentvolumesstore/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.persistentvolumesstore/index.html deleted file mode 100644 index ea85aba858..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.persistentvolumesstore/index.html +++ /dev/null @@ -1,2193 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: PersistentVolumesStore - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: PersistentVolumesStore#

-

Hierarchy#

-

↳ KubeObjectStore‹PersistentVolume›

-

↳ PersistentVolumesStore

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new PersistentVolumesStore(): PersistentVolumesStore

-

Overrides KubeObjectStore.constructor

-

Defined in src/renderer/components/+storage-volumes/volumes.store.ts:29

-

Returns: PersistentVolumesStore

-

Properties#

-

api#

-

• api: KubeApi‹PersistentVolume‹›› = persistentVolumeApi

-

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+storage-volumes/volumes.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:304

-
-

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#

-

context#

-

• get context(): ClusterContext

-

Inherited from KubeObjectStore.context

-

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

-

Returns: ClusterContext

-
-

contextItems#

-

• get contextItems(): PersistentVolume[]

-

Inherited from KubeObjectStore.contextItems

-

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

-

Returns: PersistentVolume[]

-
-

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(): PersistentVolume[]

-

Inherited from KubeObjectStore.selectedItems

-

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

-

Returns: PersistentVolume[]

-

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:306

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
delaynumber1000
-

Returns: void

-
-

create#

-

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

-

Inherited from KubeObjectStore.create

-

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

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹PersistentVolume›

-

Returns: Promise‹PersistentVolume›

-
-

Protected createItem#

-

▸ createItem(params: object, data?: Partial‹PersistentVolume›): Promise‹PersistentVolume›

-

Inherited from KubeObjectStore.createItem

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:268

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹PersistentVolume›

-

Returns: Promise‹PersistentVolume›

-
-

Protected defaultSorting#

-

▸ defaultSorting(item: PersistentVolume): string

-

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:34

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemPersistentVolume
-

Returns: string

-
-

Protected filterItemsOnLoad#

-

▸ filterItemsOnLoad(items: PersistentVolume[]): T[]

-

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:166

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsPersistentVolume[]
-

Returns: T[]

-
-

getAllByNs#

-

▸ getAllByNs(namespace: string | string[], strict: boolean): PersistentVolume[]

-

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:93

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
namespacestring | string[]-
strictbooleanfalse
-

Returns: PersistentVolume[]

-
-

getById#

-

▸ getById(id: string): T

-

Inherited from KubeObjectStore.getById

-

Defined in src/renderer/kube-object.store.ts:107

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: T

-
-

getByLabel#

-

▸ getByLabel(labels: string[] | object): PersistentVolume[]

-

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:123

-

Parameters:

- - - - - - - - - - - - - -
NameType
labelsstring[] | object
-

Returns: PersistentVolume[]

-
-

getByName#

-

▸ getByName(name: string, namespace?: string): PersistentVolume

-

Inherited from KubeObjectStore.getByName

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:111

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: PersistentVolume

-
-

getByPath#

-

▸ getByPath(path: string): PersistentVolume

-

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:119

-

Parameters:

- - - - - - - - - - - - - -
NameType
pathstring
-

Returns: PersistentVolume

-
-

getByStorageClass#

-

▸ getByStorageClass(storageClass: StorageClass): PersistentVolume[]

-

Defined in src/renderer/components/+storage-volumes/volumes.store.ts:36

-

Parameters:

- - - - - - - - - - - - - -
NameType
storageClassStorageClass
-

Returns: PersistentVolume[]

-
-

getIndexById#

-

▸ getIndexById(id: string): number

-

Inherited from KubeObjectStore.getIndexById

-

Defined in src/renderer/item.store.ts:64

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: number

-
-

getItems#

-

▸ getItems(): PersistentVolume[]

-

Inherited from KubeObjectStore.getItems

-

Defined in src/renderer/item.store.ts:51

-

Returns: PersistentVolume[]

-
-

Optional getStatuses#

-

▸ getStatuses(items: PersistentVolume[]): Record‹string, number›

-

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:91

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsPersistentVolume[]
-

Returns: Record‹string, number›

-
-

getSubscribeApis#

-

▸ getSubscribeApis(): KubeApi[]

-

Inherited from KubeObjectStore.getSubscribeApis

-

Defined in src/renderer/kube-object.store.ts:312

-

Returns: KubeApi[]

-
-

getTotalCount#

-

▸ getTotalCount(): number

-

Inherited from KubeObjectStore.getTotalCount

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:77

-

Returns: number

-
-

isSelected#

-

▸ isSelected(item: PersistentVolume): boolean

-

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:160

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemPersistentVolume
-

Returns: boolean

-
-

isSelectedAll#

-

▸ isSelectedAll(visibleItems: PersistentVolume[]): boolean

-

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:194

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsPersistentVolume[]this.items
-

Returns: boolean

-
-

load#

-

▸ load(params: object): Promise‹PersistentVolume›

-

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:247

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹PersistentVolume›

-
-

loadAll#

-

▸ loadAll(options: object): Promise‹void | PersistentVolume[]›

-

Inherited from KubeObjectStore.loadAll

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:171

-

Parameters:

-

▪Default value options: object= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
merge?boolean
namespaces?string[]
reqInit?RequestInit
-

Returns: Promise‹void | PersistentVolume[]›

-
-

loadFromPath#

-

▸ loadFromPath(resourcePath: string): Promise‹T›

-

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:262

-

Parameters:

- - - - - - - - - - - - - -
NameType
resourcePathstring
-

Returns: Promise‹T›

-
-

Protected loadItem#

-

▸ loadItem(params: object): Promise‹PersistentVolume›

-

Inherited from KubeObjectStore.loadItem

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:242

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹PersistentVolume›

-
-

Protected loadItems#

-

▸ loadItems(__namedParameters: object): Promise‹PersistentVolume[]›

-

Inherited from KubeObjectStore.loadItems

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:140

-

Parameters:

-

▪ __namedParameters: object

- - - - - - - - - - - - - - - - - - - - - -
NameType
apiKubeApi‹any›
namespacesstring[]
reqInitRequestInit
-

Returns: Promise‹PersistentVolume[]›

-
-

Protected mergeItems#

-

▸ mergeItems(partialItems: PersistentVolume[], __namedParameters: object): PersistentVolume[]

-

Inherited from KubeObjectStore.mergeItems

-

Defined in src/renderer/kube-object.store.ts:218

-

Parameters:

-

▪ partialItems: PersistentVolume[]

-

▪Default value __namedParameters: object= {}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleantrue
replacebooleanfalse
sortbooleantrue
updateStorebooleantrue
-

Returns: PersistentVolume[]

-
-

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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
force?boolean
merge?boolean
namespaces?string[]
-

Returns: Promise‹void | T[]›

-
-

remove#

-

▸ remove(item: PersistentVolume): Promise‹void›

-

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:293

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemPersistentVolume
-

Returns: Promise‹void›

-
-

Protected removeItem#

-

▸ removeItem(item: PersistentVolume, request: function): Promise‹void›

-

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:154

-

Parameters:

-

▪ item: PersistentVolume

-

▪ 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:299

-

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:

- - - - - - - - - - - - - -
NameType
errorany
-

Returns: void

-
-

resetSelection#

-

▸ resetSelection(): void

-

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:201

-

Returns: void

-
-

select#

-

▸ select(item: PersistentVolume): void

-

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:165

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemPersistentVolume
-

Returns: void

-
-

Protected sortItems#

-

▸ sortItems(items: PersistentVolume[], sorting: function[], order?: "asc" | "desc"): PersistentVolume[]

-

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:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
itemsPersistentVolume[]this.itemsthe items to be sorted (default: the current items in this store)
sortingfunction[][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: PersistentVolume[]

-
-

subscribe#

-

▸ subscribe(apis: KubeApi‹any›[]): (Anonymous function)

-

Inherited from KubeObjectStore.subscribe

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:316

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
-

Returns: (Anonymous function)

-
-

toggleSelection#

-

▸ toggleSelection(item: PersistentVolume): void

-

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:175

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemPersistentVolume
-

Returns: void

-
-

toggleSelectionAll#

-

▸ toggleSelectionAll(visibleItems: PersistentVolume[]): void

-

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:184

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsPersistentVolume[]this.items
-

Returns: void

-
-

unselect#

-

▸ unselect(item: PersistentVolume): void

-

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:170

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemPersistentVolume
-

Returns: void

-
-

update#

-

▸ update(item: PersistentVolume, data: Partial‹PersistentVolume›): Promise‹PersistentVolume›

-

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:281

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
itemPersistentVolume
dataPartial‹PersistentVolume›
-

Returns: Promise‹PersistentVolume›

-
-

Protected updateFromEventsBuffer#

-

▸ updateFromEventsBuffer(): void

-

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:401

-

Returns: void

-
-

Protected updateItem#

-

▸ updateItem(item: PersistentVolume, request: function): Promise‹T›

-

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:144

-

Parameters:

-

▪ item: PersistentVolume

-

▪ request: function

-

▸ (): Promise‹PersistentVolume›

-

Returns: Promise‹T›

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html deleted file mode 100644 index 469d15d3b8..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html +++ /dev/null @@ -1,2166 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: PodDisruptionBudgetsStore - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: PodDisruptionBudgetsStore#

-

Hierarchy#

-

↳ KubeObjectStore‹PodDisruptionBudget›

-

↳ PodDisruptionBudgetsStore

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new PodDisruptionBudgetsStore(): PodDisruptionBudgetsStore

-

Inherited from KubeObjectStore.constructor

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:54

-

Returns: PodDisruptionBudgetsStore

-

Properties#

-

api#

-

• api: KubeApi‹PodDisruptionBudget‹›› = pdbApi

-

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+config-pod-disruption-budgets/pod-disruption-budgets.store.ts:27

-
-

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:304

-
-

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#

-

context#

-

• get context(): ClusterContext

-

Inherited from KubeObjectStore.context

-

Defined in src/renderer/kube-object.store.ts:63

-

Returns: ClusterContext

-
-

contextItems#

-

• get contextItems(): PodDisruptionBudget[]

-

Inherited from KubeObjectStore.contextItems

-

Defined in src/renderer/kube-object.store.ts:67

-

Returns: PodDisruptionBudget[]

-
-

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(): PodDisruptionBudget[]

-

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:47

-

Returns: PodDisruptionBudget[]

-

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:306

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
delaynumber1000
-

Returns: void

-
-

create#

-

▸ create(params: object, data?: Partial‹PodDisruptionBudget›): Promise‹PodDisruptionBudget›

-

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:272

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹PodDisruptionBudget›

-

Returns: Promise‹PodDisruptionBudget›

-
-

Protected createItem#

-

▸ createItem(params: object, data?: Partial‹PodDisruptionBudget›): Promise‹PodDisruptionBudget›

-

Inherited from KubeObjectStore.createItem

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:268

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹PodDisruptionBudget›

-

Returns: Promise‹PodDisruptionBudget›

-
-

Protected defaultSorting#

-

▸ defaultSorting(item: PodDisruptionBudget): string

-

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:34

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemPodDisruptionBudget
-

Returns: string

-
-

Protected filterItemsOnLoad#

-

▸ filterItemsOnLoad(items: PodDisruptionBudget[]): T[]

-

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:166

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsPodDisruptionBudget[]
-

Returns: T[]

-
-

getAllByNs#

-

▸ getAllByNs(namespace: string | string[], strict: boolean): PodDisruptionBudget[]

-

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:93

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
namespacestring | string[]-
strictbooleanfalse
-

Returns: PodDisruptionBudget[]

-
-

getById#

-

▸ getById(id: string): T

-

Inherited from KubeObjectStore.getById

-

Defined in src/renderer/kube-object.store.ts:107

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: T

-
-

getByLabel#

-

▸ getByLabel(labels: string[] | object): PodDisruptionBudget[]

-

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:123

-

Parameters:

- - - - - - - - - - - - - -
NameType
labelsstring[] | object
-

Returns: PodDisruptionBudget[]

-
-

getByName#

-

▸ getByName(name: string, namespace?: string): PodDisruptionBudget

-

Inherited from KubeObjectStore.getByName

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:111

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: PodDisruptionBudget

-
-

getByPath#

-

▸ getByPath(path: string): PodDisruptionBudget

-

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:119

-

Parameters:

- - - - - - - - - - - - - -
NameType
pathstring
-

Returns: PodDisruptionBudget

-
-

getIndexById#

-

▸ getIndexById(id: string): number

-

Inherited from KubeObjectStore.getIndexById

-

Defined in src/renderer/item.store.ts:64

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: number

-
-

getItems#

-

▸ getItems(): PodDisruptionBudget[]

-

Inherited from KubeObjectStore.getItems

-

Defined in src/renderer/item.store.ts:51

-

Returns: PodDisruptionBudget[]

-
-

Optional getStatuses#

-

▸ getStatuses(items: PodDisruptionBudget[]): Record‹string, number›

-

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:91

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsPodDisruptionBudget[]
-

Returns: Record‹string, number›

-
-

getSubscribeApis#

-

▸ getSubscribeApis(): KubeApi[]

-

Inherited from KubeObjectStore.getSubscribeApis

-

Defined in src/renderer/kube-object.store.ts:312

-

Returns: KubeApi[]

-
-

getTotalCount#

-

▸ getTotalCount(): number

-

Inherited from KubeObjectStore.getTotalCount

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:77

-

Returns: number

-
-

isSelected#

-

▸ isSelected(item: PodDisruptionBudget): boolean

-

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:160

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemPodDisruptionBudget
-

Returns: boolean

-
-

isSelectedAll#

-

▸ isSelectedAll(visibleItems: PodDisruptionBudget[]): boolean

-

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:194

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsPodDisruptionBudget[]this.items
-

Returns: boolean

-
-

load#

-

▸ load(params: object): Promise‹PodDisruptionBudget›

-

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:247

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹PodDisruptionBudget›

-
-

loadAll#

-

▸ loadAll(options: object): Promise‹void | PodDisruptionBudget[]›

-

Inherited from KubeObjectStore.loadAll

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:171

-

Parameters:

-

▪Default value options: object= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
merge?boolean
namespaces?string[]
reqInit?RequestInit
-

Returns: Promise‹void | PodDisruptionBudget[]›

-
-

loadFromPath#

-

▸ loadFromPath(resourcePath: string): Promise‹T›

-

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:262

-

Parameters:

- - - - - - - - - - - - - -
NameType
resourcePathstring
-

Returns: Promise‹T›

-
-

Protected loadItem#

-

▸ loadItem(params: object): Promise‹PodDisruptionBudget›

-

Inherited from KubeObjectStore.loadItem

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:242

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹PodDisruptionBudget›

-
-

Protected loadItems#

-

▸ loadItems(__namedParameters: object): Promise‹PodDisruptionBudget[]›

-

Inherited from KubeObjectStore.loadItems

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:140

-

Parameters:

-

▪ __namedParameters: object

- - - - - - - - - - - - - - - - - - - - - -
NameType
apiKubeApi‹any›
namespacesstring[]
reqInitRequestInit
-

Returns: Promise‹PodDisruptionBudget[]›

-
-

Protected mergeItems#

-

▸ mergeItems(partialItems: PodDisruptionBudget[], __namedParameters: object): PodDisruptionBudget[]

-

Inherited from KubeObjectStore.mergeItems

-

Defined in src/renderer/kube-object.store.ts:218

-

Parameters:

-

▪ partialItems: PodDisruptionBudget[]

-

▪Default value __namedParameters: object= {}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleantrue
replacebooleanfalse
sortbooleantrue
updateStorebooleantrue
-

Returns: PodDisruptionBudget[]

-
-

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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
force?boolean
merge?boolean
namespaces?string[]
-

Returns: Promise‹void | T[]›

-
-

remove#

-

▸ remove(item: PodDisruptionBudget): Promise‹void›

-

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:293

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemPodDisruptionBudget
-

Returns: Promise‹void›

-
-

Protected removeItem#

-

▸ removeItem(item: PodDisruptionBudget, request: function): Promise‹void›

-

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:154

-

Parameters:

-

▪ item: PodDisruptionBudget

-

▪ 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:299

-

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:

- - - - - - - - - - - - - -
NameType
errorany
-

Returns: void

-
-

resetSelection#

-

▸ resetSelection(): void

-

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:201

-

Returns: void

-
-

select#

-

▸ select(item: PodDisruptionBudget): void

-

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:165

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemPodDisruptionBudget
-

Returns: void

-
-

Protected sortItems#

-

▸ sortItems(items: PodDisruptionBudget[], sorting: function[], order?: "asc" | "desc"): PodDisruptionBudget[]

-

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:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
itemsPodDisruptionBudget[]this.itemsthe items to be sorted (default: the current items in this store)
sortingfunction[][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: PodDisruptionBudget[]

-
-

subscribe#

-

▸ subscribe(apis: KubeApi‹any›[]): (Anonymous function)

-

Inherited from KubeObjectStore.subscribe

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:316

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
-

Returns: (Anonymous function)

-
-

toggleSelection#

-

▸ toggleSelection(item: PodDisruptionBudget): void

-

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:175

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemPodDisruptionBudget
-

Returns: void

-
-

toggleSelectionAll#

-

▸ toggleSelectionAll(visibleItems: PodDisruptionBudget[]): void

-

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:184

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsPodDisruptionBudget[]this.items
-

Returns: void

-
-

unselect#

-

▸ unselect(item: PodDisruptionBudget): void

-

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:170

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemPodDisruptionBudget
-

Returns: void

-
-

update#

-

▸ update(item: PodDisruptionBudget, data: Partial‹PodDisruptionBudget›): Promise‹PodDisruptionBudget›

-

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:281

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
itemPodDisruptionBudget
dataPartial‹PodDisruptionBudget›
-

Returns: Promise‹PodDisruptionBudget›

-
-

Protected updateFromEventsBuffer#

-

▸ updateFromEventsBuffer(): void

-

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:401

-

Returns: void

-
-

Protected updateItem#

-

▸ updateItem(item: PodDisruptionBudget, request: function): Promise‹T›

-

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:144

-

Parameters:

-

▪ item: PodDisruptionBudget

-

▪ request: function

-

▸ (): Promise‹PodDisruptionBudget›

-

Returns: Promise‹T›

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.podsstore/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.podsstore/index.html deleted file mode 100644 index e605d80da2..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.podsstore/index.html +++ /dev/null @@ -1,2393 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: PodsStore - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: PodsStore#

-

Hierarchy#

-

↳ KubeObjectStore‹Pod›

-

↳ PodsStore

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new PodsStore(): PodsStore

-

Overrides KubeObjectStore.constructor

-

Defined in src/renderer/components/+workloads-pods/pods.store.ts:34

-

Returns: PodsStore

-

Properties#

-

api#

-

• api: PodsApi‹› = podsApi

-

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+workloads-pods/pods.store.ts:31

-
-

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:304

-
-

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

-
-

kubeMetrics#

-

• kubeMetrics: IObservableArray‹PodMetrics‹›› = observable.array([])

-

Defined in src/renderer/components/+workloads-pods/pods.store.ts:34

-
-

Optional limit#

-

• limit? : number

-

Inherited from KubeObjectStore.limit

-

Defined in src/renderer/kube-object.store.ts:44

-
-

metrics#

-

• metrics: IPodMetrics = null

-

Defined in src/renderer/components/+workloads-pods/pods.store.ts:33

-
-

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(): Pod[]

-

Inherited from KubeObjectStore.contextItems

-

Defined in src/renderer/kube-object.store.ts:67

-

Returns: Pod[]

-
-

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(): Pod[]

-

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:47

-

Returns: Pod[]

-

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:306

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
delaynumber1000
-

Returns: void

-
-

create#

-

▸ create(params: object, data?: Partial‹Pod›): Promise‹Pod›

-

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:272

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹Pod›

-

Returns: Promise‹Pod›

-
-

Protected createItem#

-

▸ createItem(params: object, data?: Partial‹Pod›): Promise‹Pod›

-

Inherited from KubeObjectStore.createItem

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:268

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹Pod›

-

Returns: Promise‹Pod›

-
-

Protected defaultSorting#

-

▸ defaultSorting(item: Pod): string

-

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:34

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemPod
-

Returns: string

-
-

Protected filterItemsOnLoad#

-

▸ filterItemsOnLoad(items: Pod[]): T[]

-

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:166

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsPod[]
-

Returns: T[]

-
-

getAllByNs#

-

▸ getAllByNs(namespace: string | string[], strict: boolean): Pod[]

-

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:93

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
namespacestring | string[]-
strictbooleanfalse
-

Returns: Pod[]

-
-

getById#

-

▸ getById(id: string): T

-

Inherited from KubeObjectStore.getById

-

Defined in src/renderer/kube-object.store.ts:107

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: T

-
-

getByLabel#

-

▸ getByLabel(labels: string[] | object): Pod[]

-

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:123

-

Parameters:

- - - - - - - - - - - - - -
NameType
labelsstring[] | object
-

Returns: Pod[]

-
-

getByName#

-

▸ getByName(name: string, namespace?: string): Pod

-

Inherited from KubeObjectStore.getByName

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:111

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Pod

-
-

getByPath#

-

▸ getByPath(path: string): Pod

-

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:119

-

Parameters:

- - - - - - - - - - - - - -
NameType
pathstring
-

Returns: Pod

-
-

getIndexById#

-

▸ getIndexById(id: string): number

-

Inherited from KubeObjectStore.getIndexById

-

Defined in src/renderer/item.store.ts:64

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: number

-
-

getItems#

-

▸ getItems(): Pod[]

-

Inherited from KubeObjectStore.getItems

-

Defined in src/renderer/item.store.ts:51

-

Returns: Pod[]

-
-

getPodKubeMetrics#

-

▸ getPodKubeMetrics(pod: Pod): object

-

Defined in src/renderer/components/+workloads-pods/pods.store.ts:88

-

Parameters:

- - - - - - - - - - - - - -
NameType
podPod
-

Returns: object

-
    -
  • -

    cpu: number = 0

    -
    • -
  • -

    memory: number = 0

    -
    • -
-
-

getPodsByNode#

-

▸ getPodsByNode(node: string): Pod‹›[]

-

Defined in src/renderer/components/+workloads-pods/pods.store.ts:78

-

Parameters:

- - - - - - - - - - - - - -
NameType
nodestring
-

Returns: Pod‹›[]

-
-

getPodsByOwner#

-

▸ getPodsByOwner(workload: WorkloadKubeObject): Pod[]

-

Defined in src/renderer/components/+workloads-pods/pods.store.ts:62

-

Parameters:

- - - - - - - - - - - - - -
NameType
workloadWorkloadKubeObject
-

Returns: Pod[]

-
-

getPodsByOwnerId#

-

▸ getPodsByOwnerId(workloadId: string): Pod[]

-

Defined in src/renderer/components/+workloads-pods/pods.store.ts:72

-

Parameters:

- - - - - - - - - - - - - -
NameType
workloadIdstring
-

Returns: Pod[]

-
-

getStatuses#

-

▸ getStatuses(pods: Pod[]): Dictionary‹number›

-

Overrides KubeObjectStore.getStatuses

-

Defined in src/renderer/components/+workloads-pods/pods.store.ts:84

-

Parameters:

- - - - - - - - - - - - - -
NameType
podsPod[]
-

Returns: Dictionary‹number›

-
-

getSubscribeApis#

-

▸ getSubscribeApis(): KubeApi[]

-

Inherited from KubeObjectStore.getSubscribeApis

-

Defined in src/renderer/kube-object.store.ts:312

-

Returns: KubeApi[]

-
-

getTotalCount#

-

▸ getTotalCount(): number

-

Inherited from KubeObjectStore.getTotalCount

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:77

-

Returns: number

-
-

isSelected#

-

▸ isSelected(item: Pod): boolean

-

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:160

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemPod
-

Returns: boolean

-
-

isSelectedAll#

-

▸ isSelectedAll(visibleItems: Pod[]): boolean

-

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:194

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsPod[]this.items
-

Returns: boolean

-
-

load#

-

▸ load(params: object): Promise‹Pod›

-

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:247

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹Pod›

-
-

loadAll#

-

▸ loadAll(options: object): Promise‹void | Pod[]›

-

Inherited from KubeObjectStore.loadAll

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:171

-

Parameters:

-

▪Default value options: object= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
merge?boolean
namespaces?string[]
reqInit?RequestInit
-

Returns: Promise‹void | Pod[]›

-
-

loadContainerMetrics#

-

▸ loadContainerMetrics(pod: Pod): Promise‹IPodMetrics‹IMetrics››

-

Defined in src/renderer/components/+workloads-pods/pods.store.ts:48

-

Parameters:

- - - - - - - - - - - - - -
NameType
podPod
-

Returns: Promise‹IPodMetrics‹IMetrics››

-
-

loadFromPath#

-

▸ loadFromPath(resourcePath: string): Promise‹T›

-

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:262

-

Parameters:

- - - - - - - - - - - - - -
NameType
resourcePathstring
-

Returns: Promise‹T›

-
-

Protected loadItem#

-

▸ loadItem(params: object): Promise‹Pod›

-

Inherited from KubeObjectStore.loadItem

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:242

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹Pod›

-
-

Protected loadItems#

-

▸ loadItems(__namedParameters: object): Promise‹Pod[]›

-

Inherited from KubeObjectStore.loadItems

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:140

-

Parameters:

-

▪ __namedParameters: object

- - - - - - - - - - - - - - - - - - - - - -
NameType
apiKubeApi‹any›
namespacesstring[]
reqInitRequestInit
-

Returns: Promise‹Pod[]›

-
-

loadKubeMetrics#

-

▸ loadKubeMetrics(namespace?: string): Promise‹void›

-

Defined in src/renderer/components/+workloads-pods/pods.store.ts:52

-

Parameters:

- - - - - - - - - - - - - -
NameType
namespace?string
-

Returns: Promise‹void›

-
-

loadMetrics#

-

▸ loadMetrics(pod: Pod): Promise‹void›

-

Defined in src/renderer/components/+workloads-pods/pods.store.ts:44

-

Parameters:

- - - - - - - - - - - - - -
NameType
podPod
-

Returns: Promise‹void›

-
-

Protected mergeItems#

-

▸ mergeItems(partialItems: Pod[], __namedParameters: object): Pod[]

-

Inherited from KubeObjectStore.mergeItems

-

Defined in src/renderer/kube-object.store.ts:218

-

Parameters:

-

▪ partialItems: Pod[]

-

▪Default value __namedParameters: object= {}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleantrue
replacebooleanfalse
sortbooleantrue
updateStorebooleantrue
-

Returns: Pod[]

-
-

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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
force?boolean
merge?boolean
namespaces?string[]
-

Returns: Promise‹void | T[]›

-
-

remove#

-

▸ remove(item: Pod): Promise‹void›

-

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:293

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemPod
-

Returns: Promise‹void›

-
-

Protected removeItem#

-

▸ removeItem(item: Pod, request: function): Promise‹void›

-

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:154

-

Parameters:

-

▪ item: Pod

-

▪ 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:299

-

Returns: Promise‹void[]›

-
-

reset#

-

▸ reset(): void

-

Overrides KubeObjectStore.reset

-

Defined in src/renderer/components/+workloads-pods/pods.store.ts:117

-

Returns: void

-
-

Protected resetOnError#

-

▸ resetOnError(error: any): void

-

Inherited from KubeObjectStore.resetOnError

-

Defined in src/renderer/kube-object.store.ts:238

-

Parameters:

- - - - - - - - - - - - - -
NameType
errorany
-

Returns: void

-
-

resetSelection#

-

▸ resetSelection(): void

-

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:201

-

Returns: void

-
-

select#

-

▸ select(item: Pod): void

-

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:165

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemPod
-

Returns: void

-
-

Protected sortItems#

-

▸ sortItems(items: Pod[], sorting: function[], order?: "asc" | "desc"): Pod[]

-

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:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
itemsPod[]this.itemsthe items to be sorted (default: the current items in this store)
sortingfunction[][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: Pod[]

-
-

subscribe#

-

▸ subscribe(apis: KubeApi‹any›[]): (Anonymous function)

-

Inherited from KubeObjectStore.subscribe

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:316

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
-

Returns: (Anonymous function)

-
-

toggleSelection#

-

▸ toggleSelection(item: Pod): void

-

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:175

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemPod
-

Returns: void

-
-

toggleSelectionAll#

-

▸ toggleSelectionAll(visibleItems: Pod[]): void

-

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:184

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsPod[]this.items
-

Returns: void

-
-

unselect#

-

▸ unselect(item: Pod): void

-

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:170

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemPod
-

Returns: void

-
-

update#

-

▸ update(item: Pod, data: Partial‹Pod›): Promise‹Pod›

-

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:281

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
itemPod
dataPartial‹Pod›
-

Returns: Promise‹Pod›

-
-

Protected updateFromEventsBuffer#

-

▸ updateFromEventsBuffer(): void

-

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:401

-

Returns: void

-
-

Protected updateItem#

-

▸ updateItem(item: Pod, request: function): Promise‹T›

-

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:144

-

Parameters:

-

▪ item: Pod

-

▪ request: function

-

▸ (): Promise‹Pod›

-

Returns: Promise‹T›

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.replicasetstore/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.replicasetstore/index.html deleted file mode 100644 index 84fcaa102c..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.replicasetstore/index.html +++ /dev/null @@ -1,2272 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: ReplicaSetStore - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: ReplicaSetStore#

-

Hierarchy#

-

↳ KubeObjectStore‹ReplicaSet›

-

↳ ReplicaSetStore

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new ReplicaSetStore(): ReplicaSetStore

-

Overrides KubeObjectStore.constructor

-

Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:32

-

Returns: ReplicaSetStore

-

Properties#

-

api#

-

• api: ReplicaSetApi‹› = replicaSetApi

-

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:31

-
-

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:304

-
-

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

-
-

metrics#

-

• metrics: IPodMetrics = null

-

Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:32

-
-

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(): ReplicaSet[]

-

Inherited from KubeObjectStore.contextItems

-

Defined in src/renderer/kube-object.store.ts:67

-

Returns: ReplicaSet[]

-
-

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(): ReplicaSet[]

-

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:47

-

Returns: ReplicaSet[]

-

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:306

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
delaynumber1000
-

Returns: void

-
-

create#

-

▸ create(params: object, data?: Partial‹ReplicaSet›): Promise‹ReplicaSet›

-

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:272

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹ReplicaSet›

-

Returns: Promise‹ReplicaSet›

-
-

Protected createItem#

-

▸ createItem(params: object, data?: Partial‹ReplicaSet›): Promise‹ReplicaSet›

-

Inherited from KubeObjectStore.createItem

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:268

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹ReplicaSet›

-

Returns: Promise‹ReplicaSet›

-
-

Protected defaultSorting#

-

▸ defaultSorting(item: ReplicaSet): string

-

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:34

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemReplicaSet
-

Returns: string

-
-

Protected filterItemsOnLoad#

-

▸ filterItemsOnLoad(items: ReplicaSet[]): T[]

-

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:166

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsReplicaSet[]
-

Returns: T[]

-
-

getAllByNs#

-

▸ getAllByNs(namespace: string | string[], strict: boolean): ReplicaSet[]

-

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:93

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
namespacestring | string[]-
strictbooleanfalse
-

Returns: ReplicaSet[]

-
-

getById#

-

▸ getById(id: string): T

-

Inherited from KubeObjectStore.getById

-

Defined in src/renderer/kube-object.store.ts:107

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: T

-
-

getByLabel#

-

▸ getByLabel(labels: string[] | object): ReplicaSet[]

-

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:123

-

Parameters:

- - - - - - - - - - - - - -
NameType
labelsstring[] | object
-

Returns: ReplicaSet[]

-
-

getByName#

-

▸ getByName(name: string, namespace?: string): ReplicaSet

-

Inherited from KubeObjectStore.getByName

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:111

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: ReplicaSet

-
-

getByPath#

-

▸ getByPath(path: string): ReplicaSet

-

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:119

-

Parameters:

- - - - - - - - - - - - - -
NameType
pathstring
-

Returns: ReplicaSet

-
-

getChildPods#

-

▸ getChildPods(replicaSet: ReplicaSet): Pod‹›[]

-

Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:47

-

Parameters:

- - - - - - - - - - - - - -
NameType
replicaSetReplicaSet
-

Returns: Pod‹›[]

-
-

getIndexById#

-

▸ getIndexById(id: string): number

-

Inherited from KubeObjectStore.getIndexById

-

Defined in src/renderer/item.store.ts:64

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: number

-
-

getItems#

-

▸ getItems(): ReplicaSet[]

-

Inherited from KubeObjectStore.getItems

-

Defined in src/renderer/item.store.ts:51

-

Returns: ReplicaSet[]

-
-

getReplicaSetsByOwner#

-

▸ getReplicaSetsByOwner(deployment: Deployment): ReplicaSet‹›[]

-

Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:71

-

Parameters:

- - - - - - - - - - - - - -
NameType
deploymentDeployment
-

Returns: ReplicaSet‹›[]

-
-

getStatuses#

-

▸ getStatuses(replicaSets: ReplicaSet[]): object

-

Overrides KubeObjectStore.getStatuses

-

Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:51

-

Parameters:

- - - - - - - - - - - - - -
NameType
replicaSetsReplicaSet[]
-

Returns: object

-
    -
  • -

    failed: number = 0

    -
    • -
  • -

    pending: number = 0

    -
    • -
  • -

    running: number = 0

    -
    • -
-
-

getSubscribeApis#

-

▸ getSubscribeApis(): KubeApi[]

-

Inherited from KubeObjectStore.getSubscribeApis

-

Defined in src/renderer/kube-object.store.ts:312

-

Returns: KubeApi[]

-
-

getTotalCount#

-

▸ getTotalCount(): number

-

Inherited from KubeObjectStore.getTotalCount

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:77

-

Returns: number

-
-

isSelected#

-

▸ isSelected(item: ReplicaSet): boolean

-

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:160

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemReplicaSet
-

Returns: boolean

-
-

isSelectedAll#

-

▸ isSelectedAll(visibleItems: ReplicaSet[]): boolean

-

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:194

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsReplicaSet[]this.items
-

Returns: boolean

-
-

load#

-

▸ load(params: object): Promise‹ReplicaSet›

-

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:247

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹ReplicaSet›

-
-

loadAll#

-

▸ loadAll(options: object): Promise‹void | ReplicaSet[]›

-

Inherited from KubeObjectStore.loadAll

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:171

-

Parameters:

-

▪Default value options: object= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
merge?boolean
namespaces?string[]
reqInit?RequestInit
-

Returns: Promise‹void | ReplicaSet[]›

-
-

loadFromPath#

-

▸ loadFromPath(resourcePath: string): Promise‹T›

-

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:262

-

Parameters:

- - - - - - - - - - - - - -
NameType
resourcePathstring
-

Returns: Promise‹T›

-
-

Protected loadItem#

-

▸ loadItem(params: object): Promise‹ReplicaSet›

-

Inherited from KubeObjectStore.loadItem

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:242

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹ReplicaSet›

-
-

Protected loadItems#

-

▸ loadItems(__namedParameters: object): Promise‹ReplicaSet[]›

-

Inherited from KubeObjectStore.loadItems

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:140

-

Parameters:

-

▪ __namedParameters: object

- - - - - - - - - - - - - - - - - - - - - -
NameType
apiKubeApi‹any›
namespacesstring[]
reqInitRequestInit
-

Returns: Promise‹ReplicaSet[]›

-
-

loadMetrics#

-

▸ loadMetrics(replicaSet: ReplicaSet): Promise‹void›

-

Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:41

-

Parameters:

- - - - - - - - - - - - - -
NameType
replicaSetReplicaSet
-

Returns: Promise‹void›

-
-

Protected mergeItems#

-

▸ mergeItems(partialItems: ReplicaSet[], __namedParameters: object): ReplicaSet[]

-

Inherited from KubeObjectStore.mergeItems

-

Defined in src/renderer/kube-object.store.ts:218

-

Parameters:

-

▪ partialItems: ReplicaSet[]

-

▪Default value __namedParameters: object= {}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleantrue
replacebooleanfalse
sortbooleantrue
updateStorebooleantrue
-

Returns: ReplicaSet[]

-
-

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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
force?boolean
merge?boolean
namespaces?string[]
-

Returns: Promise‹void | T[]›

-
-

remove#

-

▸ remove(item: ReplicaSet): Promise‹void›

-

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:293

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemReplicaSet
-

Returns: Promise‹void›

-
-

Protected removeItem#

-

▸ removeItem(item: ReplicaSet, request: function): Promise‹void›

-

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:154

-

Parameters:

-

▪ item: ReplicaSet

-

▪ 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:299

-

Returns: Promise‹void[]›

-
-

reset#

-

▸ reset(): void

-

Overrides KubeObjectStore.reset

-

Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:77

-

Returns: void

-
-

Protected resetOnError#

-

▸ resetOnError(error: any): void

-

Inherited from KubeObjectStore.resetOnError

-

Defined in src/renderer/kube-object.store.ts:238

-

Parameters:

- - - - - - - - - - - - - -
NameType
errorany
-

Returns: void

-
-

resetSelection#

-

▸ resetSelection(): void

-

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:201

-

Returns: void

-
-

select#

-

▸ select(item: ReplicaSet): void

-

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:165

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemReplicaSet
-

Returns: void

-
-

Protected sortItems#

-

▸ sortItems(items: ReplicaSet[], sorting: function[], order?: "asc" | "desc"): ReplicaSet[]

-

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:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
itemsReplicaSet[]this.itemsthe items to be sorted (default: the current items in this store)
sortingfunction[][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: ReplicaSet[]

-
-

subscribe#

-

▸ subscribe(apis: KubeApi‹any›[]): (Anonymous function)

-

Inherited from KubeObjectStore.subscribe

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:316

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
-

Returns: (Anonymous function)

-
-

toggleSelection#

-

▸ toggleSelection(item: ReplicaSet): void

-

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:175

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemReplicaSet
-

Returns: void

-
-

toggleSelectionAll#

-

▸ toggleSelectionAll(visibleItems: ReplicaSet[]): void

-

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:184

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsReplicaSet[]this.items
-

Returns: void

-
-

unselect#

-

▸ unselect(item: ReplicaSet): void

-

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:170

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemReplicaSet
-

Returns: void

-
-

update#

-

▸ update(item: ReplicaSet, data: Partial‹ReplicaSet›): Promise‹ReplicaSet›

-

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:281

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
itemReplicaSet
dataPartial‹ReplicaSet›
-

Returns: Promise‹ReplicaSet›

-
-

Protected updateFromEventsBuffer#

-

▸ updateFromEventsBuffer(): void

-

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:401

-

Returns: void

-
-

Protected updateItem#

-

▸ updateItem(item: ReplicaSet, request: function): Promise‹T›

-

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:144

-

Parameters:

-

▪ item: ReplicaSet

-

▪ request: function

-

▸ (): Promise‹ReplicaSet›

-

Returns: Promise‹T›

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.resourcequotasstore/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.resourcequotasstore/index.html deleted file mode 100644 index 8370740f12..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.resourcequotasstore/index.html +++ /dev/null @@ -1,2166 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: ResourceQuotasStore - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: ResourceQuotasStore#

-

Hierarchy#

-

↳ KubeObjectStore‹ResourceQuota›

-

↳ ResourceQuotasStore

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new ResourceQuotasStore(): ResourceQuotasStore

-

Inherited from KubeObjectStore.constructor

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:54

-

Returns: ResourceQuotasStore

-

Properties#

-

api#

-

• api: KubeApi‹ResourceQuota‹›› = resourceQuotaApi

-

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+config-resource-quotas/resource-quotas.store.ts:27

-
-

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:304

-
-

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#

-

context#

-

• get context(): ClusterContext

-

Inherited from KubeObjectStore.context

-

Defined in src/renderer/kube-object.store.ts:63

-

Returns: ClusterContext

-
-

contextItems#

-

• get contextItems(): ResourceQuota[]

-

Inherited from KubeObjectStore.contextItems

-

Defined in src/renderer/kube-object.store.ts:67

-

Returns: ResourceQuota[]

-
-

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(): ResourceQuota[]

-

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:47

-

Returns: ResourceQuota[]

-

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:306

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
delaynumber1000
-

Returns: void

-
-

create#

-

▸ create(params: object, data?: Partial‹ResourceQuota›): Promise‹ResourceQuota›

-

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:272

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹ResourceQuota›

-

Returns: Promise‹ResourceQuota›

-
-

Protected createItem#

-

▸ createItem(params: object, data?: Partial‹ResourceQuota›): Promise‹ResourceQuota›

-

Inherited from KubeObjectStore.createItem

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:268

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹ResourceQuota›

-

Returns: Promise‹ResourceQuota›

-
-

Protected defaultSorting#

-

▸ defaultSorting(item: ResourceQuota): string

-

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:34

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemResourceQuota
-

Returns: string

-
-

Protected filterItemsOnLoad#

-

▸ filterItemsOnLoad(items: ResourceQuota[]): T[]

-

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:166

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsResourceQuota[]
-

Returns: T[]

-
-

getAllByNs#

-

▸ getAllByNs(namespace: string | string[], strict: boolean): ResourceQuota[]

-

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:93

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
namespacestring | string[]-
strictbooleanfalse
-

Returns: ResourceQuota[]

-
-

getById#

-

▸ getById(id: string): T

-

Inherited from KubeObjectStore.getById

-

Defined in src/renderer/kube-object.store.ts:107

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: T

-
-

getByLabel#

-

▸ getByLabel(labels: string[] | object): ResourceQuota[]

-

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:123

-

Parameters:

- - - - - - - - - - - - - -
NameType
labelsstring[] | object
-

Returns: ResourceQuota[]

-
-

getByName#

-

▸ getByName(name: string, namespace?: string): ResourceQuota

-

Inherited from KubeObjectStore.getByName

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:111

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: ResourceQuota

-
-

getByPath#

-

▸ getByPath(path: string): ResourceQuota

-

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:119

-

Parameters:

- - - - - - - - - - - - - -
NameType
pathstring
-

Returns: ResourceQuota

-
-

getIndexById#

-

▸ getIndexById(id: string): number

-

Inherited from KubeObjectStore.getIndexById

-

Defined in src/renderer/item.store.ts:64

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: number

-
-

getItems#

-

▸ getItems(): ResourceQuota[]

-

Inherited from KubeObjectStore.getItems

-

Defined in src/renderer/item.store.ts:51

-

Returns: ResourceQuota[]

-
-

Optional getStatuses#

-

▸ getStatuses(items: ResourceQuota[]): Record‹string, number›

-

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:91

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsResourceQuota[]
-

Returns: Record‹string, number›

-
-

getSubscribeApis#

-

▸ getSubscribeApis(): KubeApi[]

-

Inherited from KubeObjectStore.getSubscribeApis

-

Defined in src/renderer/kube-object.store.ts:312

-

Returns: KubeApi[]

-
-

getTotalCount#

-

▸ getTotalCount(): number

-

Inherited from KubeObjectStore.getTotalCount

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:77

-

Returns: number

-
-

isSelected#

-

▸ isSelected(item: ResourceQuota): boolean

-

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:160

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemResourceQuota
-

Returns: boolean

-
-

isSelectedAll#

-

▸ isSelectedAll(visibleItems: ResourceQuota[]): boolean

-

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:194

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsResourceQuota[]this.items
-

Returns: boolean

-
-

load#

-

▸ load(params: object): Promise‹ResourceQuota›

-

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:247

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹ResourceQuota›

-
-

loadAll#

-

▸ loadAll(options: object): Promise‹void | ResourceQuota[]›

-

Inherited from KubeObjectStore.loadAll

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:171

-

Parameters:

-

▪Default value options: object= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
merge?boolean
namespaces?string[]
reqInit?RequestInit
-

Returns: Promise‹void | ResourceQuota[]›

-
-

loadFromPath#

-

▸ loadFromPath(resourcePath: string): Promise‹T›

-

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:262

-

Parameters:

- - - - - - - - - - - - - -
NameType
resourcePathstring
-

Returns: Promise‹T›

-
-

Protected loadItem#

-

▸ loadItem(params: object): Promise‹ResourceQuota›

-

Inherited from KubeObjectStore.loadItem

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:242

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹ResourceQuota›

-
-

Protected loadItems#

-

▸ loadItems(__namedParameters: object): Promise‹ResourceQuota[]›

-

Inherited from KubeObjectStore.loadItems

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:140

-

Parameters:

-

▪ __namedParameters: object

- - - - - - - - - - - - - - - - - - - - - -
NameType
apiKubeApi‹any›
namespacesstring[]
reqInitRequestInit
-

Returns: Promise‹ResourceQuota[]›

-
-

Protected mergeItems#

-

▸ mergeItems(partialItems: ResourceQuota[], __namedParameters: object): ResourceQuota[]

-

Inherited from KubeObjectStore.mergeItems

-

Defined in src/renderer/kube-object.store.ts:218

-

Parameters:

-

▪ partialItems: ResourceQuota[]

-

▪Default value __namedParameters: object= {}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleantrue
replacebooleanfalse
sortbooleantrue
updateStorebooleantrue
-

Returns: ResourceQuota[]

-
-

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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
force?boolean
merge?boolean
namespaces?string[]
-

Returns: Promise‹void | T[]›

-
-

remove#

-

▸ remove(item: ResourceQuota): Promise‹void›

-

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:293

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemResourceQuota
-

Returns: Promise‹void›

-
-

Protected removeItem#

-

▸ removeItem(item: ResourceQuota, request: function): Promise‹void›

-

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:154

-

Parameters:

-

▪ item: ResourceQuota

-

▪ 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:299

-

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:

- - - - - - - - - - - - - -
NameType
errorany
-

Returns: void

-
-

resetSelection#

-

▸ resetSelection(): void

-

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:201

-

Returns: void

-
-

select#

-

▸ select(item: ResourceQuota): void

-

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:165

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemResourceQuota
-

Returns: void

-
-

Protected sortItems#

-

▸ sortItems(items: ResourceQuota[], sorting: function[], order?: "asc" | "desc"): ResourceQuota[]

-

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:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
itemsResourceQuota[]this.itemsthe items to be sorted (default: the current items in this store)
sortingfunction[][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: ResourceQuota[]

-
-

subscribe#

-

▸ subscribe(apis: KubeApi‹any›[]): (Anonymous function)

-

Inherited from KubeObjectStore.subscribe

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:316

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
-

Returns: (Anonymous function)

-
-

toggleSelection#

-

▸ toggleSelection(item: ResourceQuota): void

-

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:175

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemResourceQuota
-

Returns: void

-
-

toggleSelectionAll#

-

▸ toggleSelectionAll(visibleItems: ResourceQuota[]): void

-

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:184

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsResourceQuota[]this.items
-

Returns: void

-
-

unselect#

-

▸ unselect(item: ResourceQuota): void

-

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:170

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemResourceQuota
-

Returns: void

-
-

update#

-

▸ update(item: ResourceQuota, data: Partial‹ResourceQuota›): Promise‹ResourceQuota›

-

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:281

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
itemResourceQuota
dataPartial‹ResourceQuota›
-

Returns: Promise‹ResourceQuota›

-
-

Protected updateFromEventsBuffer#

-

▸ updateFromEventsBuffer(): void

-

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:401

-

Returns: void

-
-

Protected updateItem#

-

▸ updateItem(item: ResourceQuota, request: function): Promise‹T›

-

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:144

-

Parameters:

-

▪ item: ResourceQuota

-

▪ request: function

-

▸ (): Promise‹ResourceQuota›

-

Returns: Promise‹T›

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.rolebindingsstore/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.rolebindingsstore/index.html deleted file mode 100644 index d6282349de..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.rolebindingsstore/index.html +++ /dev/null @@ -1,2170 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: RoleBindingsStore - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: RoleBindingsStore#

-

Hierarchy#

-

↳ KubeObjectStore‹RoleBinding›

-

↳ RoleBindingsStore

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new RoleBindingsStore(): RoleBindingsStore

-

Overrides KubeObjectStore.constructor

-

Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:30

-

Returns: RoleBindingsStore

-

Properties#

-

api#

-

• api: KubeApi‹ClusterRoleBinding‹›› = clusterRoleBindingApi

-

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:30

-
-

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:304

-
-

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#

-

context#

-

• get context(): ClusterContext

-

Inherited from KubeObjectStore.context

-

Defined in src/renderer/kube-object.store.ts:63

-

Returns: ClusterContext

-
-

contextItems#

-

• get contextItems(): RoleBinding[]

-

Inherited from KubeObjectStore.contextItems

-

Defined in src/renderer/kube-object.store.ts:67

-

Returns: RoleBinding[]

-
-

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(): RoleBinding[]

-

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:47

-

Returns: RoleBinding[]

-

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:306

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
delaynumber1000
-

Returns: void

-
-

create#

-

▸ create(params: object, data?: Partial‹RoleBinding›): Promise‹RoleBinding›

-

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:272

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹RoleBinding›

-

Returns: Promise‹RoleBinding›

-
-

Protected createItem#

-

▸ createItem(params: object, data?: Partial‹RoleBinding›): Promise‹RoleBinding‹››

-

Overrides KubeObjectStore.createItem

-

Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:63

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹RoleBinding›

-

Returns: Promise‹RoleBinding‹››

-
-

Protected defaultSorting#

-

▸ defaultSorting(item: RoleBinding): string

-

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:34

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemRoleBinding
-

Returns: string

-
-

Protected filterItemsOnLoad#

-

▸ filterItemsOnLoad(items: RoleBinding[]): T[]

-

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:166

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsRoleBinding[]
-

Returns: T[]

-
-

getAllByNs#

-

▸ getAllByNs(namespace: string | string[], strict: boolean): RoleBinding[]

-

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:93

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
namespacestring | string[]-
strictbooleanfalse
-

Returns: RoleBinding[]

-
-

getById#

-

▸ getById(id: string): T

-

Inherited from KubeObjectStore.getById

-

Defined in src/renderer/kube-object.store.ts:107

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: T

-
-

getByLabel#

-

▸ getByLabel(labels: string[] | object): RoleBinding[]

-

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:123

-

Parameters:

- - - - - - - - - - - - - -
NameType
labelsstring[] | object
-

Returns: RoleBinding[]

-
-

getByName#

-

▸ getByName(name: string, namespace?: string): RoleBinding

-

Inherited from KubeObjectStore.getByName

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:111

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: RoleBinding

-
-

getByPath#

-

▸ getByPath(path: string): RoleBinding

-

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:119

-

Parameters:

- - - - - - - - - - - - - -
NameType
pathstring
-

Returns: RoleBinding

-
-

getIndexById#

-

▸ getIndexById(id: string): number

-

Inherited from KubeObjectStore.getIndexById

-

Defined in src/renderer/item.store.ts:64

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: number

-
-

getItems#

-

▸ getItems(): RoleBinding[]

-

Inherited from KubeObjectStore.getItems

-

Defined in src/renderer/item.store.ts:51

-

Returns: RoleBinding[]

-
-

Optional getStatuses#

-

▸ getStatuses(items: RoleBinding[]): Record‹string, number›

-

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:91

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsRoleBinding[]
-

Returns: Record‹string, number›

-
-

getSubscribeApis#

-

▸ getSubscribeApis(): KubeApi‹RoleBinding‹››[]

-

Overrides KubeObjectStore.getSubscribeApis

-

Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:37

-

Returns: KubeApi‹RoleBinding‹››[]

-
-

getTotalCount#

-

▸ getTotalCount(): number

-

Inherited from KubeObjectStore.getTotalCount

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:77

-

Returns: number

-
-

isSelected#

-

▸ isSelected(item: RoleBinding): boolean

-

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:160

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemRoleBinding
-

Returns: boolean

-
-

isSelectedAll#

-

▸ isSelectedAll(visibleItems: RoleBinding[]): boolean

-

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:194

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsRoleBinding[]this.items
-

Returns: boolean

-
-

load#

-

▸ load(params: object): Promise‹RoleBinding›

-

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:247

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹RoleBinding›

-
-

loadAll#

-

▸ loadAll(options: object): Promise‹void | RoleBinding[]›

-

Inherited from KubeObjectStore.loadAll

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:171

-

Parameters:

-

▪Default value options: object= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
merge?boolean
namespaces?string[]
reqInit?RequestInit
-

Returns: Promise‹void | RoleBinding[]›

-
-

loadFromPath#

-

▸ loadFromPath(resourcePath: string): Promise‹T›

-

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:262

-

Parameters:

- - - - - - - - - - - - - -
NameType
resourcePathstring
-

Returns: Promise‹T›

-
-

Protected loadItem#

-

▸ loadItem(params: object): Promise‹RoleBinding‹››

-

Overrides KubeObjectStore.loadItem

-

Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:48

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹RoleBinding‹››

-
-

Protected loadItems#

-

▸ loadItems(params: KubeObjectStoreLoadingParams): Promise‹RoleBinding[]›

-

Overrides KubeObjectStore.loadItems

-

Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:54

-

Parameters:

- - - - - - - - - - - - - -
NameType
paramsKubeObjectStoreLoadingParams
-

Returns: Promise‹RoleBinding[]›

-
-

Protected mergeItems#

-

▸ mergeItems(partialItems: RoleBinding[], __namedParameters: object): RoleBinding[]

-

Inherited from KubeObjectStore.mergeItems

-

Defined in src/renderer/kube-object.store.ts:218

-

Parameters:

-

▪ partialItems: RoleBinding[]

-

▪Default value __namedParameters: object= {}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleantrue
replacebooleanfalse
sortbooleantrue
updateStorebooleantrue
-

Returns: RoleBinding[]

-
-

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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
force?boolean
merge?boolean
namespaces?string[]
-

Returns: Promise‹void | T[]›

-
-

remove#

-

▸ remove(item: RoleBinding): Promise‹void›

-

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:293

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemRoleBinding
-

Returns: Promise‹void›

-
-

Protected removeItem#

-

▸ removeItem(item: RoleBinding, request: function): Promise‹void›

-

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:154

-

Parameters:

-

▪ item: RoleBinding

-

▪ 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:299

-

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:

- - - - - - - - - - - - - -
NameType
errorany
-

Returns: void

-
-

resetSelection#

-

▸ resetSelection(): void

-

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:201

-

Returns: void

-
-

select#

-

▸ select(item: RoleBinding): void

-

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:165

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemRoleBinding
-

Returns: void

-
-

Protected sortItems#

-

▸ sortItems(items: RoleBinding[]): RoleBinding‹›[]

-

Overrides KubeObjectStore.sortItems

-

Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:41

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsRoleBinding[]
-

Returns: RoleBinding‹›[]

-
-

subscribe#

-

▸ subscribe(apis: KubeApi‹any›[]): (Anonymous function)

-

Inherited from KubeObjectStore.subscribe

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:316

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
-

Returns: (Anonymous function)

-
-

toggleSelection#

-

▸ toggleSelection(item: RoleBinding): void

-

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:175

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemRoleBinding
-

Returns: void

-
-

toggleSelectionAll#

-

▸ toggleSelectionAll(visibleItems: RoleBinding[]): void

-

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:184

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsRoleBinding[]this.items
-

Returns: void

-
-

unselect#

-

▸ unselect(item: RoleBinding): void

-

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:170

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemRoleBinding
-

Returns: void

-
-

update#

-

▸ update(item: RoleBinding, data: Partial‹RoleBinding›): Promise‹RoleBinding›

-

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:281

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
itemRoleBinding
dataPartial‹RoleBinding›
-

Returns: Promise‹RoleBinding›

-
-

Protected updateFromEventsBuffer#

-

▸ updateFromEventsBuffer(): void

-

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:401

-

Returns: void

-
-

Protected updateItem#

-

▸ updateItem(item: RoleBinding, request: function): Promise‹T›

-

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:144

-

Parameters:

-

▪ item: RoleBinding

-

▪ request: function

-

▸ (): Promise‹RoleBinding›

-

Returns: Promise‹T›

-
-

updateSubjects#

-

▸ updateSubjects(params: object): Promise‹RoleBinding‹››

-

Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:71

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - - - - - -
NameType
addSubjects?IRoleBindingSubject[]
removeSubjects?IRoleBindingSubject[]
roleBindingRoleBinding
-

Returns: Promise‹RoleBinding‹››

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.rolesstore/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.rolesstore/index.html deleted file mode 100644 index 7e9d74a5ad..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.rolesstore/index.html +++ /dev/null @@ -1,2133 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: RolesStore - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: RolesStore#

-

Hierarchy#

-

↳ KubeObjectStore‹Role›

-

↳ RolesStore

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

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>([], { deep: false })

-

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:304

-
-

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#

-

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:306

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
delaynumber1000
-

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

- - - - - - - - - - - - - - - - - -
NameType
namestring
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

- - - - - - - - - - - - - - - - - -
NameType
namestring
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:

- - - - - - - - - - - - - -
NameType
itemRole
-

Returns: string

-
-

Protected filterItemsOnLoad#

-

▸ filterItemsOnLoad(items: Role[]): T[]

-

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:166

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsRole[]
-

Returns: T[]

-
-

getAllByNs#

-

▸ getAllByNs(namespace: string | string[], strict: boolean): Role[]

-

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:93

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
namespacestring | string[]-
strictbooleanfalse
-

Returns: Role[]

-
-

getById#

-

▸ getById(id: string): T

-

Inherited from KubeObjectStore.getById

-

Defined in src/renderer/kube-object.store.ts:107

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: T

-
-

getByLabel#

-

▸ getByLabel(labels: string[] | object): Role[]

-

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:123

-

Parameters:

- - - - - - - - - - - - - -
NameType
labelsstring[] | 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:

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Role

-
-

getByPath#

-

▸ getByPath(path: string): Role

-

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:119

-

Parameters:

- - - - - - - - - - - - - -
NameType
pathstring
-

Returns: Role

-
-

getIndexById#

-

▸ getIndexById(id: string): number

-

Inherited from KubeObjectStore.getIndexById

-

Defined in src/renderer/item.store.ts:64

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

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:

- - - - - - - - - - - - - -
NameType
itemsRole[]
-

Returns: Record‹string, number›

-
-

getSubscribeApis#

-

▸ getSubscribeApis(): KubeApi‹Role‹››[]

-

Overrides KubeObjectStore.getSubscribeApis

-

Defined in src/renderer/components/+user-management-roles/roles.store.ts:35

-

Returns: KubeApi‹Role‹››[]

-
-

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:

- - - - - - - - - - - - - -
NameType
itemRole
-

Returns: boolean

-
-

isSelectedAll#

-

▸ isSelectedAll(visibleItems: Role[]): boolean

-

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:194

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsRole[]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

- - - - - - - - - - - - - - - - - -
NameType
namestring
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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
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:

- - - - - - - - - - - - - -
NameType
resourcePathstring
-

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

- - - - - - - - - - - - - - - - - -
NameType
namestring
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:

- - - - - - - - - - - - - -
NameType
paramsKubeObjectStoreLoadingParams
-

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= {}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleantrue
replacebooleanfalse
sortbooleantrue
updateStorebooleantrue
-

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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
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:293

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemRole
-

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:299

-

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:

- - - - - - - - - - - - - -
NameType
errorany
-

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:

- - - - - - - - - - - - - -
NameType
itemRole
-

Returns: void

-
-

Protected sortItems#

-

▸ sortItems(items: Role[]): Role‹›[]

-

Overrides KubeObjectStore.sortItems

-

Defined in src/renderer/components/+user-management-roles/roles.store.ts:39

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsRole[]
-

Returns: Role‹›[]

-
-

subscribe#

-

▸ subscribe(apis: KubeApi‹any›[]): (Anonymous function)

-

Inherited from KubeObjectStore.subscribe

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:316

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
-

Returns: (Anonymous function)

-
-

toggleSelection#

-

▸ toggleSelection(item: Role): void

-

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:175

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemRole
-

Returns: void

-
-

toggleSelectionAll#

-

▸ toggleSelectionAll(visibleItems: Role[]): void

-

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:184

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsRole[]this.items
-

Returns: void

-
-

unselect#

-

▸ unselect(item: Role): void

-

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:170

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemRole
-

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:

- - - - - - - - - - - - - - - - - -
NameType
itemRole
dataPartial‹Role›
-

Returns: Promise‹Role›

-
-

Protected updateFromEventsBuffer#

-

▸ updateFromEventsBuffer(): void

-

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:401

-

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›

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.secretsstore/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.secretsstore/index.html deleted file mode 100644 index fc1abd8e9d..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.secretsstore/index.html +++ /dev/null @@ -1,2166 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: SecretsStore - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: SecretsStore#

-

Hierarchy#

-

↳ KubeObjectStore‹Secret›

-

↳ SecretsStore

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new SecretsStore(): SecretsStore

-

Inherited from KubeObjectStore.constructor

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:54

-

Returns: SecretsStore

-

Properties#

-

api#

-

• api: KubeApi‹Secret‹›› = secretsApi

-

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+config-secrets/secrets.store.ts:27

-
-

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:304

-
-

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#

-

context#

-

• get context(): ClusterContext

-

Inherited from KubeObjectStore.context

-

Defined in src/renderer/kube-object.store.ts:63

-

Returns: ClusterContext

-
-

contextItems#

-

• get contextItems(): Secret[]

-

Inherited from KubeObjectStore.contextItems

-

Defined in src/renderer/kube-object.store.ts:67

-

Returns: Secret[]

-
-

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(): Secret[]

-

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:47

-

Returns: Secret[]

-

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:306

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
delaynumber1000
-

Returns: void

-
-

create#

-

▸ create(params: object, data?: Partial‹Secret›): Promise‹Secret›

-

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:272

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹Secret›

-

Returns: Promise‹Secret›

-
-

Protected createItem#

-

▸ createItem(params: object, data?: Partial‹Secret›): Promise‹Secret›

-

Inherited from KubeObjectStore.createItem

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:268

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹Secret›

-

Returns: Promise‹Secret›

-
-

Protected defaultSorting#

-

▸ defaultSorting(item: Secret): string

-

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:34

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemSecret
-

Returns: string

-
-

Protected filterItemsOnLoad#

-

▸ filterItemsOnLoad(items: Secret[]): T[]

-

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:166

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsSecret[]
-

Returns: T[]

-
-

getAllByNs#

-

▸ getAllByNs(namespace: string | string[], strict: boolean): Secret[]

-

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:93

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
namespacestring | string[]-
strictbooleanfalse
-

Returns: Secret[]

-
-

getById#

-

▸ getById(id: string): T

-

Inherited from KubeObjectStore.getById

-

Defined in src/renderer/kube-object.store.ts:107

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: T

-
-

getByLabel#

-

▸ getByLabel(labels: string[] | object): Secret[]

-

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:123

-

Parameters:

- - - - - - - - - - - - - -
NameType
labelsstring[] | object
-

Returns: Secret[]

-
-

getByName#

-

▸ getByName(name: string, namespace?: string): Secret

-

Inherited from KubeObjectStore.getByName

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:111

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Secret

-
-

getByPath#

-

▸ getByPath(path: string): Secret

-

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:119

-

Parameters:

- - - - - - - - - - - - - -
NameType
pathstring
-

Returns: Secret

-
-

getIndexById#

-

▸ getIndexById(id: string): number

-

Inherited from KubeObjectStore.getIndexById

-

Defined in src/renderer/item.store.ts:64

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: number

-
-

getItems#

-

▸ getItems(): Secret[]

-

Inherited from KubeObjectStore.getItems

-

Defined in src/renderer/item.store.ts:51

-

Returns: Secret[]

-
-

Optional getStatuses#

-

▸ getStatuses(items: Secret[]): Record‹string, number›

-

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:91

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsSecret[]
-

Returns: Record‹string, number›

-
-

getSubscribeApis#

-

▸ getSubscribeApis(): KubeApi[]

-

Inherited from KubeObjectStore.getSubscribeApis

-

Defined in src/renderer/kube-object.store.ts:312

-

Returns: KubeApi[]

-
-

getTotalCount#

-

▸ getTotalCount(): number

-

Inherited from KubeObjectStore.getTotalCount

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:77

-

Returns: number

-
-

isSelected#

-

▸ isSelected(item: Secret): boolean

-

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:160

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemSecret
-

Returns: boolean

-
-

isSelectedAll#

-

▸ isSelectedAll(visibleItems: Secret[]): boolean

-

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:194

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsSecret[]this.items
-

Returns: boolean

-
-

load#

-

▸ load(params: object): Promise‹Secret›

-

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:247

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹Secret›

-
-

loadAll#

-

▸ loadAll(options: object): Promise‹void | Secret[]›

-

Inherited from KubeObjectStore.loadAll

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:171

-

Parameters:

-

▪Default value options: object= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
merge?boolean
namespaces?string[]
reqInit?RequestInit
-

Returns: Promise‹void | Secret[]›

-
-

loadFromPath#

-

▸ loadFromPath(resourcePath: string): Promise‹T›

-

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:262

-

Parameters:

- - - - - - - - - - - - - -
NameType
resourcePathstring
-

Returns: Promise‹T›

-
-

Protected loadItem#

-

▸ loadItem(params: object): Promise‹Secret›

-

Inherited from KubeObjectStore.loadItem

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:242

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹Secret›

-
-

Protected loadItems#

-

▸ loadItems(__namedParameters: object): Promise‹Secret[]›

-

Inherited from KubeObjectStore.loadItems

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:140

-

Parameters:

-

▪ __namedParameters: object

- - - - - - - - - - - - - - - - - - - - - -
NameType
apiKubeApi‹any›
namespacesstring[]
reqInitRequestInit
-

Returns: Promise‹Secret[]›

-
-

Protected mergeItems#

-

▸ mergeItems(partialItems: Secret[], __namedParameters: object): Secret[]

-

Inherited from KubeObjectStore.mergeItems

-

Defined in src/renderer/kube-object.store.ts:218

-

Parameters:

-

▪ partialItems: Secret[]

-

▪Default value __namedParameters: object= {}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleantrue
replacebooleanfalse
sortbooleantrue
updateStorebooleantrue
-

Returns: Secret[]

-
-

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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
force?boolean
merge?boolean
namespaces?string[]
-

Returns: Promise‹void | T[]›

-
-

remove#

-

▸ remove(item: Secret): Promise‹void›

-

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:293

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemSecret
-

Returns: Promise‹void›

-
-

Protected removeItem#

-

▸ removeItem(item: Secret, request: function): Promise‹void›

-

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:154

-

Parameters:

-

▪ item: Secret

-

▪ 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:299

-

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:

- - - - - - - - - - - - - -
NameType
errorany
-

Returns: void

-
-

resetSelection#

-

▸ resetSelection(): void

-

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:201

-

Returns: void

-
-

select#

-

▸ select(item: Secret): void

-

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:165

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemSecret
-

Returns: void

-
-

Protected sortItems#

-

▸ sortItems(items: Secret[], sorting: function[], order?: "asc" | "desc"): Secret[]

-

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:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
itemsSecret[]this.itemsthe items to be sorted (default: the current items in this store)
sortingfunction[][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: Secret[]

-
-

subscribe#

-

▸ subscribe(apis: KubeApi‹any›[]): (Anonymous function)

-

Inherited from KubeObjectStore.subscribe

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:316

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
-

Returns: (Anonymous function)

-
-

toggleSelection#

-

▸ toggleSelection(item: Secret): void

-

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:175

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemSecret
-

Returns: void

-
-

toggleSelectionAll#

-

▸ toggleSelectionAll(visibleItems: Secret[]): void

-

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:184

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsSecret[]this.items
-

Returns: void

-
-

unselect#

-

▸ unselect(item: Secret): void

-

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:170

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemSecret
-

Returns: void

-
-

update#

-

▸ update(item: Secret, data: Partial‹Secret›): Promise‹Secret›

-

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:281

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
itemSecret
dataPartial‹Secret›
-

Returns: Promise‹Secret›

-
-

Protected updateFromEventsBuffer#

-

▸ updateFromEventsBuffer(): void

-

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:401

-

Returns: void

-
-

Protected updateItem#

-

▸ updateItem(item: Secret, request: function): Promise‹T›

-

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:144

-

Parameters:

-

▪ item: Secret

-

▪ request: function

-

▸ (): Promise‹Secret›

-

Returns: Promise‹T›

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.serviceaccount/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.serviceaccount/index.html deleted file mode 100644 index 9155d196cb..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.serviceaccount/index.html +++ /dev/null @@ -1,1559 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: ServiceAccount ‹**Metadata, Status, Spec**› - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: ServiceAccount ‹Metadata, Status, Spec›#

-

Type parameters#

-

▪ Metadata: IKubeObjectMetadata

-

▪ Status

-

▪ Spec

-

Hierarchy#

- -

↳ ServiceAccount

-

Implements#

-
    -
  • ItemObject
    • -
-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new ServiceAccount(data: KubeJsonApiData): ServiceAccount

-

Overrides KubeObject.constructor

-

Defined in src/renderer/api/endpoints/service-accounts.api.ts:39

-

Parameters:

- - - - - - - - - - - - - -
NameType
dataKubeJsonApiData
-

Returns: ServiceAccount

-

Properties#

-

apiVersion#

-

• apiVersion: string

-

Inherited from KubeObject.apiVersion

-

Defined in src/renderer/api/kube-object.ts:94

-
-

Optional imagePullSecrets#

-

• imagePullSecrets? : object[]

-

Defined in src/renderer/api/endpoints/service-accounts.api.ts:31

-
-

kind#

-

• kind: string

-

Inherited from KubeObject.kind

-

Defined in src/renderer/api/kube-object.ts:95

-
-

metadata#

-

• metadata: Metadata

-

Inherited from KubeObject.metadata

-

Defined in src/renderer/api/kube-object.ts:96

-
-

Optional secrets#

-

• secrets? : object[]

-

Defined in src/renderer/api/endpoints/service-accounts.api.ts:28

-
-

Optional spec#

-

• spec? : Spec

-

Inherited from KubeObject.spec

-

Defined in src/renderer/api/kube-object.ts:98

-
-

Optional status#

-

• status? : Status

-

Inherited from KubeObject.status

-

Defined in src/renderer/api/kube-object.ts:97

-
-

Static apiBase#

-

▪ apiBase: string = "/api/v1/serviceaccounts"

-

Defined in src/renderer/api/endpoints/service-accounts.api.ts:39

-
-

Static kind#

-

▪ kind: string = "ServiceAccount"

-

Overrides KubeObject.kind

-

Defined in src/renderer/api/endpoints/service-accounts.api.ts:37

-
-

Static namespaced#

-

▪ namespaced: boolean = true

-

Overrides KubeObject.namespaced

-

Defined in src/renderer/api/endpoints/service-accounts.api.ts:38

-

Accessors#

- -

• get selfLink(): string

-

Inherited from KubeObject.selfLink

-

Defined in src/renderer/api/kube-object.ts:187

-

Returns: string

-

Methods#

-

delete#

-

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

-

Inherited from KubeObject.delete

-

Defined in src/renderer/api/kube-object.ts:276

-

Parameters:

- - - - - - - - - - - - - -
NameType
params?JsonApiParams
-

Returns: Promise‹KubeJsonApiData›

-
-

getAge#

-

▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

-

Inherited from KubeObject.getAge

-

Defined in src/renderer/api/kube-object.ts:212

-

Parameters:

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
-

Returns: string | number

-
-

getAnnotations#

-

▸ getAnnotations(filter: boolean): string[]

-

Inherited from KubeObject.getAnnotations

-

Defined in src/renderer/api/kube-object.ts:233

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleanfalse
-

Returns: string[]

-
-

getFinalizers#

-

▸ getFinalizers(): string[]

-

Inherited from KubeObject.getFinalizers

-

Defined in src/renderer/api/kube-object.ts:225

-

Returns: string[]

-
-

getId#

-

▸ getId(): string

-

Inherited from KubeObject.getId

-

Defined in src/renderer/api/kube-object.ts:191

-

Returns: string

-
-

getImagePullSecrets#

-

▸ getImagePullSecrets(): object[]

-

Defined in src/renderer/api/endpoints/service-accounts.api.ts:50

-

Returns: object[]

-
-

getLabels#

-

▸ getLabels(): string[]

-

Inherited from KubeObject.getLabels

-

Defined in src/renderer/api/kube-object.ts:229

-

Returns: string[]

-
-

getName#

-

▸ getName(): string

-

Inherited from KubeObject.getName

-

Defined in src/renderer/api/kube-object.ts:199

-

Returns: string

-
-

getNs#

-

▸ getNs(): string

-

Inherited from KubeObject.getNs

-

Defined in src/renderer/api/kube-object.ts:203

-

Returns: string

-
-

getOwnerRefs#

-

▸ getOwnerRefs(): object[]

-

Inherited from KubeObject.getOwnerRefs

-

Defined in src/renderer/api/kube-object.ts:243

-

Returns: object[]

-
-

getResourceVersion#

-

▸ getResourceVersion(): string

-

Inherited from KubeObject.getResourceVersion

-

Defined in src/renderer/api/kube-object.ts:195

-

Returns: string

-
-

getSearchFields#

-

▸ getSearchFields(): string[]

-

Inherited from KubeObject.getSearchFields

-

Defined in src/renderer/api/kube-object.ts:252

-

Returns: string[]

-
-

getSecrets#

-

▸ getSecrets(): object[]

-

Defined in src/renderer/api/endpoints/service-accounts.api.ts:46

-

Returns: object[]

-
-

getTimeDiffFromNow#

-

▸ getTimeDiffFromNow(): number

-

Inherited from KubeObject.getTimeDiffFromNow

-

Defined in src/renderer/api/kube-object.ts:208

-

Returns: number

-
-

toPlainObject#

-

▸ toPlainObject(): object

-

Inherited from KubeObject.toPlainObject

-

Defined in src/renderer/api/kube-object.ts:264

-

Returns: object

-
-

update#

-

▸ update‹T›(data: Partial‹T›): Promise‹T›

-

Inherited from KubeObject.update

-

Defined in src/renderer/api/kube-object.ts:269

-

Type parameters:

-

▪ T: KubeObject

-

Parameters:

- - - - - - - - - - - - - -
NameType
dataPartial‹T›
-

Returns: Promise‹T›

-
-

Static create#

-

▸ create(data: KubeJsonApiData): KubeObject‹IKubeObjectMetadata, any, any›

-

Inherited from KubeObject.create

-

Defined in src/renderer/api/kube-object.ts:100

-

Parameters:

- - - - - - - - - - - - - -
NameType
dataKubeJsonApiData
-

Returns: KubeObject‹IKubeObjectMetadata, any, any›

-
-

Static isJsonApiData#

-

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

-

Inherited from KubeObject.isJsonApiData

-

Defined in src/renderer/api/kube-object.ts:108

-

Parameters:

- - - - - - - - - - - - - -
NameType
objectunknown
-

Returns: object is KubeJsonApiData

-
-

Static isJsonApiDataList#

-

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

-

Inherited from KubeObject.isJsonApiDataList

-

Defined in src/renderer/api/kube-object.ts:166

-

Type parameters:

-

▪ T

-

Parameters:

-

▪ object: unknown

-

▪ verifyItem: function

-

▸ (val: unknown): val is T

-

Parameters:

- - - - - - - - - - - - - -
NameType
valunknown
-

Returns: object is KubeJsonApiDataList‹T›

-
-

Static isKubeJsonApiListMetadata#

-

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

-

Inherited from KubeObject.isKubeJsonApiListMetadata

-

Defined in src/renderer/api/kube-object.ts:117

-

Parameters:

- - - - - - - - - - - - - -
NameType
objectunknown
-

Returns: object is KubeJsonApiListMetadata

-
-

Static isKubeJsonApiMetadata#

-

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

-

Inherited from KubeObject.isKubeJsonApiMetadata

-

Defined in src/renderer/api/kube-object.ts:125

-

Parameters:

- - - - - - - - - - - - - -
NameType
objectunknown
-

Returns: object is KubeJsonApiMetadata

-
-

Static isNonSystem#

-

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

-

Inherited from KubeObject.isNonSystem

-

Defined in src/renderer/api/kube-object.ts:104

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemKubeJsonApiData | KubeObject
-

Returns: boolean

-
-

Static isPartialJsonApiData#

-

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

-

Inherited from KubeObject.isPartialJsonApiData

-

Defined in src/renderer/api/kube-object.ts:157

-

Parameters:

- - - - - - - - - - - - - -
NameType
objectunknown
-

Returns: object is Partial‹KubeJsonApiData›

-
-

Static isPartialJsonApiMetadata#

-

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

-

Inherited from KubeObject.isPartialJsonApiMetadata

-

Defined in src/renderer/api/kube-object.ts:141

-

Parameters:

- - - - - - - - - - - - - -
NameType
objectunknown
-

Returns: object is Partial‹KubeJsonApiMetadata›

-
-

Static stringifyLabels#

-

▸ stringifyLabels(labels?: object): string[]

-

Inherited from KubeObject.stringifyLabels

-

Defined in src/renderer/api/kube-object.ts:176

-

Parameters:

- - - - - - - - - - - - - -
NameType
labels?object
-

Returns: string[]

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.serviceaccountsstore/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.serviceaccountsstore/index.html deleted file mode 100644 index d0e34c7a60..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.serviceaccountsstore/index.html +++ /dev/null @@ -1,2163 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: ServiceAccountsStore - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: ServiceAccountsStore#

-

Hierarchy#

-

↳ KubeObjectStore‹ServiceAccount›

-

↳ ServiceAccountsStore

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new ServiceAccountsStore(): ServiceAccountsStore

-

Overrides KubeObjectStore.constructor

-

Defined in src/renderer/components/+user-management-service-accounts/service-accounts.store.ts:28

-

Returns: ServiceAccountsStore

-

Properties#

-

api#

-

• api: KubeApi‹ServiceAccount‹›› = serviceAccountsApi

-

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+user-management-service-accounts/service-accounts.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>([], { deep: false })

-

Inherited from KubeObjectStore.eventsBuffer

-

Defined in src/renderer/kube-object.store.ts:304

-
-

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#

-

context#

-

• get context(): ClusterContext

-

Inherited from KubeObjectStore.context

-

Defined in src/renderer/kube-object.store.ts:63

-

Returns: ClusterContext

-
-

contextItems#

-

• get contextItems(): ServiceAccount[]

-

Inherited from KubeObjectStore.contextItems

-

Defined in src/renderer/kube-object.store.ts:67

-

Returns: ServiceAccount[]

-
-

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(): ServiceAccount[]

-

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:47

-

Returns: ServiceAccount[]

-

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:306

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
delaynumber1000
-

Returns: void

-
-

create#

-

▸ create(params: object, data?: Partial‹ServiceAccount›): Promise‹ServiceAccount›

-

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:272

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹ServiceAccount›

-

Returns: Promise‹ServiceAccount›

-
-

Protected createItem#

-

▸ createItem(params: object): Promise‹ServiceAccount‹››

-

Overrides KubeObjectStore.createItem

-

Defined in src/renderer/components/+user-management-service-accounts/service-accounts.store.ts:35

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹ServiceAccount‹››

-
-

Protected defaultSorting#

-

▸ defaultSorting(item: ServiceAccount): string

-

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:34

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemServiceAccount
-

Returns: string

-
-

Protected filterItemsOnLoad#

-

▸ filterItemsOnLoad(items: ServiceAccount[]): T[]

-

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:166

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsServiceAccount[]
-

Returns: T[]

-
-

getAllByNs#

-

▸ getAllByNs(namespace: string | string[], strict: boolean): ServiceAccount[]

-

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:93

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
namespacestring | string[]-
strictbooleanfalse
-

Returns: ServiceAccount[]

-
-

getById#

-

▸ getById(id: string): T

-

Inherited from KubeObjectStore.getById

-

Defined in src/renderer/kube-object.store.ts:107

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: T

-
-

getByLabel#

-

▸ getByLabel(labels: string[] | object): ServiceAccount[]

-

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:123

-

Parameters:

- - - - - - - - - - - - - -
NameType
labelsstring[] | object
-

Returns: ServiceAccount[]

-
-

getByName#

-

▸ getByName(name: string, namespace?: string): ServiceAccount

-

Inherited from KubeObjectStore.getByName

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:111

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: ServiceAccount

-
-

getByPath#

-

▸ getByPath(path: string): ServiceAccount

-

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:119

-

Parameters:

- - - - - - - - - - - - - -
NameType
pathstring
-

Returns: ServiceAccount

-
-

getIndexById#

-

▸ getIndexById(id: string): number

-

Inherited from KubeObjectStore.getIndexById

-

Defined in src/renderer/item.store.ts:64

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: number

-
-

getItems#

-

▸ getItems(): ServiceAccount[]

-

Inherited from KubeObjectStore.getItems

-

Defined in src/renderer/item.store.ts:51

-

Returns: ServiceAccount[]

-
-

Optional getStatuses#

-

▸ getStatuses(items: ServiceAccount[]): Record‹string, number›

-

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:91

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsServiceAccount[]
-

Returns: Record‹string, number›

-
-

getSubscribeApis#

-

▸ getSubscribeApis(): KubeApi[]

-

Inherited from KubeObjectStore.getSubscribeApis

-

Defined in src/renderer/kube-object.store.ts:312

-

Returns: KubeApi[]

-
-

getTotalCount#

-

▸ getTotalCount(): number

-

Inherited from KubeObjectStore.getTotalCount

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:77

-

Returns: number

-
-

isSelected#

-

▸ isSelected(item: ServiceAccount): boolean

-

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:160

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemServiceAccount
-

Returns: boolean

-
-

isSelectedAll#

-

▸ isSelectedAll(visibleItems: ServiceAccount[]): boolean

-

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:194

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsServiceAccount[]this.items
-

Returns: boolean

-
-

load#

-

▸ load(params: object): Promise‹ServiceAccount›

-

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:247

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹ServiceAccount›

-
-

loadAll#

-

▸ loadAll(options: object): Promise‹void | ServiceAccount[]›

-

Inherited from KubeObjectStore.loadAll

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:171

-

Parameters:

-

▪Default value options: object= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
merge?boolean
namespaces?string[]
reqInit?RequestInit
-

Returns: Promise‹void | ServiceAccount[]›

-
-

loadFromPath#

-

▸ loadFromPath(resourcePath: string): Promise‹T›

-

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:262

-

Parameters:

- - - - - - - - - - - - - -
NameType
resourcePathstring
-

Returns: Promise‹T›

-
-

Protected loadItem#

-

▸ loadItem(params: object): Promise‹ServiceAccount›

-

Inherited from KubeObjectStore.loadItem

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:242

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹ServiceAccount›

-
-

Protected loadItems#

-

▸ loadItems(__namedParameters: object): Promise‹ServiceAccount[]›

-

Inherited from KubeObjectStore.loadItems

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:140

-

Parameters:

-

▪ __namedParameters: object

- - - - - - - - - - - - - - - - - - - - - -
NameType
apiKubeApi‹any›
namespacesstring[]
reqInitRequestInit
-

Returns: Promise‹ServiceAccount[]›

-
-

Protected mergeItems#

-

▸ mergeItems(partialItems: ServiceAccount[], __namedParameters: object): ServiceAccount[]

-

Inherited from KubeObjectStore.mergeItems

-

Defined in src/renderer/kube-object.store.ts:218

-

Parameters:

-

▪ partialItems: ServiceAccount[]

-

▪Default value __namedParameters: object= {}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleantrue
replacebooleanfalse
sortbooleantrue
updateStorebooleantrue
-

Returns: ServiceAccount[]

-
-

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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
force?boolean
merge?boolean
namespaces?string[]
-

Returns: Promise‹void | T[]›

-
-

remove#

-

▸ remove(item: ServiceAccount): Promise‹void›

-

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:293

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemServiceAccount
-

Returns: Promise‹void›

-
-

Protected removeItem#

-

▸ removeItem(item: ServiceAccount, request: function): Promise‹void›

-

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:154

-

Parameters:

-

▪ item: ServiceAccount

-

▪ 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:299

-

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:

- - - - - - - - - - - - - -
NameType
errorany
-

Returns: void

-
-

resetSelection#

-

▸ resetSelection(): void

-

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:201

-

Returns: void

-
-

select#

-

▸ select(item: ServiceAccount): void

-

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:165

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemServiceAccount
-

Returns: void

-
-

Protected sortItems#

-

▸ sortItems(items: ServiceAccount[], sorting: function[], order?: "asc" | "desc"): ServiceAccount[]

-

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:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
itemsServiceAccount[]this.itemsthe items to be sorted (default: the current items in this store)
sortingfunction[][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: ServiceAccount[]

-
-

subscribe#

-

▸ subscribe(apis: KubeApi‹any›[]): (Anonymous function)

-

Inherited from KubeObjectStore.subscribe

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:316

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
-

Returns: (Anonymous function)

-
-

toggleSelection#

-

▸ toggleSelection(item: ServiceAccount): void

-

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:175

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemServiceAccount
-

Returns: void

-
-

toggleSelectionAll#

-

▸ toggleSelectionAll(visibleItems: ServiceAccount[]): void

-

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:184

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsServiceAccount[]this.items
-

Returns: void

-
-

unselect#

-

▸ unselect(item: ServiceAccount): void

-

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:170

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemServiceAccount
-

Returns: void

-
-

update#

-

▸ update(item: ServiceAccount, data: Partial‹ServiceAccount›): Promise‹ServiceAccount›

-

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:281

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
itemServiceAccount
dataPartial‹ServiceAccount›
-

Returns: Promise‹ServiceAccount›

-
-

Protected updateFromEventsBuffer#

-

▸ updateFromEventsBuffer(): void

-

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:401

-

Returns: void

-
-

Protected updateItem#

-

▸ updateItem(item: ServiceAccount, request: function): Promise‹T›

-

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:144

-

Parameters:

-

▪ item: ServiceAccount

-

▪ request: function

-

▸ (): Promise‹ServiceAccount›

-

Returns: Promise‹T›

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.servicestore/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.servicestore/index.html deleted file mode 100644 index 209178f473..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.servicestore/index.html +++ /dev/null @@ -1,2166 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: ServiceStore - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: ServiceStore#

-

Hierarchy#

-

↳ KubeObjectStore‹Service›

-

↳ ServiceStore

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new ServiceStore(): ServiceStore

-

Inherited from KubeObjectStore.constructor

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:54

-

Returns: ServiceStore

-

Properties#

-

api#

-

• api: KubeApi‹Service‹›› = serviceApi

-

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+network-services/services.store.ts:27

-
-

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:304

-
-

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#

-

context#

-

• get context(): ClusterContext

-

Inherited from KubeObjectStore.context

-

Defined in src/renderer/kube-object.store.ts:63

-

Returns: ClusterContext

-
-

contextItems#

-

• get contextItems(): Service[]

-

Inherited from KubeObjectStore.contextItems

-

Defined in src/renderer/kube-object.store.ts:67

-

Returns: Service[]

-
-

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(): Service[]

-

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:47

-

Returns: Service[]

-

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:306

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
delaynumber1000
-

Returns: void

-
-

create#

-

▸ create(params: object, data?: Partial‹Service›): Promise‹Service›

-

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:272

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹Service›

-

Returns: Promise‹Service›

-
-

Protected createItem#

-

▸ createItem(params: object, data?: Partial‹Service›): Promise‹Service›

-

Inherited from KubeObjectStore.createItem

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:268

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹Service›

-

Returns: Promise‹Service›

-
-

Protected defaultSorting#

-

▸ defaultSorting(item: Service): string

-

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:34

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemService
-

Returns: string

-
-

Protected filterItemsOnLoad#

-

▸ filterItemsOnLoad(items: Service[]): T[]

-

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:166

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsService[]
-

Returns: T[]

-
-

getAllByNs#

-

▸ getAllByNs(namespace: string | string[], strict: boolean): Service[]

-

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:93

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
namespacestring | string[]-
strictbooleanfalse
-

Returns: Service[]

-
-

getById#

-

▸ getById(id: string): T

-

Inherited from KubeObjectStore.getById

-

Defined in src/renderer/kube-object.store.ts:107

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: T

-
-

getByLabel#

-

▸ getByLabel(labels: string[] | object): Service[]

-

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:123

-

Parameters:

- - - - - - - - - - - - - -
NameType
labelsstring[] | object
-

Returns: Service[]

-
-

getByName#

-

▸ getByName(name: string, namespace?: string): Service

-

Inherited from KubeObjectStore.getByName

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:111

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Service

-
-

getByPath#

-

▸ getByPath(path: string): Service

-

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:119

-

Parameters:

- - - - - - - - - - - - - -
NameType
pathstring
-

Returns: Service

-
-

getIndexById#

-

▸ getIndexById(id: string): number

-

Inherited from KubeObjectStore.getIndexById

-

Defined in src/renderer/item.store.ts:64

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: number

-
-

getItems#

-

▸ getItems(): Service[]

-

Inherited from KubeObjectStore.getItems

-

Defined in src/renderer/item.store.ts:51

-

Returns: Service[]

-
-

Optional getStatuses#

-

▸ getStatuses(items: Service[]): Record‹string, number›

-

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:91

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsService[]
-

Returns: Record‹string, number›

-
-

getSubscribeApis#

-

▸ getSubscribeApis(): KubeApi[]

-

Inherited from KubeObjectStore.getSubscribeApis

-

Defined in src/renderer/kube-object.store.ts:312

-

Returns: KubeApi[]

-
-

getTotalCount#

-

▸ getTotalCount(): number

-

Inherited from KubeObjectStore.getTotalCount

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:77

-

Returns: number

-
-

isSelected#

-

▸ isSelected(item: Service): boolean

-

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:160

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemService
-

Returns: boolean

-
-

isSelectedAll#

-

▸ isSelectedAll(visibleItems: Service[]): boolean

-

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:194

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsService[]this.items
-

Returns: boolean

-
-

load#

-

▸ load(params: object): Promise‹Service›

-

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:247

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹Service›

-
-

loadAll#

-

▸ loadAll(options: object): Promise‹void | Service[]›

-

Inherited from KubeObjectStore.loadAll

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:171

-

Parameters:

-

▪Default value options: object= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
merge?boolean
namespaces?string[]
reqInit?RequestInit
-

Returns: Promise‹void | Service[]›

-
-

loadFromPath#

-

▸ loadFromPath(resourcePath: string): Promise‹T›

-

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:262

-

Parameters:

- - - - - - - - - - - - - -
NameType
resourcePathstring
-

Returns: Promise‹T›

-
-

Protected loadItem#

-

▸ loadItem(params: object): Promise‹Service›

-

Inherited from KubeObjectStore.loadItem

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:242

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹Service›

-
-

Protected loadItems#

-

▸ loadItems(__namedParameters: object): Promise‹Service[]›

-

Inherited from KubeObjectStore.loadItems

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:140

-

Parameters:

-

▪ __namedParameters: object

- - - - - - - - - - - - - - - - - - - - - -
NameType
apiKubeApi‹any›
namespacesstring[]
reqInitRequestInit
-

Returns: Promise‹Service[]›

-
-

Protected mergeItems#

-

▸ mergeItems(partialItems: Service[], __namedParameters: object): Service[]

-

Inherited from KubeObjectStore.mergeItems

-

Defined in src/renderer/kube-object.store.ts:218

-

Parameters:

-

▪ partialItems: Service[]

-

▪Default value __namedParameters: object= {}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleantrue
replacebooleanfalse
sortbooleantrue
updateStorebooleantrue
-

Returns: Service[]

-
-

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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
force?boolean
merge?boolean
namespaces?string[]
-

Returns: Promise‹void | T[]›

-
-

remove#

-

▸ remove(item: Service): Promise‹void›

-

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:293

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemService
-

Returns: Promise‹void›

-
-

Protected removeItem#

-

▸ removeItem(item: Service, request: function): Promise‹void›

-

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:154

-

Parameters:

-

▪ item: Service

-

▪ 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:299

-

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:

- - - - - - - - - - - - - -
NameType
errorany
-

Returns: void

-
-

resetSelection#

-

▸ resetSelection(): void

-

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:201

-

Returns: void

-
-

select#

-

▸ select(item: Service): void

-

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:165

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemService
-

Returns: void

-
-

Protected sortItems#

-

▸ sortItems(items: Service[], sorting: function[], order?: "asc" | "desc"): Service[]

-

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:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
itemsService[]this.itemsthe items to be sorted (default: the current items in this store)
sortingfunction[][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: Service[]

-
-

subscribe#

-

▸ subscribe(apis: KubeApi‹any›[]): (Anonymous function)

-

Inherited from KubeObjectStore.subscribe

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:316

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
-

Returns: (Anonymous function)

-
-

toggleSelection#

-

▸ toggleSelection(item: Service): void

-

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:175

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemService
-

Returns: void

-
-

toggleSelectionAll#

-

▸ toggleSelectionAll(visibleItems: Service[]): void

-

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:184

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsService[]this.items
-

Returns: void

-
-

unselect#

-

▸ unselect(item: Service): void

-

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:170

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemService
-

Returns: void

-
-

update#

-

▸ update(item: Service, data: Partial‹Service›): Promise‹Service›

-

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:281

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
itemService
dataPartial‹Service›
-

Returns: Promise‹Service›

-
-

Protected updateFromEventsBuffer#

-

▸ updateFromEventsBuffer(): void

-

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:401

-

Returns: void

-
-

Protected updateItem#

-

▸ updateItem(item: Service, request: function): Promise‹T›

-

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:144

-

Parameters:

-

▪ item: Service

-

▪ request: function

-

▸ (): Promise‹Service›

-

Returns: Promise‹T›

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.statefulsetstore/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.statefulsetstore/index.html deleted file mode 100644 index 3a8436ee6c..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.statefulsetstore/index.html +++ /dev/null @@ -1,2244 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: StatefulSetStore - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: StatefulSetStore#

-

Hierarchy#

-

↳ KubeObjectStore‹StatefulSet›

-

↳ StatefulSetStore

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new StatefulSetStore(): StatefulSetStore

-

Overrides KubeObjectStore.constructor

-

Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:31

-

Returns: StatefulSetStore

-

Properties#

-

api#

-

• api: StatefulSetApi‹› = statefulSetApi

-

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:30

-
-

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:304

-
-

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

-
-

metrics#

-

• metrics: IPodMetrics = null

-

Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:31

-
-

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(): StatefulSet[]

-

Inherited from KubeObjectStore.contextItems

-

Defined in src/renderer/kube-object.store.ts:67

-

Returns: StatefulSet[]

-
-

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(): StatefulSet[]

-

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:47

-

Returns: StatefulSet[]

-

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:306

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
delaynumber1000
-

Returns: void

-
-

create#

-

▸ create(params: object, data?: Partial‹StatefulSet›): Promise‹StatefulSet›

-

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:272

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹StatefulSet›

-

Returns: Promise‹StatefulSet›

-
-

Protected createItem#

-

▸ createItem(params: object, data?: Partial‹StatefulSet›): Promise‹StatefulSet›

-

Inherited from KubeObjectStore.createItem

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:268

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹StatefulSet›

-

Returns: Promise‹StatefulSet›

-
-

Protected defaultSorting#

-

▸ defaultSorting(item: StatefulSet): string

-

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:34

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemStatefulSet
-

Returns: string

-
-

Protected filterItemsOnLoad#

-

▸ filterItemsOnLoad(items: StatefulSet[]): T[]

-

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:166

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsStatefulSet[]
-

Returns: T[]

-
-

getAllByNs#

-

▸ getAllByNs(namespace: string | string[], strict: boolean): StatefulSet[]

-

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:93

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
namespacestring | string[]-
strictbooleanfalse
-

Returns: StatefulSet[]

-
-

getById#

-

▸ getById(id: string): T

-

Inherited from KubeObjectStore.getById

-

Defined in src/renderer/kube-object.store.ts:107

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: T

-
-

getByLabel#

-

▸ getByLabel(labels: string[] | object): StatefulSet[]

-

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:123

-

Parameters:

- - - - - - - - - - - - - -
NameType
labelsstring[] | object
-

Returns: StatefulSet[]

-
-

getByName#

-

▸ getByName(name: string, namespace?: string): StatefulSet

-

Inherited from KubeObjectStore.getByName

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:111

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: StatefulSet

-
-

getByPath#

-

▸ getByPath(path: string): StatefulSet

-

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:119

-

Parameters:

- - - - - - - - - - - - - -
NameType
pathstring
-

Returns: StatefulSet

-
-

getChildPods#

-

▸ getChildPods(statefulSet: StatefulSet): Pod‹›[]

-

Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:47

-

Parameters:

- - - - - - - - - - - - - -
NameType
statefulSetStatefulSet
-

Returns: Pod‹›[]

-
-

getIndexById#

-

▸ getIndexById(id: string): number

-

Inherited from KubeObjectStore.getIndexById

-

Defined in src/renderer/item.store.ts:64

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: number

-
-

getItems#

-

▸ getItems(): StatefulSet[]

-

Inherited from KubeObjectStore.getItems

-

Defined in src/renderer/item.store.ts:51

-

Returns: StatefulSet[]

-
-

getStatuses#

-

▸ getStatuses(statefulSets: StatefulSet[]): object

-

Overrides KubeObjectStore.getStatuses

-

Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:51

-

Parameters:

- - - - - - - - - - - - - -
NameType
statefulSetsStatefulSet[]
-

Returns: object

-
    -
  • -

    failed: number = 0

    -
    • -
  • -

    pending: number = 0

    -
    • -
  • -

    running: number = 0

    -
    • -
-
-

getSubscribeApis#

-

▸ getSubscribeApis(): KubeApi[]

-

Inherited from KubeObjectStore.getSubscribeApis

-

Defined in src/renderer/kube-object.store.ts:312

-

Returns: KubeApi[]

-
-

getTotalCount#

-

▸ getTotalCount(): number

-

Inherited from KubeObjectStore.getTotalCount

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:77

-

Returns: number

-
-

isSelected#

-

▸ isSelected(item: StatefulSet): boolean

-

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:160

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemStatefulSet
-

Returns: boolean

-
-

isSelectedAll#

-

▸ isSelectedAll(visibleItems: StatefulSet[]): boolean

-

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:194

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsStatefulSet[]this.items
-

Returns: boolean

-
-

load#

-

▸ load(params: object): Promise‹StatefulSet›

-

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:247

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹StatefulSet›

-
-

loadAll#

-

▸ loadAll(options: object): Promise‹void | StatefulSet[]›

-

Inherited from KubeObjectStore.loadAll

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:171

-

Parameters:

-

▪Default value options: object= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
merge?boolean
namespaces?string[]
reqInit?RequestInit
-

Returns: Promise‹void | StatefulSet[]›

-
-

loadFromPath#

-

▸ loadFromPath(resourcePath: string): Promise‹T›

-

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:262

-

Parameters:

- - - - - - - - - - - - - -
NameType
resourcePathstring
-

Returns: Promise‹T›

-
-

Protected loadItem#

-

▸ loadItem(params: object): Promise‹StatefulSet›

-

Inherited from KubeObjectStore.loadItem

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:242

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹StatefulSet›

-
-

Protected loadItems#

-

▸ loadItems(__namedParameters: object): Promise‹StatefulSet[]›

-

Inherited from KubeObjectStore.loadItems

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:140

-

Parameters:

-

▪ __namedParameters: object

- - - - - - - - - - - - - - - - - - - - - -
NameType
apiKubeApi‹any›
namespacesstring[]
reqInitRequestInit
-

Returns: Promise‹StatefulSet[]›

-
-

loadMetrics#

-

▸ loadMetrics(statefulSet: StatefulSet): Promise‹void›

-

Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:41

-

Parameters:

- - - - - - - - - - - - - -
NameType
statefulSetStatefulSet
-

Returns: Promise‹void›

-
-

Protected mergeItems#

-

▸ mergeItems(partialItems: StatefulSet[], __namedParameters: object): StatefulSet[]

-

Inherited from KubeObjectStore.mergeItems

-

Defined in src/renderer/kube-object.store.ts:218

-

Parameters:

-

▪ partialItems: StatefulSet[]

-

▪Default value __namedParameters: object= {}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleantrue
replacebooleanfalse
sortbooleantrue
updateStorebooleantrue
-

Returns: StatefulSet[]

-
-

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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
force?boolean
merge?boolean
namespaces?string[]
-

Returns: Promise‹void | T[]›

-
-

remove#

-

▸ remove(item: StatefulSet): Promise‹void›

-

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:293

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemStatefulSet
-

Returns: Promise‹void›

-
-

Protected removeItem#

-

▸ removeItem(item: StatefulSet, request: function): Promise‹void›

-

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:154

-

Parameters:

-

▪ item: StatefulSet

-

▪ 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:299

-

Returns: Promise‹void[]›

-
-

reset#

-

▸ reset(): void

-

Overrides KubeObjectStore.reset

-

Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:71

-

Returns: void

-
-

Protected resetOnError#

-

▸ resetOnError(error: any): void

-

Inherited from KubeObjectStore.resetOnError

-

Defined in src/renderer/kube-object.store.ts:238

-

Parameters:

- - - - - - - - - - - - - -
NameType
errorany
-

Returns: void

-
-

resetSelection#

-

▸ resetSelection(): void

-

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:201

-

Returns: void

-
-

select#

-

▸ select(item: StatefulSet): void

-

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:165

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemStatefulSet
-

Returns: void

-
-

Protected sortItems#

-

▸ sortItems(items: StatefulSet[], sorting: function[], order?: "asc" | "desc"): StatefulSet[]

-

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:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
itemsStatefulSet[]this.itemsthe items to be sorted (default: the current items in this store)
sortingfunction[][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: StatefulSet[]

-
-

subscribe#

-

▸ subscribe(apis: KubeApi‹any›[]): (Anonymous function)

-

Inherited from KubeObjectStore.subscribe

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:316

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
-

Returns: (Anonymous function)

-
-

toggleSelection#

-

▸ toggleSelection(item: StatefulSet): void

-

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:175

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemStatefulSet
-

Returns: void

-
-

toggleSelectionAll#

-

▸ toggleSelectionAll(visibleItems: StatefulSet[]): void

-

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:184

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsStatefulSet[]this.items
-

Returns: void

-
-

unselect#

-

▸ unselect(item: StatefulSet): void

-

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:170

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemStatefulSet
-

Returns: void

-
-

update#

-

▸ update(item: StatefulSet, data: Partial‹StatefulSet›): Promise‹StatefulSet›

-

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:281

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
itemStatefulSet
dataPartial‹StatefulSet›
-

Returns: Promise‹StatefulSet›

-
-

Protected updateFromEventsBuffer#

-

▸ updateFromEventsBuffer(): void

-

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:401

-

Returns: void

-
-

Protected updateItem#

-

▸ updateItem(item: StatefulSet, request: function): Promise‹T›

-

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:144

-

Parameters:

-

▪ item: StatefulSet

-

▪ request: function

-

▸ (): Promise‹StatefulSet›

-

Returns: Promise‹T›

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.storageclassstore/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.storageclassstore/index.html deleted file mode 100644 index 6ffcd71b41..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.storageclassstore/index.html +++ /dev/null @@ -1,2193 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: StorageClassStore - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: StorageClassStore#

-

Hierarchy#

-

↳ KubeObjectStore‹StorageClass›

-

↳ StorageClassStore

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new StorageClassStore(): StorageClassStore

-

Overrides KubeObjectStore.constructor

-

Defined in src/renderer/components/+storage-classes/storage-class.store.ts:29

-

Returns: StorageClassStore

-

Properties#

-

api#

-

• api: KubeApi‹StorageClass‹›› = storageClassApi

-

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+storage-classes/storage-class.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:304

-
-

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#

-

context#

-

• get context(): ClusterContext

-

Inherited from KubeObjectStore.context

-

Defined in src/renderer/kube-object.store.ts:63

-

Returns: ClusterContext

-
-

contextItems#

-

• get contextItems(): StorageClass[]

-

Inherited from KubeObjectStore.contextItems

-

Defined in src/renderer/kube-object.store.ts:67

-

Returns: StorageClass[]

-
-

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(): StorageClass[]

-

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:47

-

Returns: StorageClass[]

-

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:306

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
delaynumber1000
-

Returns: void

-
-

create#

-

▸ create(params: object, data?: Partial‹StorageClass›): Promise‹StorageClass›

-

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:272

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹StorageClass›

-

Returns: Promise‹StorageClass›

-
-

Protected createItem#

-

▸ createItem(params: object, data?: Partial‹StorageClass›): Promise‹StorageClass›

-

Inherited from KubeObjectStore.createItem

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:268

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹StorageClass›

-

Returns: Promise‹StorageClass›

-
-

Protected defaultSorting#

-

▸ defaultSorting(item: StorageClass): string

-

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:34

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemStorageClass
-

Returns: string

-
-

Protected filterItemsOnLoad#

-

▸ filterItemsOnLoad(items: StorageClass[]): T[]

-

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:166

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsStorageClass[]
-

Returns: T[]

-
-

getAllByNs#

-

▸ getAllByNs(namespace: string | string[], strict: boolean): StorageClass[]

-

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:93

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
namespacestring | string[]-
strictbooleanfalse
-

Returns: StorageClass[]

-
-

getById#

-

▸ getById(id: string): T

-

Inherited from KubeObjectStore.getById

-

Defined in src/renderer/kube-object.store.ts:107

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: T

-
-

getByLabel#

-

▸ getByLabel(labels: string[] | object): StorageClass[]

-

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:123

-

Parameters:

- - - - - - - - - - - - - -
NameType
labelsstring[] | object
-

Returns: StorageClass[]

-
-

getByName#

-

▸ getByName(name: string, namespace?: string): StorageClass

-

Inherited from KubeObjectStore.getByName

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:111

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: StorageClass

-
-

getByPath#

-

▸ getByPath(path: string): StorageClass

-

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:119

-

Parameters:

- - - - - - - - - - - - - -
NameType
pathstring
-

Returns: StorageClass

-
-

getIndexById#

-

▸ getIndexById(id: string): number

-

Inherited from KubeObjectStore.getIndexById

-

Defined in src/renderer/item.store.ts:64

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: number

-
-

getItems#

-

▸ getItems(): StorageClass[]

-

Inherited from KubeObjectStore.getItems

-

Defined in src/renderer/item.store.ts:51

-

Returns: StorageClass[]

-
-

getPersistentVolumes#

-

▸ getPersistentVolumes(storageClass: StorageClass): PersistentVolume‹›[]

-

Defined in src/renderer/components/+storage-classes/storage-class.store.ts:36

-

Parameters:

- - - - - - - - - - - - - -
NameType
storageClassStorageClass
-

Returns: PersistentVolume‹›[]

-
-

Optional getStatuses#

-

▸ getStatuses(items: StorageClass[]): Record‹string, number›

-

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:91

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsStorageClass[]
-

Returns: Record‹string, number›

-
-

getSubscribeApis#

-

▸ getSubscribeApis(): KubeApi[]

-

Inherited from KubeObjectStore.getSubscribeApis

-

Defined in src/renderer/kube-object.store.ts:312

-

Returns: KubeApi[]

-
-

getTotalCount#

-

▸ getTotalCount(): number

-

Inherited from KubeObjectStore.getTotalCount

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:77

-

Returns: number

-
-

isSelected#

-

▸ isSelected(item: StorageClass): boolean

-

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:160

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemStorageClass
-

Returns: boolean

-
-

isSelectedAll#

-

▸ isSelectedAll(visibleItems: StorageClass[]): boolean

-

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:194

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsStorageClass[]this.items
-

Returns: boolean

-
-

load#

-

▸ load(params: object): Promise‹StorageClass›

-

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:247

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹StorageClass›

-
-

loadAll#

-

▸ loadAll(options: object): Promise‹void | StorageClass[]›

-

Inherited from KubeObjectStore.loadAll

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:171

-

Parameters:

-

▪Default value options: object= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
merge?boolean
namespaces?string[]
reqInit?RequestInit
-

Returns: Promise‹void | StorageClass[]›

-
-

loadFromPath#

-

▸ loadFromPath(resourcePath: string): Promise‹T›

-

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:262

-

Parameters:

- - - - - - - - - - - - - -
NameType
resourcePathstring
-

Returns: Promise‹T›

-
-

Protected loadItem#

-

▸ loadItem(params: object): Promise‹StorageClass›

-

Inherited from KubeObjectStore.loadItem

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:242

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹StorageClass›

-
-

Protected loadItems#

-

▸ loadItems(__namedParameters: object): Promise‹StorageClass[]›

-

Inherited from KubeObjectStore.loadItems

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:140

-

Parameters:

-

▪ __namedParameters: object

- - - - - - - - - - - - - - - - - - - - - -
NameType
apiKubeApi‹any›
namespacesstring[]
reqInitRequestInit
-

Returns: Promise‹StorageClass[]›

-
-

Protected mergeItems#

-

▸ mergeItems(partialItems: StorageClass[], __namedParameters: object): StorageClass[]

-

Inherited from KubeObjectStore.mergeItems

-

Defined in src/renderer/kube-object.store.ts:218

-

Parameters:

-

▪ partialItems: StorageClass[]

-

▪Default value __namedParameters: object= {}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleantrue
replacebooleanfalse
sortbooleantrue
updateStorebooleantrue
-

Returns: StorageClass[]

-
-

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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
force?boolean
merge?boolean
namespaces?string[]
-

Returns: Promise‹void | T[]›

-
-

remove#

-

▸ remove(item: StorageClass): Promise‹void›

-

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:293

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemStorageClass
-

Returns: Promise‹void›

-
-

Protected removeItem#

-

▸ removeItem(item: StorageClass, request: function): Promise‹void›

-

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:154

-

Parameters:

-

▪ item: StorageClass

-

▪ 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:299

-

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:

- - - - - - - - - - - - - -
NameType
errorany
-

Returns: void

-
-

resetSelection#

-

▸ resetSelection(): void

-

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:201

-

Returns: void

-
-

select#

-

▸ select(item: StorageClass): void

-

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:165

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemStorageClass
-

Returns: void

-
-

Protected sortItems#

-

▸ sortItems(items: StorageClass[], sorting: function[], order?: "asc" | "desc"): StorageClass[]

-

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:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
itemsStorageClass[]this.itemsthe items to be sorted (default: the current items in this store)
sortingfunction[][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: StorageClass[]

-
-

subscribe#

-

▸ subscribe(apis: KubeApi‹any›[]): (Anonymous function)

-

Inherited from KubeObjectStore.subscribe

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:316

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
-

Returns: (Anonymous function)

-
-

toggleSelection#

-

▸ toggleSelection(item: StorageClass): void

-

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:175

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemStorageClass
-

Returns: void

-
-

toggleSelectionAll#

-

▸ toggleSelectionAll(visibleItems: StorageClass[]): void

-

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:184

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsStorageClass[]this.items
-

Returns: void

-
-

unselect#

-

▸ unselect(item: StorageClass): void

-

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:170

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemStorageClass
-

Returns: void

-
-

update#

-

▸ update(item: StorageClass, data: Partial‹StorageClass›): Promise‹StorageClass›

-

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:281

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
itemStorageClass
dataPartial‹StorageClass›
-

Returns: Promise‹StorageClass›

-
-

Protected updateFromEventsBuffer#

-

▸ updateFromEventsBuffer(): void

-

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:401

-

Returns: void

-
-

Protected updateItem#

-

▸ updateItem(item: StorageClass, request: function): Promise‹T›

-

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:144

-

Parameters:

-

▪ item: StorageClass

-

▪ request: function

-

▸ (): Promise‹StorageClass›

-

Returns: Promise‹T›

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.volumeclaimstore/index.html b/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.volumeclaimstore/index.html deleted file mode 100644 index 80a6e6c4bf..0000000000 --- a/master/extensions/api/classes/_renderer_api_index_._renderer_api_k8s_api_.volumeclaimstore/index.html +++ /dev/null @@ -1,2205 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: VolumeClaimStore - Lens Extension API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: VolumeClaimStore#

-

Hierarchy#

-

↳ KubeObjectStore‹PersistentVolumeClaim›

-

↳ VolumeClaimStore

-

Index#

-

Constructors#

- -

Properties#

- -

Accessors#

- -

Methods#

- -

Constructors#

-

constructor#

-

+ new VolumeClaimStore(): VolumeClaimStore

-

Overrides KubeObjectStore.constructor

-

Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:30

-

Returns: VolumeClaimStore

-

Properties#

-

api#

-

• api: PersistentVolumeClaimsApi‹› = pvcApi

-

Overrides KubeObjectStore.api

-

Defined in src/renderer/components/+storage-volume-claims/volume-claim.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:304

-
-

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

-
-

metrics#

-

• metrics: IPvcMetrics = null

-

Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:30

-
-

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(): PersistentVolumeClaim[]

-

Inherited from KubeObjectStore.contextItems

-

Defined in src/renderer/kube-object.store.ts:67

-

Returns: PersistentVolumeClaim[]

-
-

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(): PersistentVolumeClaim[]

-

Inherited from KubeObjectStore.selectedItems

-

Defined in src/renderer/item.store.ts:47

-

Returns: PersistentVolumeClaim[]

-

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:306

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
delaynumber1000
-

Returns: void

-
-

create#

-

▸ create(params: object, data?: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim›

-

Inherited from KubeObjectStore.create

-

Defined in src/renderer/kube-object.store.ts:272

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹PersistentVolumeClaim›

-

Returns: Promise‹PersistentVolumeClaim›

-
-

Protected createItem#

-

▸ createItem(params: object, data?: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim›

-

Inherited from KubeObjectStore.createItem

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:268

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

▪Optional data: Partial‹PersistentVolumeClaim›

-

Returns: Promise‹PersistentVolumeClaim›

-
-

Protected defaultSorting#

-

▸ defaultSorting(item: PersistentVolumeClaim): string

-

Inherited from KubeObjectStore.defaultSorting

-

Defined in src/renderer/item.store.ts:34

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemPersistentVolumeClaim
-

Returns: string

-
-

Protected filterItemsOnLoad#

-

▸ filterItemsOnLoad(items: PersistentVolumeClaim[]): T[]

-

Inherited from KubeObjectStore.filterItemsOnLoad

-

Defined in src/renderer/kube-object.store.ts:166

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsPersistentVolumeClaim[]
-

Returns: T[]

-
-

getAllByNs#

-

▸ getAllByNs(namespace: string | string[], strict: boolean): PersistentVolumeClaim[]

-

Inherited from KubeObjectStore.getAllByNs

-

Defined in src/renderer/kube-object.store.ts:93

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
namespacestring | string[]-
strictbooleanfalse
-

Returns: PersistentVolumeClaim[]

-
-

getById#

-

▸ getById(id: string): T

-

Inherited from KubeObjectStore.getById

-

Defined in src/renderer/kube-object.store.ts:107

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: T

-
-

getByLabel#

-

▸ getByLabel(labels: string[] | object): PersistentVolumeClaim[]

-

Inherited from KubeObjectStore.getByLabel

-

Defined in src/renderer/kube-object.store.ts:123

-

Parameters:

- - - - - - - - - - - - - -
NameType
labelsstring[] | object
-

Returns: PersistentVolumeClaim[]

-
-

getByName#

-

▸ getByName(name: string, namespace?: string): PersistentVolumeClaim

-

Inherited from KubeObjectStore.getByName

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:111

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: PersistentVolumeClaim

-
-

getByPath#

-

▸ getByPath(path: string): PersistentVolumeClaim

-

Inherited from KubeObjectStore.getByPath

-

Defined in src/renderer/kube-object.store.ts:119

-

Parameters:

- - - - - - - - - - - - - -
NameType
pathstring
-

Returns: PersistentVolumeClaim

-
-

getIndexById#

-

▸ getIndexById(id: string): number

-

Inherited from KubeObjectStore.getIndexById

-

Defined in src/renderer/item.store.ts:64

-

Parameters:

- - - - - - - - - - - - - -
NameType
idstring
-

Returns: number

-
-

getItems#

-

▸ getItems(): PersistentVolumeClaim[]

-

Inherited from KubeObjectStore.getItems

-

Defined in src/renderer/item.store.ts:51

-

Returns: PersistentVolumeClaim[]

-
-

Optional getStatuses#

-

▸ getStatuses(items: PersistentVolumeClaim[]): Record‹string, number›

-

Inherited from KubeObjectStore.getStatuses

-

Defined in src/renderer/kube-object.store.ts:91

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemsPersistentVolumeClaim[]
-

Returns: Record‹string, number›

-
-

getSubscribeApis#

-

▸ getSubscribeApis(): KubeApi[]

-

Inherited from KubeObjectStore.getSubscribeApis

-

Defined in src/renderer/kube-object.store.ts:312

-

Returns: KubeApi[]

-
-

getTotalCount#

-

▸ getTotalCount(): number

-

Inherited from KubeObjectStore.getTotalCount

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:77

-

Returns: number

-
-

isSelected#

-

▸ isSelected(item: PersistentVolumeClaim): boolean

-

Inherited from KubeObjectStore.isSelected

-

Defined in src/renderer/item.store.ts:160

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemPersistentVolumeClaim
-

Returns: boolean

-
-

isSelectedAll#

-

▸ isSelectedAll(visibleItems: PersistentVolumeClaim[]): boolean

-

Inherited from KubeObjectStore.isSelectedAll

-

Defined in src/renderer/item.store.ts:194

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsPersistentVolumeClaim[]this.items
-

Returns: boolean

-
-

load#

-

▸ load(params: object): Promise‹PersistentVolumeClaim›

-

Inherited from KubeObjectStore.load

-

Defined in src/renderer/kube-object.store.ts:247

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹PersistentVolumeClaim›

-
-

loadAll#

-

▸ loadAll(options: object): Promise‹void | PersistentVolumeClaim[]›

-

Inherited from KubeObjectStore.loadAll

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:171

-

Parameters:

-

▪Default value options: object= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
merge?boolean
namespaces?string[]
reqInit?RequestInit
-

Returns: Promise‹void | PersistentVolumeClaim[]›

-
-

loadFromPath#

-

▸ loadFromPath(resourcePath: string): Promise‹T›

-

Inherited from KubeObjectStore.loadFromPath

-

Defined in src/renderer/kube-object.store.ts:262

-

Parameters:

- - - - - - - - - - - - - -
NameType
resourcePathstring
-

Returns: Promise‹T›

-
-

Protected loadItem#

-

▸ loadItem(params: object): Promise‹PersistentVolumeClaim›

-

Inherited from KubeObjectStore.loadItem

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:242

-

Parameters:

-

▪ params: object

- - - - - - - - - - - - - - - - - -
NameType
namestring
namespace?string
-

Returns: Promise‹PersistentVolumeClaim›

-
-

Protected loadItems#

-

▸ loadItems(__namedParameters: object): Promise‹PersistentVolumeClaim[]›

-

Inherited from KubeObjectStore.loadItems

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:140

-

Parameters:

-

▪ __namedParameters: object

- - - - - - - - - - - - - - - - - - - - - -
NameType
apiKubeApi‹any›
namespacesstring[]
reqInitRequestInit
-

Returns: Promise‹PersistentVolumeClaim[]›

-
-

loadMetrics#

-

▸ loadMetrics(pvc: PersistentVolumeClaim): Promise‹void›

-

Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:40

-

Parameters:

- - - - - - - - - - - - - -
NameType
pvcPersistentVolumeClaim
-

Returns: Promise‹void›

-
-

Protected mergeItems#

-

▸ mergeItems(partialItems: PersistentVolumeClaim[], __namedParameters: object): PersistentVolumeClaim[]

-

Inherited from KubeObjectStore.mergeItems

-

Defined in src/renderer/kube-object.store.ts:218

-

Parameters:

-

▪ partialItems: PersistentVolumeClaim[]

-

▪Default value __namedParameters: object= {}

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
filterbooleantrue
replacebooleanfalse
sortbooleantrue
updateStorebooleantrue
-

Returns: PersistentVolumeClaim[]

-
-

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= {}

- - - - - - - - - - - - - - - - - - - - - -
NameType
force?boolean
merge?boolean
namespaces?string[]
-

Returns: Promise‹void | T[]›

-
-

remove#

-

▸ remove(item: PersistentVolumeClaim): Promise‹void›

-

Inherited from KubeObjectStore.remove

-

Defined in src/renderer/kube-object.store.ts:293

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemPersistentVolumeClaim
-

Returns: Promise‹void›

-
-

Protected removeItem#

-

▸ removeItem(item: PersistentVolumeClaim, request: function): Promise‹void›

-

Inherited from KubeObjectStore.removeItem

-

Defined in src/renderer/item.store.ts:154

-

Parameters:

-

▪ item: PersistentVolumeClaim

-

▪ 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:299

-

Returns: Promise‹void[]›

-
-

reset#

-

▸ reset(): void

-

Overrides KubeObjectStore.reset

-

Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:44

-

Returns: void

-
-

Protected resetOnError#

-

▸ resetOnError(error: any): void

-

Inherited from KubeObjectStore.resetOnError

-

Defined in src/renderer/kube-object.store.ts:238

-

Parameters:

- - - - - - - - - - - - - -
NameType
errorany
-

Returns: void

-
-

resetSelection#

-

▸ resetSelection(): void

-

Inherited from KubeObjectStore.resetSelection

-

Defined in src/renderer/item.store.ts:201

-

Returns: void

-
-

select#

-

▸ select(item: PersistentVolumeClaim): void

-

Inherited from KubeObjectStore.select

-

Defined in src/renderer/item.store.ts:165

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemPersistentVolumeClaim
-

Returns: void

-
-

Protected sortItems#

-

▸ sortItems(items: PersistentVolumeClaim[], sorting: function[], order?: "asc" | "desc"): PersistentVolumeClaim[]

-

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:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
itemsPersistentVolumeClaim[]this.itemsthe items to be sorted (default: the current items in this store)
sortingfunction[][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: PersistentVolumeClaim[]

-
-

subscribe#

-

▸ subscribe(apis: KubeApi‹any›[]): (Anonymous function)

-

Inherited from KubeObjectStore.subscribe

-

Overrides void

-

Defined in src/renderer/kube-object.store.ts:316

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
-

Returns: (Anonymous function)

-
-

toggleSelection#

-

▸ toggleSelection(item: PersistentVolumeClaim): void

-

Inherited from KubeObjectStore.toggleSelection

-

Defined in src/renderer/item.store.ts:175

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemPersistentVolumeClaim
-

Returns: void

-
-

toggleSelectionAll#

-

▸ toggleSelectionAll(visibleItems: PersistentVolumeClaim[]): void

-

Inherited from KubeObjectStore.toggleSelectionAll

-

Defined in src/renderer/item.store.ts:184

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
visibleItemsPersistentVolumeClaim[]this.items
-

Returns: void

-
-

unselect#

-

▸ unselect(item: PersistentVolumeClaim): void

-

Inherited from KubeObjectStore.unselect

-

Defined in src/renderer/item.store.ts:170

-

Parameters:

- - - - - - - - - - - - - -
NameType
itemPersistentVolumeClaim
-

Returns: void

-
-

update#

-

▸ update(item: PersistentVolumeClaim, data: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim›

-

Inherited from KubeObjectStore.update

-

Defined in src/renderer/kube-object.store.ts:281

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameType
itemPersistentVolumeClaim
dataPartial‹PersistentVolumeClaim›
-

Returns: Promise‹PersistentVolumeClaim›

-
-

Protected updateFromEventsBuffer#

-

▸ updateFromEventsBuffer(): void

-

Inherited from KubeObjectStore.updateFromEventsBuffer

-

Defined in src/renderer/kube-object.store.ts:401

-

Returns: void

-
-

Protected updateItem#

-

▸ updateItem(item: PersistentVolumeClaim, request: function): Promise‹T›

-

Inherited from KubeObjectStore.updateItem

-

Defined in src/renderer/item.store.ts:144

-

Parameters:

-

▪ item: PersistentVolumeClaim

-

▪ request: function

-

▸ (): Promise‹PersistentVolumeClaim›

-

Returns: Promise‹T›

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_common_api_index_._common_api_catalog_.kubernetesclustercategory/index.html b/master/extensions/api/classes/common.catalog.catalogcategory/index.html similarity index 62% rename from master/extensions/api/classes/_common_api_index_._common_api_catalog_.kubernetesclustercategory/index.html rename to master/extensions/api/classes/common.catalog.catalogcategory/index.html index 598e95e3b6..78b37aceec 100644 --- a/master/extensions/api/classes/_common_api_index_._common_api_catalog_.kubernetesclustercategory/index.html +++ b/master/extensions/api/classes/common.catalog.catalogcategory/index.html @@ -9,7 +9,7 @@ - + @@ -19,7 +19,7 @@ - Class: KubernetesClusterCategory ‹**Events**› - Lens Extension API + Class: CatalogCategory - Lens Extension API @@ -72,7 +72,7 @@
- + Skip to content @@ -103,7 +103,7 @@
- Class: KubernetesClusterCategory ‹**Events**› + Class: CatalogCategory
@@ -590,13 +590,6 @@ @@ -813,77 +813,8 @@
  • - - Static parseId - - -
    • - - - - - - -
  • - - Object literals - - -