Skip to main content

Interface: IContextApi

Defined in: Extensions/ExtensionApiTypes.ts:430

Properties​

onDidChange​

onDidChange: IEventApi<{ keys: string[]; }>

Defined in: Extensions/ExtensionApiTypes.ts:440

Methods​

get()​

get(key): Promise<WhenContextValue | undefined>

Defined in: Extensions/ExtensionApiTypes.ts:432

Read a context key (built-in or extension-namespaced).

Parameters​

key​

string

Returns​

Promise<WhenContextValue | undefined>

set()​

set(key, value): Promise<void>

Defined in: Extensions/ExtensionApiTypes.ts:438

Set an extension-namespaced context key. Throws on attempts to set built-in keys (only ext.<id>.* keys are writable from extensions).

Parameters​

key​

string

value​

WhenContextValue

Returns​

Promise<void>