You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
547 lines
29 KiB
547 lines
29 KiB
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>ExtensionContext | VS Code API 中文文档</title>
|
|
<meta name="description" content="Documentation for VS Code API 中文文档">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<div class="tsd-page-toolbar">
|
|
<div class="container">
|
|
<div class="table-wrap">
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
<div class="field">
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
<input id="tsd-search-field" type="text" />
|
|
</div>
|
|
<ul class="results">
|
|
<li class="state loading">Preparing search index...</li>
|
|
<li class="state failure">The search index is not available</li>
|
|
</ul>
|
|
<a href="../index.html" class="title">VS Code API 中文文档</a>
|
|
</div>
|
|
<div class="table-cell" id="tsd-widgets">
|
|
<div id="tsd-filter">
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
<div class="tsd-filter-group">
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
<span class="tsd-select-label">All</span>
|
|
<ul class="tsd-select-list">
|
|
<li data-value="public">Public</li>
|
|
<li data-value="protected">Public/Protected</li>
|
|
<li data-value="private" class="selected">All</li>
|
|
</ul>
|
|
</div>
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
</div>
|
|
</div>
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="tsd-page-title">
|
|
<div class="container">
|
|
<ul class="tsd-breadcrumb">
|
|
<li>
|
|
<a href="../index.html">VS Code API 中文文档</a>
|
|
</li>
|
|
<li>
|
|
<a href="ExtensionContext.html">ExtensionContext</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Interface ExtensionContext</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<section class="tsd-panel tsd-comment">
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>An extension context is a collection of utilities private to an
|
|
extension.</p>
|
|
</div>
|
|
<p>An instance of an <code>ExtensionContext</code> is provided as the first
|
|
parameter to the <code>activate</code>-call of an extension.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">ExtensionContext</span>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<h2>Index</h2>
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<div class="tsd-index-content">
|
|
<section class="tsd-index-section ">
|
|
<h3>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ExtensionContext.html#subscriptions" class="tsd-kind-icon">subscriptions</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ExtensionContext.html#workspaceState" class="tsd-kind-icon">workspace<wbr>State</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ExtensionContext.html#globalState" class="tsd-kind-icon">global<wbr>State</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ExtensionContext.html#secrets" class="tsd-kind-icon">secrets</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ExtensionContext.html#extensionUri" class="tsd-kind-icon">extension<wbr>Uri</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ExtensionContext.html#extensionPath" class="tsd-kind-icon">extension<wbr>Path</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ExtensionContext.html#environmentVariableCollection" class="tsd-kind-icon">environment<wbr>Variable<wbr>Collection</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ExtensionContext.html#storageUri" class="tsd-kind-icon">storage<wbr>Uri</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ExtensionContext.html#storagePath" class="tsd-kind-icon">storage<wbr>Path</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ExtensionContext.html#globalStorageUri" class="tsd-kind-icon">global<wbr>Storage<wbr>Uri</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ExtensionContext.html#globalStoragePath" class="tsd-kind-icon">global<wbr>Storage<wbr>Path</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ExtensionContext.html#logUri" class="tsd-kind-icon">log<wbr>Uri</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ExtensionContext.html#logPath" class="tsd-kind-icon">log<wbr>Path</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ExtensionContext.html#extensionMode" class="tsd-kind-icon">extension<wbr>Mode</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ExtensionContext.html#extension" class="tsd-kind-icon">extension</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Methods</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="ExtensionContext.html#asAbsolutePath" class="tsd-kind-icon">as<wbr>Absolute<wbr>Path</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Properties</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="subscriptions" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> subscriptions</h3>
|
|
<div class="tsd-signature tsd-kind-icon">subscriptions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>dispose<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L6068">vscode.d.ts:6068</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>An array to which disposables can be added. When this
|
|
extension is deactivated the disposables will be disposed.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="workspaceState" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> workspace<wbr>State</h3>
|
|
<div class="tsd-signature tsd-kind-icon">workspace<wbr>State<span class="tsd-signature-symbol">:</span> <a href="Memento.html" class="tsd-signature-type" data-tsd-kind="Interface">Memento</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L6074">vscode.d.ts:6074</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>A memento object that stores state in the context
|
|
of the currently opened <a href="../modules/workspace.html#workspaceFolders">workspace</a>.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="globalState" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> global<wbr>State</h3>
|
|
<div class="tsd-signature tsd-kind-icon">global<wbr>State<span class="tsd-signature-symbol">:</span> <a href="Memento.html" class="tsd-signature-type" data-tsd-kind="Interface">Memento</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>setKeysForSync<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L6080">vscode.d.ts:6080</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>A memento object that stores state independent
|
|
of the current opened <a href="../modules/workspace.html#workspaceFolders">workspace</a>.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="secrets" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> secrets</h3>
|
|
<div class="tsd-signature tsd-kind-icon">secrets<span class="tsd-signature-symbol">:</span> <a href="SecretStorage.html" class="tsd-signature-type" data-tsd-kind="Interface">SecretStorage</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L6101">vscode.d.ts:6101</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>A storage utility for secrets. Secrets are persisted across reloads and are independent of the
|
|
current opened <a href="../modules/workspace.html#workspaceFolders">workspace</a>.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="extensionUri" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> extension<wbr>Uri</h3>
|
|
<div class="tsd-signature tsd-kind-icon">extension<wbr>Uri<span class="tsd-signature-symbol">:</span> <a href="../classes/Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L6106">vscode.d.ts:6106</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The uri of the directory containing the extension.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="extensionPath" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> extension<wbr>Path</h3>
|
|
<div class="tsd-signature tsd-kind-icon">extension<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L6112">vscode.d.ts:6112</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The absolute file path of the directory containing the extension. Shorthand
|
|
notation for <a href="TextDocument.html#uri">ExtensionContext.extensionUri.fsPath</a> (independent of the uri scheme).</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="environmentVariableCollection" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> environment<wbr>Variable<wbr>Collection</h3>
|
|
<div class="tsd-signature tsd-kind-icon">environment<wbr>Variable<wbr>Collection<span class="tsd-signature-symbol">:</span> <a href="EnvironmentVariableCollection.html" class="tsd-signature-type" data-tsd-kind="Interface">EnvironmentVariableCollection</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L6118">vscode.d.ts:6118</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Gets the extension's environment variable collection for this workspace, enabling changes
|
|
to be applied to terminal environment variables.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="storageUri" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> storage<wbr>Uri</h3>
|
|
<div class="tsd-signature tsd-kind-icon">storage<wbr>Uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../classes/Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L6143">vscode.d.ts:6143</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The uri of a workspace specific directory in which the extension
|
|
can store private state. The directory might not exist and creation is
|
|
up to the extension. However, the parent directory is guaranteed to be existent.
|
|
The value is <code>undefined</code> when no workspace nor folder has been opened.</p>
|
|
</div>
|
|
<p>Use <a href="ExtensionContext.html#workspaceState"><code>workspaceState</code></a> or
|
|
<a href="ExtensionContext.html#globalState"><code>globalState</code></a> to store key value data.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>see</dt>
|
|
<dd><p><a href="FileSystem.html"><code>workspace.fs</code></a> for how to read and write files and folders from
|
|
an uri.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="storagePath" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> storage<wbr>Path</h3>
|
|
<div class="tsd-signature tsd-kind-icon">storage<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L6155">vscode.d.ts:6155</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>An absolute file path of a workspace specific directory in which the extension
|
|
can store private state. The directory might not exist on disk and creation is
|
|
up to the extension. However, the parent directory is guaranteed to be existent.</p>
|
|
</div>
|
|
<p>Use <a href="ExtensionContext.html#workspaceState"><code>workspaceState</code></a> or
|
|
<a href="ExtensionContext.html#globalState"><code>globalState</code></a> to store key value data.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>deprecated</dt>
|
|
<dd><p>Use <a href="ExtensionContext.html#storageUri">storageUri</a> instead.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="globalStorageUri" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> global<wbr>Storage<wbr>Uri</h3>
|
|
<div class="tsd-signature tsd-kind-icon">global<wbr>Storage<wbr>Uri<span class="tsd-signature-symbol">:</span> <a href="../classes/Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L6167">vscode.d.ts:6167</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The uri of a directory in which the extension can store global state.
|
|
The directory might not exist on disk and creation is
|
|
up to the extension. However, the parent directory is guaranteed to be existent.</p>
|
|
</div>
|
|
<p>Use <a href="ExtensionContext.html#globalState"><code>globalState</code></a> to store key value data.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>see</dt>
|
|
<dd><p><a href="FileSystem.html"><code>workspace.fs</code></a> for how to read and write files and folders from
|
|
an uri.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="globalStoragePath" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> global<wbr>Storage<wbr>Path</h3>
|
|
<div class="tsd-signature tsd-kind-icon">global<wbr>Storage<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L6178">vscode.d.ts:6178</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>An absolute file path in which the extension can store global state.
|
|
The directory might not exist on disk and creation is
|
|
up to the extension. However, the parent directory is guaranteed to be existent.</p>
|
|
</div>
|
|
<p>Use <a href="ExtensionContext.html#globalState"><code>globalState</code></a> to store key value data.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>deprecated</dt>
|
|
<dd><p>Use <a href="ExtensionContext.html#globalStorageUri">globalStorageUri</a> instead.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="logUri" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> log<wbr>Uri</h3>
|
|
<div class="tsd-signature tsd-kind-icon">log<wbr>Uri<span class="tsd-signature-symbol">:</span> <a href="../classes/Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L6188">vscode.d.ts:6188</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The uri of a directory in which the extension can create log files.
|
|
The directory might not exist on disk and creation is up to the extension. However,
|
|
the parent directory is guaranteed to be existent.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>see</dt>
|
|
<dd><p><a href="FileSystem.html"><code>workspace.fs</code></a> for how to read and write files and folders from
|
|
an uri.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="logPath" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> log<wbr>Path</h3>
|
|
<div class="tsd-signature tsd-kind-icon">log<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L6197">vscode.d.ts:6197</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>An absolute file path of a directory in which the extension can create log files.
|
|
The directory might not exist on disk and creation is up to the extension. However,
|
|
the parent directory is guaranteed to be existent.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>deprecated</dt>
|
|
<dd><p>Use <a href="ExtensionContext.html#logUri">logUri</a> instead.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="extensionMode" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> extension<wbr>Mode</h3>
|
|
<div class="tsd-signature tsd-kind-icon">extension<wbr>Mode<span class="tsd-signature-symbol">:</span> <a href="../enums/ExtensionMode.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ExtensionMode</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L6204">vscode.d.ts:6204</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The mode the extension is running in. This is specific to the current
|
|
extension. One extension may be in <code>ExtensionMode.Development</code> while
|
|
other extensions in the host run in <code>ExtensionMode.Release</code>.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
<a name="extension" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> extension</h3>
|
|
<div class="tsd-signature tsd-kind-icon">extension<span class="tsd-signature-symbol">:</span> <a href="Extension.html" class="tsd-signature-type" data-tsd-kind="Interface">Extension</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L6209">vscode.d.ts:6209</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The current <code>Extension</code> instance.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Methods</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
|
<a name="asAbsolutePath" class="tsd-anchor"></a>
|
|
<h3>as<wbr>Absolute<wbr>Path</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
<li class="tsd-signature tsd-kind-icon">as<wbr>Absolute<wbr>Path<span class="tsd-signature-symbol">(</span>relativePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/bea8f92/vscode.d.ts#L6129">vscode.d.ts:6129</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Get the absolute path of a resource contained in the extension.</p>
|
|
</div>
|
|
<p><em>Note</em> that an absolute uri can be constructed via <a href="../classes/Uri.html#joinPath"><code>Uri.joinPath</code></a> and
|
|
<a href="ExtensionContext.html#extensionUri"><code>extensionUri</code></a>, e.g. <code>vscode.Uri.joinPath(context.extensionUri, relativePath);</code></p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>relativePath: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A relative path to a resource contained in the extension.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
<p>The absolute path of the resource.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class=" ">
|
|
<a href="../index.html">Exports</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-interface">
|
|
<a href="ExtensionContext.html" class="tsd-kind-icon">Extension<wbr>Context</a>
|
|
<ul>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="ExtensionContext.html#subscriptions" class="tsd-kind-icon">subscriptions</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="ExtensionContext.html#workspaceState" class="tsd-kind-icon">workspace<wbr>State</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="ExtensionContext.html#globalState" class="tsd-kind-icon">global<wbr>State</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="ExtensionContext.html#secrets" class="tsd-kind-icon">secrets</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="ExtensionContext.html#extensionUri" class="tsd-kind-icon">extension<wbr>Uri</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="ExtensionContext.html#extensionPath" class="tsd-kind-icon">extension<wbr>Path</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="ExtensionContext.html#environmentVariableCollection" class="tsd-kind-icon">environment<wbr>Variable<wbr>Collection</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
<a href="ExtensionContext.html#asAbsolutePath" class="tsd-kind-icon">as<wbr>Absolute<wbr>Path</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="ExtensionContext.html#storageUri" class="tsd-kind-icon">storage<wbr>Uri</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="ExtensionContext.html#storagePath" class="tsd-kind-icon">storage<wbr>Path</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="ExtensionContext.html#globalStorageUri" class="tsd-kind-icon">global<wbr>Storage<wbr>Uri</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="ExtensionContext.html#globalStoragePath" class="tsd-kind-icon">global<wbr>Storage<wbr>Path</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="ExtensionContext.html#logUri" class="tsd-kind-icon">log<wbr>Uri</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="ExtensionContext.html#logPath" class="tsd-kind-icon">log<wbr>Path</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="ExtensionContext.html#extensionMode" class="tsd-kind-icon">extension<wbr>Mode</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
<a href="ExtensionContext.html#extension" class="tsd-kind-icon">extension</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<footer class="with-border-bottom">
|
|
<div class="container">
|
|
<h2>Legend</h2>
|
|
<div class="tsd-legend-group">
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="container tsd-generator">
|
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
</div>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
</body>
|
|
</html> |