|
|
|
<!doctype html>
|
|
|
|
<html class="default no-js">
|
|
|
|
<head>
|
|
|
|
<meta charset="utf-8">
|
|
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
|
|
<title>TestMessage | 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="TestMessage.html">TestMessage</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<h1>Class TestMessage</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>Message associated with the test state. Can be linked to a specific
|
|
|
|
source range -- useful for assertion failures, for example.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</section>
|
|
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
|
|
<h3>Hierarchy</h3>
|
|
|
|
<ul class="tsd-hierarchy">
|
|
|
|
<li>
|
|
|
|
<span class="target">TestMessage</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>Methods</h3>
|
|
|
|
<ul class="tsd-index-list">
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="TestMessage.html#diff" class="tsd-kind-icon">diff</a></li>
|
|
|
|
</ul>
|
|
|
|
</section>
|
|
|
|
<section class="tsd-index-section ">
|
|
|
|
<h3>Constructors</h3>
|
|
|
|
<ul class="tsd-index-list">
|
|
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="TestMessage.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="TestMessage.html#message" class="tsd-kind-icon">message</a></li>
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="TestMessage.html#expectedOutput" class="tsd-kind-icon">expected<wbr>Output</a></li>
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="TestMessage.html#actualOutput" class="tsd-kind-icon">actual<wbr>Output</a></li>
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="TestMessage.html#location" class="tsd-kind-icon">location</a></li>
|
|
|
|
</ul>
|
|
|
|
</section>
|
|
|
|
</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-class tsd-is-static">
|
|
|
|
<a name="diff" class="tsd-anchor"></a>
|
|
|
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> diff</h3>
|
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
|
|
|
<li class="tsd-signature tsd-kind-icon">diff<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="MarkdownString.html" class="tsd-signature-type" data-tsd-kind="Class">MarkdownString</a>, expected<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, actual<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><a href="TestMessage.html" class="tsd-signature-type" data-tsd-kind="Class">TestMessage</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/2dd8438/vscode.d.ts#L14305">vscode.d.ts:14305</a></li>
|
|
|
|
</ul>
|
|
|
|
</aside>
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
<div class="lead">
|
|
|
|
<p>Creates a new TestMessage that will present as a diff in the editor.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
<li>
|
|
|
|
<h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="MarkdownString.html" class="tsd-signature-type" data-tsd-kind="Class">MarkdownString</a></h5>
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
<p>Message to display to the user.</p>
|
|
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<h5>expected: <span class="tsd-signature-type">string</span></h5>
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
<p>Expected output.</p>
|
|
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<h5>actual: <span class="tsd-signature-type">string</span></h5>
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
<p>Actual output.</p>
|
|
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<h4 class="tsd-returns-title">Returns <a href="TestMessage.html" class="tsd-signature-type" data-tsd-kind="Class">TestMessage</a></h4>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</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>Message<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="MarkdownString.html" class="tsd-signature-type" data-tsd-kind="Class">MarkdownString</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="TestMessage.html" class="tsd-signature-type" data-tsd-kind="Class">TestMessage</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/2dd8438/vscode.d.ts#L14311">vscode.d.ts:14311</a></li>
|
|
|
|
</ul>
|
|
|
|
</aside>
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
<div class="lead">
|
|
|
|
<p>Creates a new TestMessage instance.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
<li>
|
|
|
|
<h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="MarkdownString.html" class="tsd-signature-type" data-tsd-kind="Class">MarkdownString</a></h5>
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
<div class="lead">
|
|
|
|
<p>The message to show to the user.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<h4 class="tsd-returns-title">Returns <a href="TestMessage.html" class="tsd-signature-type" data-tsd-kind="Class">TestMessage</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="message" class="tsd-anchor"></a>
|
|
|
|
<h3>message</h3>
|
|
|
|
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="MarkdownString.html" class="tsd-signature-type" data-tsd-kind="Class">MarkdownString</a></div>
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
<ul>
|
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/2dd8438/vscode.d.ts#L14282">vscode.d.ts:14282</a></li>
|
|
|
|
</ul>
|
|
|
|
</aside>
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
<div class="lead">
|
|
|
|
<p>Human-readable message text to display.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</section>
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
|
<a name="expectedOutput" class="tsd-anchor"></a>
|
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> expected<wbr>Output</h3>
|
|
|
|
<div class="tsd-signature tsd-kind-icon">expected<wbr>Output<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/2dd8438/vscode.d.ts#L14287">vscode.d.ts:14287</a></li>
|
|
|
|
</ul>
|
|
|
|
</aside>
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
<div class="lead">
|
|
|
|
<p>Expected test output. If given with <a href="TestMessage.html#actualOutput">actualOutput</a>, a diff view will be shown.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</section>
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
|
<a name="actualOutput" class="tsd-anchor"></a>
|
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> actual<wbr>Output</h3>
|
|
|
|
<div class="tsd-signature tsd-kind-icon">actual<wbr>Output<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/2dd8438/vscode.d.ts#L14292">vscode.d.ts:14292</a></li>
|
|
|
|
</ul>
|
|
|
|
</aside>
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
<div class="lead">
|
|
|
|
<p>Actual test output. If given with <a href="TestMessage.html#expectedOutput">expectedOutput</a>, a diff view will be shown.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</section>
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
|
<a name="location" class="tsd-anchor"></a>
|
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> location</h3>
|
|
|
|
<div class="tsd-signature tsd-kind-icon">location<span class="tsd-signature-symbol">:</span> <a href="Location.html" class="tsd-signature-type" data-tsd-kind="Class">Location</a></div>
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
<ul>
|
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/2dd8438/vscode.d.ts#L14297">vscode.d.ts:14297</a></li>
|
|
|
|
</ul>
|
|
|
|
</aside>
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
<div class="lead">
|
|
|
|
<p>Associated file location.</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="TestMessage.html" class="tsd-kind-icon">Test<wbr>Message</a>
|
|
|
|
<ul>
|
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
|
|
|
<a href="TestMessage.html#diff" class="tsd-kind-icon">diff</a>
|
|
|
|
</li>
|
|
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
|
|
<a href="TestMessage.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
|
|
</li>
|
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
|
<a href="TestMessage.html#message" class="tsd-kind-icon">message</a>
|
|
|
|
</li>
|
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
|
<a href="TestMessage.html#expectedOutput" class="tsd-kind-icon">expected<wbr>Output</a>
|
|
|
|
</li>
|
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
|
<a href="TestMessage.html#actualOutput" class="tsd-kind-icon">actual<wbr>Output</a>
|
|
|
|
</li>
|
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
|
<a href="TestMessage.html#location" class="tsd-kind-icon">location</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>
|