Skip to content

@k8slens/extensions / Exports / Main / LensExtension

Class: LensExtension#

Main.LensExtension

Hierarchy#

↳ LensExtension

Table of contents#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

• new LensExtension(extension)

Parameters#

Name Type
extension InstalledExtension

Overrides#

LensExtension.constructor

Properties#

appMenus#

• appMenus: MenuRegistration[] | IComputedValue<MenuRegistration[]>

id#

• Readonly id: string

Inherited from#

LensExtension.id

isBundled#

• Readonly isBundled: boolean

Inherited from#

LensExtension.isBundled

manifest#

• Readonly manifest: LensExtensionManifest

Inherited from#

LensExtension.manifest

manifestPath#

• Readonly manifestPath: string

Inherited from#

LensExtension.manifestPath

protocolHandlers#

• protocolHandlers: ProtocolHandlerRegistration[]

Inherited from#

LensExtension.protocolHandlers

terminalShellEnvModifier#

• Optional terminalShellEnvModifier: ShellEnvModifier

implement this to modify the shell environment that Lens terminals are opened with. The ShellEnvModifier type has the signature

(ctx: ShellEnvContext, env: Record) => Record

Param

the shell environment context, specifically the relevant catalog entity for the terminal. This can be used, for example, to get cluster-specific information that can be made available in the shell environment by the implementation of terminalShellEnvModifier

Param

the current shell environment that the terminal will be opened with. The implementation should modify this as desired.

trayMenus#

• trayMenus: TrayMenuRegistration[] | IComputedValue<TrayMenuRegistration[]>

Accessors#

description#

• get description(): undefined | string

Returns#

undefined | string

Inherited from#

LensExtension.description

isEnabled#

• get isEnabled(): boolean

Returns#

boolean

Inherited from#

LensExtension.isEnabled

name#

• get name(): string

Returns#

string

Inherited from#

LensExtension.name

sanitizedExtensionId#

• get sanitizedExtensionId(): string

Returns#

string

Inherited from#

LensExtension.sanitizedExtensionId

storeName#

• get storeName(): string

Returns#

string

Inherited from#

LensExtension.storeName

version#

• get version(): string

Returns#

string

Inherited from#

LensExtension.version

Methods#

activate#

▸ activate(): Promise<void>

Returns#

Promise<void>

Inherited from#

LensExtension.activate

addCatalogSource#

▸ addCatalogSource(id, source): void

Parameters#

Name Type
id string
source IObservableArray<CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>> | IComputedValue<CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>[]>

Returns#

void

disable#

▸ disable(): Promise<void>

Returns#

Promise<void>

Inherited from#

LensExtension.disable

enable#

▸ enable(): Promise<void>

Returns#

Promise<void>

Inherited from#

LensExtension.enable

getExtensionFileFolder#

▸ getExtensionFileFolder(): Promise<string>

getExtensionFileFolder returns the path to an already created folder. This folder is for the sole use of this extension.

Note: there is no security done on this folder, only obfuscation of the folder name.

Returns#

Promise<string>

Inherited from#

LensExtension.getExtensionFileFolder

▸ navigate(pageId?, params?, frameId?): Promise<void>

Parameters#

Name Type
pageId? string
params? Record<string, any>
frameId? number

Returns#

Promise<void>

onActivate#

▸ Protected onActivate(): void | Promise<void>

Returns#

void | Promise<void>

Inherited from#

LensExtension.onActivate

onDeactivate#

▸ Protected onDeactivate(): void | Promise<void>

Returns#

void | Promise<void>

Inherited from#

LensExtension.onDeactivate

removeCatalogSource#

▸ removeCatalogSource(id): void

Parameters#

Name Type
id string

Returns#

void