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.
277 lines
14 KiB
277 lines
14 KiB
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>TestRunRequest | 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="../modules.html">VS Code API</a>
|
|
</li>
|
|
<li>
|
|
<a href="TestRunRequest.html">TestRunRequest</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Class TestRunRequest</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>A TestRunRequest is a precursor to a <a href="../interfaces/TestRun.html">TestRun</a>, which in turn is
|
|
created by passing a request to {@link tests.runTests}. The TestRunRequest
|
|
contains information about which tests should be run, which should not be
|
|
run, and how they are run (via the <a href="TestRunRequest.html#profile">profile</a>).</p>
|
|
</div>
|
|
<p>In general, TestRunRequests are created by the editor and pass to
|
|
<a href="../interfaces/TestRunProfile.html#runHandler">TestRunProfile.runHandler</a>, however you can also create test
|
|
requests and runs outside of the <code>runHandler</code>.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">TestRunRequest</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>Constructors</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="TestRunRequest.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="TestRunRequest.html#include" class="tsd-kind-icon">include</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="TestRunRequest.html#exclude" class="tsd-kind-icon">exclude</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="TestRunRequest.html#profile" class="tsd-kind-icon">profile</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Constructors</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
|
<a name="constructor" class="tsd-anchor"></a>
|
|
<h3>constructor</h3>
|
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>Test<wbr>Run<wbr>Request<span class="tsd-signature-symbol">(</span>include<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">readonly </span><a href="../interfaces/TestItem.html" class="tsd-signature-type" data-tsd-kind="Interface">TestItem</a><span class="tsd-signature-symbol">[]</span>, exclude<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">readonly </span><a href="../interfaces/TestItem.html" class="tsd-signature-type" data-tsd-kind="Interface">TestItem</a><span class="tsd-signature-symbol">[]</span>, profile<span class="tsd-signature-symbol">?: </span><a href="../interfaces/TestRunProfile.html" class="tsd-signature-type" data-tsd-kind="Interface">TestRunProfile</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TestRunRequest.html" class="tsd-signature-type" data-tsd-kind="Class">TestRunRequest</a></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/f3e9d00/vscode.d.ts#L14065">vscode.d.ts:14065</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> include: <span class="tsd-signature-symbol">readonly </span><a href="../interfaces/TestItem.html" class="tsd-signature-type" data-tsd-kind="Interface">TestItem</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> exclude: <span class="tsd-signature-symbol">readonly </span><a href="../interfaces/TestItem.html" class="tsd-signature-type" data-tsd-kind="Interface">TestItem</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>An array of tests to exclude from the run.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> profile: <a href="../interfaces/TestRunProfile.html" class="tsd-signature-type" data-tsd-kind="Interface">TestRunProfile</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The run profile used for this request.</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="TestRunRequest.html" class="tsd-signature-type" data-tsd-kind="Class">TestRunRequest</a></h4>
|
|
</li>
|
|
</ul>
|
|
</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-class">
|
|
<a name="include" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> include</h3>
|
|
<div class="tsd-signature tsd-kind-icon">include<span class="tsd-signature-symbol">:</span> <a href="../interfaces/TestItem.html" class="tsd-signature-type" data-tsd-kind="Interface">TestItem</a><span class="tsd-signature-symbol">[]</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/f3e9d00/vscode.d.ts#L14042">vscode.d.ts:14042</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>A filter for specific tests to run. If given, the extension should run
|
|
all of the included tests and all their children, excluding any tests
|
|
that appear in <a href="TestRunRequest.html#exclude">TestRunRequest.exclude</a>. If this property is
|
|
undefined, then the extension should simply run all tests.</p>
|
|
</div>
|
|
<p>The process of running tests should resolve the children of any test
|
|
items who have not yet been resolved.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="exclude" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> exclude</h3>
|
|
<div class="tsd-signature tsd-kind-icon">exclude<span class="tsd-signature-symbol">:</span> <a href="../interfaces/TestItem.html" class="tsd-signature-type" data-tsd-kind="Interface">TestItem</a><span class="tsd-signature-symbol">[]</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/f3e9d00/vscode.d.ts#L14051">vscode.d.ts:14051</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>An array of tests the user has marked as excluded from the test included
|
|
in this run; exclusions should apply after inclusions.</p>
|
|
</div>
|
|
<p>May be omitted if no exclusions were requested. Test controllers should
|
|
not run excluded tests or any children of excluded tests.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
<a name="profile" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> profile</h3>
|
|
<div class="tsd-signature tsd-kind-icon">profile<span class="tsd-signature-symbol">:</span> <a href="../interfaces/TestRunProfile.html" class="tsd-signature-type" data-tsd-kind="Interface">TestRunProfile</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/f3e9d00/vscode.d.ts#L14058">vscode.d.ts:14058</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>The profile used for this request. This will always be defined
|
|
for requests issued from the editor UI, though extensions may
|
|
programmatically create requests not associated with any profile.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class=" ">
|
|
<a href="../modules.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-class">
|
|
<a href="TestRunRequest.html" class="tsd-kind-icon">Test<wbr>Run<wbr>Request</a>
|
|
<ul>
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
<a href="TestRunRequest.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="TestRunRequest.html#include" class="tsd-kind-icon">include</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="TestRunRequest.html#exclude" class="tsd-kind-icon">exclude</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
<a href="TestRunRequest.html#profile" class="tsd-kind-icon">profile</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> |