Skip to content

@k8slens/extensions / Exports / Common / LensExtension

Class: LensExtension#

Common.LensExtension

Hierarchy#

  • LensExtension

LensExtension

LensExtension

Table of contents#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

new LensExtension(deps, «destructured»)

Parameters#

Name Type
deps LensExtensionDependencies
«destructured» InstalledExtension

Properties#

id#

Readonly id: string


isBundled#

Readonly isBundled: boolean


manifest#

Readonly manifest: LensExtensionManifest


manifestPath#

Readonly manifestPath: string


protocolHandlers#

protocolHandlers: ProtocolHandlerRegistration[]

Accessors#

description#

get description(): undefined | string

Returns#

undefined | string


isEnabled#

get isEnabled(): boolean

Returns#

boolean


name#

get name(): string

Returns#

string


sanitizedExtensionId#

get sanitizedExtensionId(): string

Returns#

string


storeName#

get storeName(): string

Returns#

string


version#

get version(): string

Returns#

string

Methods#

activate#

activate(): Promise<void>

Returns#

Promise<void>


disable#

disable(): Promise<void>

Returns#

Promise<void>


enable#

enable(): Promise<void>

Returns#

Promise<void>


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>


onActivate#

Protected onActivate(): void | Promise<void>

Returns#

void | Promise<void>


onDeactivate#

Protected onDeactivate(): void | Promise<void>

Returns#

void | Promise<void>