Mintplex-Labs/nut.js
1
0
Fork 0
mirror of https://github.com/Mintplex-Labs/nut.js.git synced 2026-07-19 14:06:17 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #243 from nut-tree/feature/241/cancel_waitfor

Browse Source 
Closing #241
This commit is contained in:
Simon Hofmann
2021-06-25 11:41:11 +02:00
committed by GitHub
parent 4e8293b655 605d7d5940
commit dbbbc09cd6
52 changed files with 962 additions and 946 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/assets/js/search.json
+1 -1
View File
File diff suppressed because one or more lines are too long
docs/classes/assert.html
+7 -6
View File
@@ -102,7 +102,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/assert.class.ts#L5">assert.class.ts:5</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/assert.class.ts#L5">assert.class.ts:5</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -128,7 +128,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/assert.class.ts#L8">assert.class.ts:8</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/assert.class.ts#L8">assert.class.ts:8</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -157,7 +157,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/assert.class.ts#L25">assert.class.ts:25</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/assert.class.ts#L25">assert.class.ts:25</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -221,11 +221,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/classes/bresenham.html
+5 -4
View File
@@ -95,7 +95,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/util/bresenham.class.ts#L4">util/bresenham.class.ts:4</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/util/bresenham.class.ts#L4">util/bresenham.class.ts:4</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -150,11 +150,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/classes/clipboard.html
+7 -6
View File
@@ -109,7 +109,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/clipboard.class.ts#L6">clipboard.class.ts:6</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/clipboard.class.ts#L6">clipboard.class.ts:6</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -145,7 +145,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/clipboard.class.ts#L18">clipboard.class.ts:18</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/clipboard.class.ts#L18">clipboard.class.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -176,7 +176,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/clipboard.class.ts#L25">clipboard.class.ts:25</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/clipboard.class.ts#L25">clipboard.class.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -233,11 +233,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/classes/clipboardaction.html
-265
View File
@@ -1,265 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ClipboardAction | @nut-tree/nut-js</title>
<meta name="description" content="Documentation for @nut-tree/nut-js">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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">@nut-tree/nut-js</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>
</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="../globals.html">Globals</a>
</li>
<li>
<a href="clipboardaction.html">ClipboardAction</a>
</li>
</ul>
<h1>Class ClipboardAction</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">ClipboardAction</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/clipboardactionprovider.html" class="tsd-signature-type">ClipboardActionProvider</a></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="clipboardaction.html#constructor" class="tsd-kind-icon">constructor</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-class"><a href="clipboardaction.html#clear" class="tsd-kind-icon">clear</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="clipboardaction.html#copy" class="tsd-kind-icon">copy</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="clipboardaction.html#hastext" class="tsd-kind-icon">has<wbr>Text</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="clipboardaction.html#paste" class="tsd-kind-icon">paste</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>Clipboard<wbr>Action<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="clipboardaction.html" class="tsd-signature-type">ClipboardAction</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/clipboardy-clipboard-action.class.ts#L4">provider/native/clipboardy-clipboard-action.class.ts:4</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="clipboardaction.html" class="tsd-signature-type">ClipboardAction</a></h4>
</li>
</ul>
</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">
<a name="clear" class="tsd-anchor"></a>
<h3>clear</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">clear<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/clipboardactionprovider.html">ClipboardActionProvider</a>.<a href="../interfaces/clipboardactionprovider.html#clear">clear</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/clipboardy-clipboard-action.class.ts#L19">provider/native/clipboardy-clipboard-action.class.ts:19</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="copy" class="tsd-anchor"></a>
<h3>copy</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">copy<span class="tsd-signature-symbol">(</span>text<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/clipboardactionprovider.html">ClipboardActionProvider</a>.<a href="../interfaces/clipboardactionprovider.html#copy">copy</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/clipboardy-clipboard-action.class.ts#L23">provider/native/clipboardy-clipboard-action.class.ts:23</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>text: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="hastext" class="tsd-anchor"></a>
<h3>has<wbr>Text</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">has<wbr>Text<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/clipboardactionprovider.html">ClipboardActionProvider</a>.<a href="../interfaces/clipboardactionprovider.html#hastext">hasText</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/clipboardy-clipboard-action.class.ts#L8">provider/native/clipboardy-clipboard-action.class.ts:8</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="paste" class="tsd-anchor"></a>
<h3>paste</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">paste<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/clipboardactionprovider.html">ClipboardActionProvider</a>.<a href="../interfaces/clipboardactionprovider.html#paste">paste</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/clipboardy-clipboard-action.class.ts#L34">provider/native/clipboardy-clipboard-action.class.ts:34</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></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="clipboardaction.html" class="tsd-kind-icon">Clipboard<wbr>Action</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="clipboardaction.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="clipboardaction.html#clear" class="tsd-kind-icon">clear</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="clipboardaction.html#copy" class="tsd-kind-icon">copy</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="clipboardaction.html#hastext" class="tsd-kind-icon">has<wbr>Text</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="clipboardaction.html#paste" class="tsd-kind-icon">paste</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<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-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>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>
docs/classes/image.html
+11 -10
View File
@@ -118,7 +118,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/image.class.ts#L4">image.class.ts:4</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/image.class.ts#L4">image.class.ts:4</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -190,7 +190,7 @@
<div class="tsd-signature tsd-kind-icon">channels<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/image.class.ts#L17">image.class.ts:17</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/image.class.ts#L17">image.class.ts:17</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -205,7 +205,7 @@
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/image.class.ts#L16">image.class.ts:16</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/image.class.ts#L16">image.class.ts:16</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -220,7 +220,7 @@
<div class="tsd-signature tsd-kind-icon">height<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/image.class.ts#L15">image.class.ts:15</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/image.class.ts#L15">image.class.ts:15</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -235,7 +235,7 @@
<div class="tsd-signature tsd-kind-icon">pixel<wbr>Density<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>scaleX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>scaleY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/image.class.ts#L18">image.class.ts:18</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/image.class.ts#L18">image.class.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -261,7 +261,7 @@
<div class="tsd-signature tsd-kind-icon">width<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/image.class.ts#L14">image.class.ts:14</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/image.class.ts#L14">image.class.ts:14</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -283,7 +283,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/image.class.ts#L31">image.class.ts:31</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/image.class.ts#L31">image.class.ts:31</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -352,11 +352,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/classes/imagereader.html
+5 -4
View File
@@ -102,7 +102,7 @@
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/datasource.html">DataSource</a>.<a href="../interfaces/datasource.html#load">load</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/opencv/image-reader.class.ts#L6">provider/opencv/image-reader.class.ts:6</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/opencv/image-reader.class.ts#L6">provider/opencv/image-reader.class.ts:6</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -154,11 +154,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/classes/imagewriter.html
+5 -4
View File
@@ -101,7 +101,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/opencv/image-writer.class.ts#L7">provider/opencv/image-writer.class.ts:7</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/opencv/image-writer.class.ts#L7">provider/opencv/image-writer.class.ts:7</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -156,11 +156,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/classes/keyboard.html
+11 -10
View File
@@ -116,7 +116,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/keyboard.class.ts#L24">keyboard.class.ts:24</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/keyboard.class.ts#L24">keyboard.class.ts:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -152,7 +152,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/keyboard.class.ts#L73">keyboard.class.ts:73</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/keyboard.class.ts#L73">keyboard.class.ts:73</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -190,7 +190,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/keyboard.class.ts#L95">keyboard.class.ts:95</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/keyboard.class.ts#L95">keyboard.class.ts:95</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -228,7 +228,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/keyboard.class.ts#L44">keyboard.class.ts:44</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/keyboard.class.ts#L44">keyboard.class.ts:44</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -238,7 +238,7 @@
<dl class="tsd-comment-tags">
<dt>example</dt>
<dd><pre><code class="language-typescript"> <span class="hljs-keyword">await</span> keyboard.type(Key.A, Key.S, Key.D, Key.F);
<span class="hljs-keyword">await</span> keyboard.type(<span class="hljs-string">"Hello, world!"</span>);</code></pre>
<span class="hljs-keyword">await</span> keyboard.type(<span class="hljs-string">&quot;Hello, world!&quot;</span>);</code></pre>
</dd>
</dl>
</div>
@@ -264,7 +264,7 @@
<div class="tsd-signature tsd-kind-icon">config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/keyboard.class.ts#L19">keyboard.class.ts:19</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/keyboard.class.ts#L19">keyboard.class.ts:19</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -278,7 +278,7 @@
<div class="tsd-signature tsd-kind-icon">auto<wbr>Delay<wbr>Ms<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 300</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/keyboard.class.ts#L23">keyboard.class.ts:23</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/keyboard.class.ts#L23">keyboard.class.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -339,11 +339,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/classes/keyboardaction.html
+12 -11
View File
@@ -118,7 +118,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-keyboard-action.class.ts#L145">provider/native/libnut-keyboard-action.class.ts:145</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-keyboard-action.class.ts#L145">provider/native/libnut-keyboard-action.class.ts:145</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="keyboardaction.html" class="tsd-signature-type">KeyboardAction</a></h4>
@@ -134,7 +134,7 @@
<div class="tsd-signature tsd-kind-icon">Key<wbr>Lookup<wbr>Map<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><a href="../enums/key.html" class="tsd-signature-type">Key</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = new Map&lt;Key, string | null&gt;([[Key.A, &quot;a&quot;],[Key.B, &quot;b&quot;],[Key.C, &quot;c&quot;],[Key.D, &quot;d&quot;],[Key.E, &quot;e&quot;],[Key.F, &quot;f&quot;],[Key.G, &quot;g&quot;],[Key.H, &quot;h&quot;],[Key.I, &quot;i&quot;],[Key.J, &quot;j&quot;],[Key.K, &quot;k&quot;],[Key.L, &quot;l&quot;],[Key.M, &quot;m&quot;],[Key.N, &quot;n&quot;],[Key.O, &quot;o&quot;],[Key.P, &quot;p&quot;],[Key.Q, &quot;q&quot;],[Key.R, &quot;r&quot;],[Key.S, &quot;s&quot;],[Key.T, &quot;t&quot;],[Key.U, &quot;u&quot;],[Key.V, &quot;v&quot;],[Key.W, &quot;w&quot;],[Key.X, &quot;x&quot;],[Key.Y, &quot;y&quot;],[Key.Z, &quot;z&quot;],[Key.F1, &quot;f1&quot;],[Key.F2, &quot;f2&quot;],[Key.F3, &quot;f3&quot;],[Key.F4, &quot;f4&quot;],[Key.F5, &quot;f5&quot;],[Key.F6, &quot;f6&quot;],[Key.F7, &quot;f7&quot;],[Key.F8, &quot;f8&quot;],[Key.F9, &quot;f9&quot;],[Key.F10, &quot;f10&quot;],[Key.F11, &quot;f11&quot;],[Key.F12, &quot;f12&quot;],[Key.Num0, &quot;0&quot;],[Key.Num1, &quot;1&quot;],[Key.Num2, &quot;2&quot;],[Key.Num3, &quot;3&quot;],[Key.Num4, &quot;4&quot;],[Key.Num5, &quot;5&quot;],[Key.Num6, &quot;6&quot;],[Key.Num7, &quot;7&quot;],[Key.Num8, &quot;8&quot;],[Key.Num9, &quot;9&quot;],[Key.NumPad0, &quot;numpad_0&quot;],[Key.NumPad1, &quot;numpad_1&quot;],[Key.NumPad2, &quot;numpad_2&quot;],[Key.NumPad3, &quot;numpad_3&quot;],[Key.NumPad4, &quot;numpad_4&quot;],[Key.NumPad5, &quot;numpad_5&quot;],[Key.NumPad6, &quot;numpad_6&quot;],[Key.NumPad7, &quot;numpad_7&quot;],[Key.NumPad8, &quot;numpad_8&quot;],[Key.NumPad9, &quot;numpad_9&quot;],[Key.Space, &quot;space&quot;],[Key.Escape, &quot;escape&quot;],[Key.Tab, &quot;tab&quot;],[Key.LeftAlt, &quot;alt&quot;],[Key.LeftControl, &quot;control&quot;],[Key.RightAlt, &quot;alt&quot;],[Key.RightControl, &quot;control&quot;],[Key.LeftShift, &quot;shift&quot;],[Key.LeftSuper, &quot;command&quot;],[Key.RightShift, &quot;space&quot;],[Key.RightSuper, &quot;command&quot;],[Key.Grave, &quot;~&quot;],[Key.Minus, &quot;-&quot;],[Key.Equal, &quot;&#x3D;&quot;],[Key.Backspace, &quot;backspace&quot;],[Key.LeftBracket, &quot;[&quot;],[Key.RightBracket, &quot;]&quot;],[Key.Backslash, &quot;\\&quot;],[Key.Semicolon, &quot;;&quot;],[Key.Quote, &quot;&#x27;&quot;],[Key.Return, &quot;enter&quot;],[Key.Comma, &quot;,&quot;],[Key.Period, &quot;.&quot;],[Key.Slash, &quot;/&quot;],[Key.Left, &quot;left&quot;],[Key.Up, &quot;up&quot;],[Key.Right, &quot;right&quot;],[Key.Down, &quot;down&quot;],[Key.Print, &quot;printscreen&quot;],[Key.Pause, null],[Key.Insert, &quot;insert&quot;],[Key.Delete, null],[Key.Home, &quot;home&quot;],[Key.End, &quot;end&quot;],[Key.PageUp, &quot;pageup&quot;],[Key.PageDown, &quot;pagedown&quot;],[Key.Add, null],[Key.Subtract, null],[Key.Multiply, null],[Key.Divide, null],[Key.Decimal, null],[Key.Enter, &quot;enter&quot;],[Key.CapsLock, null],[Key.ScrollLock, null],[Key.NumLock, null],])</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-keyboard-action.class.ts#L7">provider/native/libnut-keyboard-action.class.ts:7</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-keyboard-action.class.ts#L7">provider/native/libnut-keyboard-action.class.ts:7</a></li>
</ul>
</aside>
</section>
@@ -152,7 +152,7 @@
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/keyboardactionprovider.html">KeyboardActionProvider</a>.<a href="../interfaces/keyboardactionprovider.html#click">click</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-keyboard-action.class.ts#L161">provider/native/libnut-keyboard-action.class.ts:161</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-keyboard-action.class.ts#L161">provider/native/libnut-keyboard-action.class.ts:161</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -176,7 +176,7 @@
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/keyboardactionprovider.html">KeyboardActionProvider</a>.<a href="../interfaces/keyboardactionprovider.html#presskey">pressKey</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-keyboard-action.class.ts#L178">provider/native/libnut-keyboard-action.class.ts:178</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-keyboard-action.class.ts#L178">provider/native/libnut-keyboard-action.class.ts:178</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -200,7 +200,7 @@
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/keyboardactionprovider.html">KeyboardActionProvider</a>.<a href="../interfaces/keyboardactionprovider.html#releasekey">releaseKey</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-keyboard-action.class.ts#L191">provider/native/libnut-keyboard-action.class.ts:191</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-keyboard-action.class.ts#L191">provider/native/libnut-keyboard-action.class.ts:191</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -224,7 +224,7 @@
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/keyboardactionprovider.html">KeyboardActionProvider</a>.<a href="../interfaces/keyboardactionprovider.html#setkeyboarddelay">setKeyboardDelay</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-keyboard-action.class.ts#L204">provider/native/libnut-keyboard-action.class.ts:204</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-keyboard-action.class.ts#L204">provider/native/libnut-keyboard-action.class.ts:204</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -248,7 +248,7 @@
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/keyboardactionprovider.html">KeyboardActionProvider</a>.<a href="../interfaces/keyboardactionprovider.html#type">type</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-keyboard-action.class.ts#L150">provider/native/libnut-keyboard-action.class.ts:150</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-keyboard-action.class.ts#L150">provider/native/libnut-keyboard-action.class.ts:150</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -271,7 +271,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-keyboard-action.class.ts#L122">provider/native/libnut-keyboard-action.class.ts:122</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-keyboard-action.class.ts#L122">provider/native/libnut-keyboard-action.class.ts:122</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -344,11 +344,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/classes/linehelper.html
+6 -5
View File
@@ -101,7 +101,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/util/linehelper.class.ts#L5">util/linehelper.class.ts:5</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/util/linehelper.class.ts#L5">util/linehelper.class.ts:5</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="linehelper.html" class="tsd-signature-type">LineHelper</a></h4>
@@ -121,7 +121,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/util/linehelper.class.ts#L8">util/linehelper.class.ts:8</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/util/linehelper.class.ts#L8">util/linehelper.class.ts:8</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -179,11 +179,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/classes/matchrequest.html
+10 -9
View File
@@ -105,7 +105,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/match-request.class.ts#L4">match-request.class.ts:4</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/match-request.class.ts#L4">match-request.class.ts:4</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -139,7 +139,7 @@
<div class="tsd-signature tsd-kind-icon">confidence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/match-request.class.ts#L9">match-request.class.ts:9</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/match-request.class.ts#L9">match-request.class.ts:9</a></li>
</ul>
</aside>
</section>
@@ -149,7 +149,7 @@
<div class="tsd-signature tsd-kind-icon">haystack<span class="tsd-signature-symbol">:</span> <a href="image.html" class="tsd-signature-type">Image</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/match-request.class.ts#L6">match-request.class.ts:6</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/match-request.class.ts#L6">match-request.class.ts:6</a></li>
</ul>
</aside>
</section>
@@ -159,7 +159,7 @@
<div class="tsd-signature tsd-kind-icon">path<wbr>ToNeedle<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/nut-tree/nut.js/blob/e2352ac/lib/match-request.class.ts#L7">match-request.class.ts:7</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/match-request.class.ts#L7">match-request.class.ts:7</a></li>
</ul>
</aside>
</section>
@@ -169,7 +169,7 @@
<div class="tsd-signature tsd-kind-icon">search<wbr>Multiple<wbr>Scales<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/match-request.class.ts#L10">match-request.class.ts:10</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/match-request.class.ts#L10">match-request.class.ts:10</a></li>
</ul>
</aside>
</section>
@@ -179,7 +179,7 @@
<div class="tsd-signature tsd-kind-icon">search<wbr>Region<span class="tsd-signature-symbol">:</span> <a href="region.html" class="tsd-signature-type">Region</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/match-request.class.ts#L8">match-request.class.ts:8</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/match-request.class.ts#L8">match-request.class.ts:8</a></li>
</ul>
</aside>
</section>
@@ -237,11 +237,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/classes/matchresult.html
+25 -7
View File
@@ -89,6 +89,7 @@
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="matchresult.html#confidence" class="tsd-kind-icon">confidence</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="matchresult.html#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="matchresult.html#location" class="tsd-kind-icon">location</a></li>
</ul>
</section>
@@ -101,13 +102,13 @@
<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>Match<wbr>Result<span class="tsd-signature-symbol">(</span>confidence<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, location<span class="tsd-signature-symbol">: </span><a href="region.html" class="tsd-signature-type">Region</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="matchresult.html" class="tsd-signature-type">MatchResult</a></li>
<li class="tsd-signature tsd-kind-icon">new <wbr>Match<wbr>Result<span class="tsd-signature-symbol">(</span>confidence<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, location<span class="tsd-signature-symbol">: </span><a href="region.html" class="tsd-signature-type">Region</a>, error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="matchresult.html" class="tsd-signature-type">MatchResult</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/match-result.class.ts#L3">match-result.class.ts:3</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/match-result.class.ts#L3">match-result.class.ts:3</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -118,6 +119,9 @@
<li>
<h5>location: <a href="region.html" class="tsd-signature-type">Region</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> error: <span class="tsd-signature-type">Error</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="matchresult.html" class="tsd-signature-type">MatchResult</a></h4>
</li>
@@ -132,7 +136,17 @@
<div class="tsd-signature tsd-kind-icon">confidence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/match-result.class.ts#L5">match-result.class.ts:5</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/match-result.class.ts#L5">match-result.class.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> error</h3>
<div class="tsd-signature tsd-kind-icon">error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Error</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/match-result.class.ts#L7">match-result.class.ts:7</a></li>
</ul>
</aside>
</section>
@@ -142,7 +156,7 @@
<div class="tsd-signature tsd-kind-icon">location<span class="tsd-signature-symbol">:</span> <a href="region.html" class="tsd-signature-type">Region</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/match-result.class.ts#L6">match-result.class.ts:6</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/match-result.class.ts#L6">match-result.class.ts:6</a></li>
</ul>
</aside>
</section>
@@ -169,6 +183,9 @@
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="matchresult.html#confidence" class="tsd-kind-icon">confidence</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="matchresult.html#error" class="tsd-kind-icon">error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="matchresult.html#location" class="tsd-kind-icon">location</a>
</li>
@@ -191,11 +208,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/classes/mouse.html
+20 -19
View File
@@ -125,7 +125,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/mouse.class.ts#L24">mouse.class.ts:24</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/mouse.class.ts#L24">mouse.class.ts:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -161,7 +161,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/mouse.class.ts#L178">mouse.class.ts:178</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/mouse.class.ts#L178">mouse.class.ts:178</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -193,7 +193,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/mouse.class.ts#L52">mouse.class.ts:52</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/mouse.class.ts#L52">mouse.class.ts:52</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -215,7 +215,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/mouse.class.ts#L82">mouse.class.ts:82</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/mouse.class.ts#L82">mouse.class.ts:82</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -237,7 +237,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/mouse.class.ts#L61">mouse.class.ts:61</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/mouse.class.ts#L61">mouse.class.ts:61</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -274,7 +274,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/mouse.class.ts#L196">mouse.class.ts:196</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/mouse.class.ts#L196">mouse.class.ts:196</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -305,7 +305,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/mouse.class.ts#L211">mouse.class.ts:211</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/mouse.class.ts#L211">mouse.class.ts:211</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -336,7 +336,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/mouse.class.ts#L93">mouse.class.ts:93</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/mouse.class.ts#L93">mouse.class.ts:93</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -358,7 +358,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/mouse.class.ts#L110">mouse.class.ts:110</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/mouse.class.ts#L110">mouse.class.ts:110</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -390,7 +390,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/mouse.class.ts#L144">mouse.class.ts:144</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/mouse.class.ts#L144">mouse.class.ts:144</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -422,7 +422,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/mouse.class.ts#L161">mouse.class.ts:161</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/mouse.class.ts#L161">mouse.class.ts:161</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -454,7 +454,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/mouse.class.ts#L127">mouse.class.ts:127</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/mouse.class.ts#L127">mouse.class.ts:127</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -486,7 +486,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/mouse.class.ts#L38">mouse.class.ts:38</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/mouse.class.ts#L38">mouse.class.ts:38</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -516,7 +516,7 @@
<div class="tsd-signature tsd-kind-icon">config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/mouse.class.ts#L14">mouse.class.ts:14</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/mouse.class.ts#L14">mouse.class.ts:14</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -530,7 +530,7 @@
<div class="tsd-signature tsd-kind-icon">auto<wbr>Delay<wbr>Ms<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 100</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/mouse.class.ts#L18">mouse.class.ts:18</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/mouse.class.ts#L18">mouse.class.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -545,7 +545,7 @@
<div class="tsd-signature tsd-kind-icon">mouse<wbr>Speed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1000</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/mouse.class.ts#L23">mouse.class.ts:23</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/mouse.class.ts#L23">mouse.class.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -633,11 +633,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/classes/mouseaction.html
+18 -17
View File
@@ -119,7 +119,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-mouse-action.class.ts#L13">provider/native/libnut-mouse-action.class.ts:13</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-mouse-action.class.ts#L13">provider/native/libnut-mouse-action.class.ts:13</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="mouseaction.html" class="tsd-signature-type">MouseAction</a></h4>
@@ -140,7 +140,7 @@
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/mouseactionprovider.html">MouseActionProvider</a>.<a href="../interfaces/mouseactionprovider.html#currentmouseposition">currentMousePosition</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-mouse-action.class.ts#L33">provider/native/libnut-mouse-action.class.ts:33</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-mouse-action.class.ts#L33">provider/native/libnut-mouse-action.class.ts:33</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="point.html" class="tsd-signature-type">Point</a><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -158,7 +158,7 @@
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/mouseactionprovider.html">MouseActionProvider</a>.<a href="../interfaces/mouseactionprovider.html#leftclick">leftClick</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-mouse-action.class.ts#L44">provider/native/libnut-mouse-action.class.ts:44</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-mouse-action.class.ts#L44">provider/native/libnut-mouse-action.class.ts:44</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -176,7 +176,7 @@
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/mouseactionprovider.html">MouseActionProvider</a>.<a href="../interfaces/mouseactionprovider.html#middleclick">middleClick</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-mouse-action.class.ts#L66">provider/native/libnut-mouse-action.class.ts:66</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-mouse-action.class.ts#L66">provider/native/libnut-mouse-action.class.ts:66</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -194,7 +194,7 @@
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/mouseactionprovider.html">MouseActionProvider</a>.<a href="../interfaces/mouseactionprovider.html#pressbutton">pressButton</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-mouse-action.class.ts#L77">provider/native/libnut-mouse-action.class.ts:77</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-mouse-action.class.ts#L77">provider/native/libnut-mouse-action.class.ts:77</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -218,7 +218,7 @@
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/mouseactionprovider.html">MouseActionProvider</a>.<a href="../interfaces/mouseactionprovider.html#releasebutton">releaseButton</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-mouse-action.class.ts#L88">provider/native/libnut-mouse-action.class.ts:88</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-mouse-action.class.ts#L88">provider/native/libnut-mouse-action.class.ts:88</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -242,7 +242,7 @@
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/mouseactionprovider.html">MouseActionProvider</a>.<a href="../interfaces/mouseactionprovider.html#rightclick">rightClick</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-mouse-action.class.ts#L55">provider/native/libnut-mouse-action.class.ts:55</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-mouse-action.class.ts#L55">provider/native/libnut-mouse-action.class.ts:55</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -260,7 +260,7 @@
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/mouseactionprovider.html">MouseActionProvider</a>.<a href="../interfaces/mouseactionprovider.html#scrolldown">scrollDown</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-mouse-action.class.ts#L110">provider/native/libnut-mouse-action.class.ts:110</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-mouse-action.class.ts#L110">provider/native/libnut-mouse-action.class.ts:110</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -284,7 +284,7 @@
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/mouseactionprovider.html">MouseActionProvider</a>.<a href="../interfaces/mouseactionprovider.html#scrollleft">scrollLeft</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-mouse-action.class.ts#L121">provider/native/libnut-mouse-action.class.ts:121</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-mouse-action.class.ts#L121">provider/native/libnut-mouse-action.class.ts:121</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -308,7 +308,7 @@
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/mouseactionprovider.html">MouseActionProvider</a>.<a href="../interfaces/mouseactionprovider.html#scrollright">scrollRight</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-mouse-action.class.ts#L132">provider/native/libnut-mouse-action.class.ts:132</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-mouse-action.class.ts#L132">provider/native/libnut-mouse-action.class.ts:132</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -332,7 +332,7 @@
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/mouseactionprovider.html">MouseActionProvider</a>.<a href="../interfaces/mouseactionprovider.html#scrollup">scrollUp</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-mouse-action.class.ts#L99">provider/native/libnut-mouse-action.class.ts:99</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-mouse-action.class.ts#L99">provider/native/libnut-mouse-action.class.ts:99</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -356,7 +356,7 @@
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/mouseactionprovider.html">MouseActionProvider</a>.<a href="../interfaces/mouseactionprovider.html#setmousedelay">setMouseDelay</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-mouse-action.class.ts#L18">provider/native/libnut-mouse-action.class.ts:18</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-mouse-action.class.ts#L18">provider/native/libnut-mouse-action.class.ts:18</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -380,7 +380,7 @@
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/mouseactionprovider.html">MouseActionProvider</a>.<a href="../interfaces/mouseactionprovider.html#setmouseposition">setMousePosition</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-mouse-action.class.ts#L22">provider/native/libnut-mouse-action.class.ts:22</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-mouse-action.class.ts#L22">provider/native/libnut-mouse-action.class.ts:22</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -403,7 +403,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-mouse-action.class.ts#L7">provider/native/libnut-mouse-action.class.ts:7</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-mouse-action.class.ts#L7">provider/native/libnut-mouse-action.class.ts:7</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -494,11 +494,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/classes/nativeadapter.html
+29 -28
View File
@@ -133,7 +133,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/native.adapter.class.ts#L21">adapter/native.adapter.class.ts:21</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/native.adapter.class.ts#L21">adapter/native.adapter.class.ts:21</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -147,7 +147,7 @@
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> clipboard: <a href="../interfaces/clipboardactionprovider.html" class="tsd-signature-type">ClipboardActionProvider</a><span class="tsd-signature-symbol"> = new ClipboardAction()</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p><a href="../interfaces/clipboardactionprovider.html">ClipboardActionProvider</a> instance used to interact with a systems clipboard (Default: <a href="clipboardaction.html">ClipboardAction</a>)</p>
<p><a href="../interfaces/clipboardactionprovider.html">ClipboardActionProvider</a> instance used to interact with a systems clipboard (Default: {@link ClipboardAction})</p>
</div>
</div>
</li>
@@ -193,7 +193,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/native.adapter.class.ts#L125">adapter/native.adapter.class.ts:125</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/native.adapter.class.ts#L125">adapter/native.adapter.class.ts:125</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -224,7 +224,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/native.adapter.class.ts#L188">adapter/native.adapter.class.ts:188</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/native.adapter.class.ts#L188">adapter/native.adapter.class.ts:188</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -255,7 +255,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/native.adapter.class.ts#L68">adapter/native.adapter.class.ts:68</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/native.adapter.class.ts#L68">adapter/native.adapter.class.ts:68</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -278,7 +278,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/native.adapter.class.ts#L210">adapter/native.adapter.class.ts:210</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/native.adapter.class.ts#L210">adapter/native.adapter.class.ts:210</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -301,7 +301,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/native.adapter.class.ts#L228">adapter/native.adapter.class.ts:228</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/native.adapter.class.ts#L228">adapter/native.adapter.class.ts:228</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -330,7 +330,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/native.adapter.class.ts#L219">adapter/native.adapter.class.ts:219</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/native.adapter.class.ts#L219">adapter/native.adapter.class.ts:219</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -359,7 +359,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/native.adapter.class.ts#L201">adapter/native.adapter.class.ts:201</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/native.adapter.class.ts#L201">adapter/native.adapter.class.ts:201</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -376,7 +376,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/native.adapter.class.ts#L75">adapter/native.adapter.class.ts:75</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/native.adapter.class.ts#L75">adapter/native.adapter.class.ts:75</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -398,7 +398,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/native.adapter.class.ts#L89">adapter/native.adapter.class.ts:89</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/native.adapter.class.ts#L89">adapter/native.adapter.class.ts:89</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -420,7 +420,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/native.adapter.class.ts#L197">adapter/native.adapter.class.ts:197</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/native.adapter.class.ts#L197">adapter/native.adapter.class.ts:197</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -443,7 +443,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/native.adapter.class.ts#L98">adapter/native.adapter.class.ts:98</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/native.adapter.class.ts#L98">adapter/native.adapter.class.ts:98</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -474,7 +474,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/native.adapter.class.ts#L134">adapter/native.adapter.class.ts:134</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/native.adapter.class.ts#L134">adapter/native.adapter.class.ts:134</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -505,7 +505,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/native.adapter.class.ts#L107">adapter/native.adapter.class.ts:107</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/native.adapter.class.ts#L107">adapter/native.adapter.class.ts:107</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -536,7 +536,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/native.adapter.class.ts#L143">adapter/native.adapter.class.ts:143</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/native.adapter.class.ts#L143">adapter/native.adapter.class.ts:143</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -567,7 +567,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/native.adapter.class.ts#L82">adapter/native.adapter.class.ts:82</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/native.adapter.class.ts#L82">adapter/native.adapter.class.ts:82</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -589,7 +589,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/native.adapter.class.ts#L161">adapter/native.adapter.class.ts:161</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/native.adapter.class.ts#L161">adapter/native.adapter.class.ts:161</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -620,7 +620,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/native.adapter.class.ts#L170">adapter/native.adapter.class.ts:170</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/native.adapter.class.ts#L170">adapter/native.adapter.class.ts:170</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -651,7 +651,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/native.adapter.class.ts#L179">adapter/native.adapter.class.ts:179</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/native.adapter.class.ts#L179">adapter/native.adapter.class.ts:179</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -682,7 +682,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/native.adapter.class.ts#L152">adapter/native.adapter.class.ts:152</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/native.adapter.class.ts#L152">adapter/native.adapter.class.ts:152</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -713,7 +713,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/native.adapter.class.ts#L50">adapter/native.adapter.class.ts:50</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/native.adapter.class.ts#L50">adapter/native.adapter.class.ts:50</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -744,7 +744,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/native.adapter.class.ts#L41">adapter/native.adapter.class.ts:41</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/native.adapter.class.ts#L41">adapter/native.adapter.class.ts:41</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -775,7 +775,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/native.adapter.class.ts#L59">adapter/native.adapter.class.ts:59</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/native.adapter.class.ts#L59">adapter/native.adapter.class.ts:59</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -806,7 +806,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/native.adapter.class.ts#L116">adapter/native.adapter.class.ts:116</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/native.adapter.class.ts#L116">adapter/native.adapter.class.ts:116</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -935,11 +935,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/classes/optionalsearchparameters.html
+62 -7
View File
@@ -90,7 +90,9 @@
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="optionalsearchparameters.html#abort" class="tsd-kind-icon">abort</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="optionalsearchparameters.html#confidence" class="tsd-kind-icon">confidence</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="optionalsearchparameters.html#searchmultiplescales" class="tsd-kind-icon">search<wbr>Multiple<wbr>Scales</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="optionalsearchparameters.html#searchregion" class="tsd-kind-icon">search<wbr>Region</a></li>
</ul>
</section>
@@ -103,13 +105,13 @@
<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>Optional<wbr>Search<wbr>Parameters<span class="tsd-signature-symbol">(</span>searchRegion<span class="tsd-signature-symbol">?: </span><a href="region.html" class="tsd-signature-type">Region</a>, confidence<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="optionalsearchparameters.html" class="tsd-signature-type">OptionalSearchParameters</a></li>
<li class="tsd-signature tsd-kind-icon">new <wbr>Optional<wbr>Search<wbr>Parameters<span class="tsd-signature-symbol">(</span>searchRegion<span class="tsd-signature-symbol">?: </span><a href="region.html" class="tsd-signature-type">Region</a>, confidence<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, searchMultipleScales<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span>, abort<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="optionalsearchparameters.html" class="tsd-signature-type">OptionalSearchParameters</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/optionalsearchparameters.class.ts#L6">optionalsearchparameters.class.ts:6</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/optionalsearchparameters.class.ts#L7">optionalsearchparameters.class.ts:7</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -135,6 +137,22 @@
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> searchMultipleScales: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Optional flag to indicate if the search should be conducted at different scales</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> abort: <span class="tsd-signature-type">AbortSignal</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An {@link AbortSignal} to cancel an ongoing call to <code>waitFor</code></p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="optionalsearchparameters.html" class="tsd-signature-type">OptionalSearchParameters</a></h4>
</li>
@@ -143,13 +161,28 @@
</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="abort" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> abort</h3>
<div class="tsd-signature tsd-kind-icon">abort<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AbortSignal</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/optionalsearchparameters.class.ts#L15">optionalsearchparameters.class.ts:15</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An {@link AbortSignal} to cancel an ongoing call to <code>waitFor</code></p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="confidence" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> confidence</h3>
<div class="tsd-signature tsd-kind-icon">confidence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/optionalsearchparameters.class.ts#L12">optionalsearchparameters.class.ts:12</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/optionalsearchparameters.class.ts#L15">optionalsearchparameters.class.ts:15</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -158,13 +191,28 @@
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="searchmultiplescales" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> search<wbr>Multiple<wbr>Scales</h3>
<div class="tsd-signature tsd-kind-icon">search<wbr>Multiple<wbr>Scales<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/optionalsearchparameters.class.ts#L15">optionalsearchparameters.class.ts:15</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Optional flag to indicate if the search should be conducted at different scales</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="searchregion" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> search<wbr>Region</h3>
<div class="tsd-signature tsd-kind-icon">search<wbr>Region<span class="tsd-signature-symbol">:</span> <a href="region.html" class="tsd-signature-type">Region</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/optionalsearchparameters.class.ts#L12">optionalsearchparameters.class.ts:12</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/optionalsearchparameters.class.ts#L15">optionalsearchparameters.class.ts:15</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -193,9 +241,15 @@
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="optionalsearchparameters.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="optionalsearchparameters.html#abort" class="tsd-kind-icon">abort</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="optionalsearchparameters.html#confidence" class="tsd-kind-icon">confidence</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="optionalsearchparameters.html#searchmultiplescales" class="tsd-kind-icon">search<wbr>Multiple<wbr>Scales</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="optionalsearchparameters.html#searchregion" class="tsd-kind-icon">search<wbr>Region</a>
</li>
@@ -218,11 +272,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/classes/point.html
+8 -7
View File
@@ -108,7 +108,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/point.class.ts#L1">point.class.ts:1</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/point.class.ts#L1">point.class.ts:1</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -133,7 +133,7 @@
<div class="tsd-signature tsd-kind-icon">x<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/point.class.ts#L2">point.class.ts:2</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/point.class.ts#L2">point.class.ts:2</a></li>
</ul>
</aside>
</section>
@@ -143,7 +143,7 @@
<div class="tsd-signature tsd-kind-icon">y<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/point.class.ts#L2">point.class.ts:2</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/point.class.ts#L2">point.class.ts:2</a></li>
</ul>
</aside>
</section>
@@ -160,7 +160,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/point.class.ts#L4">point.class.ts:4</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/point.class.ts#L4">point.class.ts:4</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
@@ -215,11 +215,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/classes/region.html
+12 -11
View File
@@ -112,7 +112,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/region.class.ts#L18">region.class.ts:18</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/region.class.ts#L18">region.class.ts:18</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -143,7 +143,7 @@
<div class="tsd-signature tsd-kind-icon">height<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/region.class.ts#L24">region.class.ts:24</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/region.class.ts#L24">region.class.ts:24</a></li>
</ul>
</aside>
</section>
@@ -153,7 +153,7 @@
<div class="tsd-signature tsd-kind-icon">left<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/region.class.ts#L21">region.class.ts:21</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/region.class.ts#L21">region.class.ts:21</a></li>
</ul>
</aside>
</section>
@@ -163,7 +163,7 @@
<div class="tsd-signature tsd-kind-icon">top<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/region.class.ts#L22">region.class.ts:22</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/region.class.ts#L22">region.class.ts:22</a></li>
</ul>
</aside>
</section>
@@ -173,7 +173,7 @@
<div class="tsd-signature tsd-kind-icon">width<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/region.class.ts#L23">region.class.ts:23</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/region.class.ts#L23">region.class.ts:23</a></li>
</ul>
</aside>
</section>
@@ -190,7 +190,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/region.class.ts#L27">region.class.ts:27</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/region.class.ts#L27">region.class.ts:27</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
@@ -207,7 +207,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/region.class.ts#L31">region.class.ts:31</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/region.class.ts#L31">region.class.ts:31</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
@@ -224,7 +224,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/region.class.ts#L2">region.class.ts:2</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/region.class.ts#L2">region.class.ts:2</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -303,11 +303,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/classes/scaledmatchresult.html
+27 -8
View File
@@ -89,6 +89,7 @@
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite"><a href="scaledmatchresult.html#confidence" class="tsd-kind-icon">confidence</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite"><a href="scaledmatchresult.html#error" class="tsd-kind-icon">error</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite"><a href="scaledmatchresult.html#location" class="tsd-kind-icon">location</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="scaledmatchresult.html#scale" class="tsd-kind-icon">scale</a></li>
</ul>
@@ -102,14 +103,14 @@
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Scaled<wbr>Match<wbr>Result<span class="tsd-signature-symbol">(</span>confidence<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, scale<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, location<span class="tsd-signature-symbol">: </span><a href="region.html" class="tsd-signature-type">Region</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="scaledmatchresult.html" class="tsd-signature-type">ScaledMatchResult</a></li>
<li class="tsd-signature tsd-kind-icon">new <wbr>Scaled<wbr>Match<wbr>Result<span class="tsd-signature-symbol">(</span>confidence<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, scale<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, location<span class="tsd-signature-symbol">: </span><a href="region.html" class="tsd-signature-type">Region</a>, error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="scaledmatchresult.html" class="tsd-signature-type">ScaledMatchResult</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="matchresult.html">MatchResult</a>.<a href="matchresult.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/scaled-match-result.class.ts#L4">scaled-match-result.class.ts:4</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/scaled-match-result.class.ts#L4">scaled-match-result.class.ts:4</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -123,6 +124,9 @@
<li>
<h5>location: <a href="region.html" class="tsd-signature-type">Region</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> error: <span class="tsd-signature-type">Error</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="scaledmatchresult.html" class="tsd-signature-type">ScaledMatchResult</a></h4>
</li>
@@ -138,7 +142,18 @@
<aside class="tsd-sources">
<p>Overrides <a href="matchresult.html">MatchResult</a>.<a href="matchresult.html#confidence">confidence</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/scaled-match-result.class.ts#L5">scaled-match-result.class.ts:5</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/scaled-match-result.class.ts#L5">scaled-match-result.class.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-overwrite">
<a name="error" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> error</h3>
<div class="tsd-signature tsd-kind-icon">error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Error</span></div>
<aside class="tsd-sources">
<p>Overrides <a href="matchresult.html">MatchResult</a>.<a href="matchresult.html#error">error</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/scaled-match-result.class.ts#L8">scaled-match-result.class.ts:8</a></li>
</ul>
</aside>
</section>
@@ -149,7 +164,7 @@
<aside class="tsd-sources">
<p>Overrides <a href="matchresult.html">MatchResult</a>.<a href="matchresult.html#location">location</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/scaled-match-result.class.ts#L7">scaled-match-result.class.ts:7</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/scaled-match-result.class.ts#L7">scaled-match-result.class.ts:7</a></li>
</ul>
</aside>
</section>
@@ -159,7 +174,7 @@
<div class="tsd-signature tsd-kind-icon">scale<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/scaled-match-result.class.ts#L6">scaled-match-result.class.ts:6</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/scaled-match-result.class.ts#L6">scaled-match-result.class.ts:6</a></li>
</ul>
</aside>
</section>
@@ -186,6 +201,9 @@
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-overwrite">
<a href="scaledmatchresult.html#confidence" class="tsd-kind-icon">confidence</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-overwrite">
<a href="scaledmatchresult.html#error" class="tsd-kind-icon">error</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-overwrite">
<a href="scaledmatchresult.html#location" class="tsd-kind-icon">location</a>
</li>
@@ -211,11 +229,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/classes/screen.html
+83 -17
View File
@@ -91,6 +91,7 @@
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="screen.html#capture" class="tsd-kind-icon">capture</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="screen.html#captureregion" class="tsd-kind-icon">capture<wbr>Region</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="screen.html#find" class="tsd-kind-icon">find</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="screen.html#height" class="tsd-kind-icon">height</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="screen.html#highlight" class="tsd-kind-icon">highlight</a></li>
@@ -120,7 +121,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/screen.class.ts#L46">screen.class.ts:46</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/screen.class.ts#L47">screen.class.ts:47</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -164,7 +165,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/screen.class.ts#L170">screen.class.ts:170</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/screen.class.ts#L195">screen.class.ts:195</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -209,6 +210,67 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="captureregion" class="tsd-anchor"></a>
<h3>capture<wbr>Region</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">capture<wbr>Region<span class="tsd-signature-symbol">(</span>fileName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, regionToCapture<span class="tsd-signature-symbol">: </span><a href="region.html" class="tsd-signature-type">Region</a>, fileFormat<span class="tsd-signature-symbol">?: </span><a href="../enums/filetype.html" class="tsd-signature-type">FileType</a>, filePath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, fileNamePrefix<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, fileNamePostfix<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/screen.class.ts#L220">screen.class.ts:220</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p><a href="screen.html#captureregion">captureRegion</a> captures a screenshot of a region on the systems main display</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>fileName: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Basename for the generated screenshot</p>
</div>
</li>
<li>
<h5>regionToCapture: <a href="region.html" class="tsd-signature-type">Region</a></h5>
<div class="tsd-comment tsd-typography">
<p>The region of the screen to capture in the screenshot</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> fileFormat: <a href="../enums/filetype.html" class="tsd-signature-type">FileType</a><span class="tsd-signature-symbol"> = FileType.PNG</span></h5>
<div class="tsd-comment tsd-typography">
<p>The <a href="../enums/filetype.html">FileType</a> for the generated screenshot</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> filePath: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = cwd()</span></h5>
<div class="tsd-comment tsd-typography">
<p>The output path for the generated screenshot (Default: {@link cwd})</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> fileNamePrefix: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;&quot;</span></h5>
<div class="tsd-comment tsd-typography">
<p>Filename prefix for the generated screenshot (Default: empty)</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> fileNamePostfix: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;&quot;</span></h5>
<div class="tsd-comment tsd-typography">
<p>Filename postfix for the generated screenshot (Default: empty)</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="find" class="tsd-anchor"></a>
<h3>find</h3>
@@ -219,7 +281,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/screen.class.ts#L81">screen.class.ts:81</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/screen.class.ts#L82">screen.class.ts:82</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -256,7 +318,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/screen.class.ts#L72">screen.class.ts:72</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/screen.class.ts#L73">screen.class.ts:73</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -280,7 +342,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/screen.class.ts#L132">screen.class.ts:132</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/screen.class.ts#L157">screen.class.ts:157</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -311,7 +373,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/screen.class.ts#L157">screen.class.ts:157</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/screen.class.ts#L182">screen.class.ts:182</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -348,7 +410,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/screen.class.ts#L144">screen.class.ts:144</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/screen.class.ts#L169">screen.class.ts:169</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -391,7 +453,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/screen.class.ts#L63">screen.class.ts:63</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/screen.class.ts#L64">screen.class.ts:64</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -414,7 +476,7 @@
<div class="tsd-signature tsd-kind-icon">config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/screen.class.ts#L22">screen.class.ts:22</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/screen.class.ts#L23">screen.class.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -428,7 +490,7 @@
<div class="tsd-signature tsd-kind-icon">auto<wbr>Highlight<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/screen.class.ts#L31">screen.class.ts:31</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/screen.class.ts#L32">screen.class.ts:32</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -443,7 +505,7 @@
<div class="tsd-signature tsd-kind-icon">confidence<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0.99</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/screen.class.ts#L26">screen.class.ts:26</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/screen.class.ts#L27">screen.class.ts:27</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -458,7 +520,7 @@
<div class="tsd-signature tsd-kind-icon">highlight<wbr>Duration<wbr>Ms<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 500</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/screen.class.ts#L35">screen.class.ts:35</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/screen.class.ts#L36">screen.class.ts:36</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -473,7 +535,7 @@
<div class="tsd-signature tsd-kind-icon">highlight<wbr>Opacity<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0.25</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/screen.class.ts#L40">screen.class.ts:40</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/screen.class.ts#L41">screen.class.ts:41</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -488,7 +550,7 @@
<div class="tsd-signature tsd-kind-icon">resource<wbr>Directory<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = cwd()</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/screen.class.ts#L45">screen.class.ts:45</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/screen.class.ts#L46">screen.class.ts:46</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -521,6 +583,9 @@
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="screen.html#capture" class="tsd-kind-icon">capture</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="screen.html#captureregion" class="tsd-kind-icon">capture<wbr>Region</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="screen.html#find" class="tsd-kind-icon">find</a>
</li>
@@ -561,11 +626,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/classes/screenaction.html
+11 -10
View File
@@ -112,7 +112,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-screen-action.class.ts#L16">provider/native/libnut-screen-action.class.ts:16</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-screen-action.class.ts#L16">provider/native/libnut-screen-action.class.ts:16</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="screenaction.html" class="tsd-signature-type">ScreenAction</a></h4>
@@ -133,7 +133,7 @@
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/screenactionprovider.html">ScreenActionProvider</a>.<a href="../interfaces/screenactionprovider.html#grabscreen">grabScreen</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-screen-action.class.ts#L21">provider/native/libnut-screen-action.class.ts:21</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-screen-action.class.ts#L21">provider/native/libnut-screen-action.class.ts:21</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="image.html" class="tsd-signature-type">Image</a><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -151,7 +151,7 @@
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/screenactionprovider.html">ScreenActionProvider</a>.<a href="../interfaces/screenactionprovider.html#grabscreenregion">grabScreenRegion</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-screen-action.class.ts#L45">provider/native/libnut-screen-action.class.ts:45</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-screen-action.class.ts#L45">provider/native/libnut-screen-action.class.ts:45</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -175,7 +175,7 @@
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/screenactionprovider.html">ScreenActionProvider</a>.<a href="../interfaces/screenactionprovider.html#highlightscreenregion">highlightScreenRegion</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-screen-action.class.ts#L70">provider/native/libnut-screen-action.class.ts:70</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-screen-action.class.ts#L70">provider/native/libnut-screen-action.class.ts:70</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -205,7 +205,7 @@
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/screenactionprovider.html">ScreenActionProvider</a>.<a href="../interfaces/screenactionprovider.html#screenheight">screenHeight</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-screen-action.class.ts#L89">provider/native/libnut-screen-action.class.ts:89</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-screen-action.class.ts#L89">provider/native/libnut-screen-action.class.ts:89</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -223,7 +223,7 @@
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/screenactionprovider.html">ScreenActionProvider</a>.<a href="../interfaces/screenactionprovider.html#screensize">screenSize</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-screen-action.class.ts#L100">provider/native/libnut-screen-action.class.ts:100</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-screen-action.class.ts#L100">provider/native/libnut-screen-action.class.ts:100</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="region.html" class="tsd-signature-type">Region</a><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -241,7 +241,7 @@
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/screenactionprovider.html">ScreenActionProvider</a>.<a href="../interfaces/screenactionprovider.html#screenwidth">screenWidth</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-screen-action.class.ts#L78">provider/native/libnut-screen-action.class.ts:78</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-screen-action.class.ts#L78">provider/native/libnut-screen-action.class.ts:78</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -305,11 +305,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/classes/templatematchingfinder.html
+7 -6
View File
@@ -108,7 +108,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/opencv/template-matching-finder.class.ts#L65">provider/opencv/template-matching-finder.class.ts:65</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/opencv/template-matching-finder.class.ts#L78">provider/opencv/template-matching-finder.class.ts:78</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -134,7 +134,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/opencv/template-matching-finder.class.ts#L175">provider/opencv/template-matching-finder.class.ts:175</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/opencv/template-matching-finder.class.ts#L134">provider/opencv/template-matching-finder.class.ts:134</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -160,7 +160,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/opencv/template-matching-finder.class.ts#L72">provider/opencv/template-matching-finder.class.ts:72</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/opencv/template-matching-finder.class.ts#L85">provider/opencv/template-matching-finder.class.ts:85</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -221,11 +221,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/classes/visionadapter.html
+13 -12
View File
@@ -118,7 +118,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/vision.adapter.class.ts#L19">adapter/vision.adapter.class.ts:19</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/vision.adapter.class.ts#L19">adapter/vision.adapter.class.ts:19</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -170,7 +170,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/vision.adapter.class.ts#L71">adapter/vision.adapter.class.ts:71</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/vision.adapter.class.ts#L71">adapter/vision.adapter.class.ts:71</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -204,7 +204,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/vision.adapter.class.ts#L38">adapter/vision.adapter.class.ts:38</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/vision.adapter.class.ts#L38">adapter/vision.adapter.class.ts:38</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -227,7 +227,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/vision.adapter.class.ts#L48">adapter/vision.adapter.class.ts:48</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/vision.adapter.class.ts#L48">adapter/vision.adapter.class.ts:48</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -259,7 +259,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/vision.adapter.class.ts#L59">adapter/vision.adapter.class.ts:59</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/vision.adapter.class.ts#L59">adapter/vision.adapter.class.ts:59</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -302,7 +302,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/vision.adapter.class.ts#L123">adapter/vision.adapter.class.ts:123</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/vision.adapter.class.ts#L123">adapter/vision.adapter.class.ts:123</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -339,7 +339,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/vision.adapter.class.ts#L102">adapter/vision.adapter.class.ts:102</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/vision.adapter.class.ts#L102">adapter/vision.adapter.class.ts:102</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -364,7 +364,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/vision.adapter.class.ts#L113">adapter/vision.adapter.class.ts:113</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/vision.adapter.class.ts#L113">adapter/vision.adapter.class.ts:113</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -389,7 +389,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/adapter/vision.adapter.class.ts#L91">adapter/vision.adapter.class.ts:91</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/vision.adapter.class.ts#L91">adapter/vision.adapter.class.ts:91</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -467,11 +467,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/classes/window.html
+7 -6
View File
@@ -102,7 +102,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/window.class.ts#L4">window.class.ts:4</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/window.class.ts#L4">window.class.ts:4</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -131,7 +131,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/window.class.ts#L12">window.class.ts:12</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/window.class.ts#L12">window.class.ts:12</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="region.html" class="tsd-signature-type">Region</a><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -148,7 +148,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/window.class.ts#L8">window.class.ts:8</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/window.class.ts#L8">window.class.ts:8</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -200,11 +200,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/classes/windowaction.html
+8 -7
View File
@@ -105,7 +105,7 @@
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/windowactionprovider.html">WindowActionProvider</a>.<a href="../interfaces/windowactionprovider.html#getactivewindow">getActiveWindow</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-window-action.class.ts#L16">provider/native/libnut-window-action.class.ts:16</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-window-action.class.ts#L16">provider/native/libnut-window-action.class.ts:16</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -123,7 +123,7 @@
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/windowactionprovider.html">WindowActionProvider</a>.<a href="../interfaces/windowactionprovider.html#getwindowregion">getWindowRegion</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-window-action.class.ts#L26">provider/native/libnut-window-action.class.ts:26</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-window-action.class.ts#L26">provider/native/libnut-window-action.class.ts:26</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -147,7 +147,7 @@
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/windowactionprovider.html">WindowActionProvider</a>.<a href="../interfaces/windowactionprovider.html#getwindowtitle">getWindowTitle</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-window-action.class.ts#L37">provider/native/libnut-window-action.class.ts:37</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-window-action.class.ts#L37">provider/native/libnut-window-action.class.ts:37</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -171,7 +171,7 @@
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/windowactionprovider.html">WindowActionProvider</a>.<a href="../interfaces/windowactionprovider.html#getwindows">getWindows</a></p>
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-window-action.class.ts#L6">provider/native/libnut-window-action.class.ts:6</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-window-action.class.ts#L6">provider/native/libnut-window-action.class.ts:6</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -226,11 +226,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/enums/button.html
+7 -6
View File
@@ -92,7 +92,7 @@
<div class="tsd-signature tsd-kind-icon">LEFT<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/button.enum.ts#L5">button.enum.ts:5</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/button.enum.ts#L5">button.enum.ts:5</a></li>
</ul>
</aside>
</section>
@@ -102,7 +102,7 @@
<div class="tsd-signature tsd-kind-icon">MIDDLE<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/button.enum.ts#L6">button.enum.ts:6</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/button.enum.ts#L6">button.enum.ts:6</a></li>
</ul>
</aside>
</section>
@@ -112,7 +112,7 @@
<div class="tsd-signature tsd-kind-icon">RIGHT<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/button.enum.ts#L7">button.enum.ts:7</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/button.enum.ts#L7">button.enum.ts:7</a></li>
</ul>
</aside>
</section>
@@ -161,11 +161,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/enums/filetype.html
+6 -5
View File
@@ -91,7 +91,7 @@
<div class="tsd-signature tsd-kind-icon">JPG<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;.jpg&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/file-type.enum.ts#L6">file-type.enum.ts:6</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/file-type.enum.ts#L6">file-type.enum.ts:6</a></li>
</ul>
</aside>
</section>
@@ -101,7 +101,7 @@
<div class="tsd-signature tsd-kind-icon">PNG<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;.png&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/file-type.enum.ts#L5">file-type.enum.ts:5</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/file-type.enum.ts#L5">file-type.enum.ts:5</a></li>
</ul>
</aside>
</section>
@@ -147,11 +147,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/enums/key.html
+107 -106
View File
@@ -192,7 +192,7 @@
<div class="tsd-signature tsd-kind-icon">A<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L43">key.enum.ts:43</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L43">key.enum.ts:43</a></li>
</ul>
</aside>
</section>
@@ -202,7 +202,7 @@
<div class="tsd-signature tsd-kind-icon">Add<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L98">key.enum.ts:98</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L98">key.enum.ts:98</a></li>
</ul>
</aside>
</section>
@@ -212,7 +212,7 @@
<div class="tsd-signature tsd-kind-icon">B<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L44">key.enum.ts:44</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L44">key.enum.ts:44</a></li>
</ul>
</aside>
</section>
@@ -222,7 +222,7 @@
<div class="tsd-signature tsd-kind-icon">Backslash<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L76">key.enum.ts:76</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L76">key.enum.ts:76</a></li>
</ul>
</aside>
</section>
@@ -232,7 +232,7 @@
<div class="tsd-signature tsd-kind-icon">Backspace<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L73">key.enum.ts:73</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L73">key.enum.ts:73</a></li>
</ul>
</aside>
</section>
@@ -242,7 +242,7 @@
<div class="tsd-signature tsd-kind-icon">C<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L45">key.enum.ts:45</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L45">key.enum.ts:45</a></li>
</ul>
</aside>
</section>
@@ -252,7 +252,7 @@
<div class="tsd-signature tsd-kind-icon">Caps<wbr>Lock<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L116">key.enum.ts:116</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L116">key.enum.ts:116</a></li>
</ul>
</aside>
</section>
@@ -262,7 +262,7 @@
<div class="tsd-signature tsd-kind-icon">Comma<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L80">key.enum.ts:80</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L80">key.enum.ts:80</a></li>
</ul>
</aside>
</section>
@@ -272,7 +272,7 @@
<div class="tsd-signature tsd-kind-icon">D<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L46">key.enum.ts:46</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L46">key.enum.ts:46</a></li>
</ul>
</aside>
</section>
@@ -282,7 +282,7 @@
<div class="tsd-signature tsd-kind-icon">Decimal<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L102">key.enum.ts:102</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L102">key.enum.ts:102</a></li>
</ul>
</aside>
</section>
@@ -292,7 +292,7 @@
<div class="tsd-signature tsd-kind-icon">Delete<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L92">key.enum.ts:92</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L92">key.enum.ts:92</a></li>
</ul>
</aside>
</section>
@@ -302,7 +302,7 @@
<div class="tsd-signature tsd-kind-icon">Divide<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L101">key.enum.ts:101</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L101">key.enum.ts:101</a></li>
</ul>
</aside>
</section>
@@ -312,7 +312,7 @@
<div class="tsd-signature tsd-kind-icon">Down<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L87">key.enum.ts:87</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L87">key.enum.ts:87</a></li>
</ul>
</aside>
</section>
@@ -322,7 +322,7 @@
<div class="tsd-signature tsd-kind-icon">E<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L47">key.enum.ts:47</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L47">key.enum.ts:47</a></li>
</ul>
</aside>
</section>
@@ -332,7 +332,7 @@
<div class="tsd-signature tsd-kind-icon">End<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L94">key.enum.ts:94</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L94">key.enum.ts:94</a></li>
</ul>
</aside>
</section>
@@ -342,7 +342,7 @@
<div class="tsd-signature tsd-kind-icon">Enter<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L103">key.enum.ts:103</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L103">key.enum.ts:103</a></li>
</ul>
</aside>
</section>
@@ -352,7 +352,7 @@
<div class="tsd-signature tsd-kind-icon">Equal<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L72">key.enum.ts:72</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L72">key.enum.ts:72</a></li>
</ul>
</aside>
</section>
@@ -362,7 +362,7 @@
<div class="tsd-signature tsd-kind-icon">Escape<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L6">key.enum.ts:6</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L6">key.enum.ts:6</a></li>
</ul>
</aside>
</section>
@@ -372,7 +372,7 @@
<div class="tsd-signature tsd-kind-icon">F<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L48">key.enum.ts:48</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L48">key.enum.ts:48</a></li>
</ul>
</aside>
</section>
@@ -382,7 +382,7 @@
<div class="tsd-signature tsd-kind-icon">F1<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L19">key.enum.ts:19</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L19">key.enum.ts:19</a></li>
</ul>
</aside>
</section>
@@ -392,7 +392,7 @@
<div class="tsd-signature tsd-kind-icon">F10<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L28">key.enum.ts:28</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L28">key.enum.ts:28</a></li>
</ul>
</aside>
</section>
@@ -402,7 +402,7 @@
<div class="tsd-signature tsd-kind-icon">F11<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L29">key.enum.ts:29</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L29">key.enum.ts:29</a></li>
</ul>
</aside>
</section>
@@ -412,7 +412,7 @@
<div class="tsd-signature tsd-kind-icon">F12<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L30">key.enum.ts:30</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L30">key.enum.ts:30</a></li>
</ul>
</aside>
</section>
@@ -422,7 +422,7 @@
<div class="tsd-signature tsd-kind-icon">F2<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L20">key.enum.ts:20</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L20">key.enum.ts:20</a></li>
</ul>
</aside>
</section>
@@ -432,7 +432,7 @@
<div class="tsd-signature tsd-kind-icon">F3<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L21">key.enum.ts:21</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L21">key.enum.ts:21</a></li>
</ul>
</aside>
</section>
@@ -442,7 +442,7 @@
<div class="tsd-signature tsd-kind-icon">F4<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L22">key.enum.ts:22</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L22">key.enum.ts:22</a></li>
</ul>
</aside>
</section>
@@ -452,7 +452,7 @@
<div class="tsd-signature tsd-kind-icon">F5<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L23">key.enum.ts:23</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L23">key.enum.ts:23</a></li>
</ul>
</aside>
</section>
@@ -462,7 +462,7 @@
<div class="tsd-signature tsd-kind-icon">F6<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L24">key.enum.ts:24</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L24">key.enum.ts:24</a></li>
</ul>
</aside>
</section>
@@ -472,7 +472,7 @@
<div class="tsd-signature tsd-kind-icon">F7<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L25">key.enum.ts:25</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L25">key.enum.ts:25</a></li>
</ul>
</aside>
</section>
@@ -482,7 +482,7 @@
<div class="tsd-signature tsd-kind-icon">F8<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L26">key.enum.ts:26</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L26">key.enum.ts:26</a></li>
</ul>
</aside>
</section>
@@ -492,7 +492,7 @@
<div class="tsd-signature tsd-kind-icon">F9<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L27">key.enum.ts:27</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L27">key.enum.ts:27</a></li>
</ul>
</aside>
</section>
@@ -502,7 +502,7 @@
<div class="tsd-signature tsd-kind-icon">G<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L49">key.enum.ts:49</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L49">key.enum.ts:49</a></li>
</ul>
</aside>
</section>
@@ -512,7 +512,7 @@
<div class="tsd-signature tsd-kind-icon">Grave<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L70">key.enum.ts:70</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L70">key.enum.ts:70</a></li>
</ul>
</aside>
</section>
@@ -522,7 +522,7 @@
<div class="tsd-signature tsd-kind-icon">H<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L50">key.enum.ts:50</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L50">key.enum.ts:50</a></li>
</ul>
</aside>
</section>
@@ -532,7 +532,7 @@
<div class="tsd-signature tsd-kind-icon">Home<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L93">key.enum.ts:93</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L93">key.enum.ts:93</a></li>
</ul>
</aside>
</section>
@@ -542,7 +542,7 @@
<div class="tsd-signature tsd-kind-icon">I<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L51">key.enum.ts:51</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L51">key.enum.ts:51</a></li>
</ul>
</aside>
</section>
@@ -552,7 +552,7 @@
<div class="tsd-signature tsd-kind-icon">Insert<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L91">key.enum.ts:91</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L91">key.enum.ts:91</a></li>
</ul>
</aside>
</section>
@@ -562,7 +562,7 @@
<div class="tsd-signature tsd-kind-icon">J<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L52">key.enum.ts:52</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L52">key.enum.ts:52</a></li>
</ul>
</aside>
</section>
@@ -572,7 +572,7 @@
<div class="tsd-signature tsd-kind-icon">K<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L53">key.enum.ts:53</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L53">key.enum.ts:53</a></li>
</ul>
</aside>
</section>
@@ -582,7 +582,7 @@
<div class="tsd-signature tsd-kind-icon">L<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L54">key.enum.ts:54</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L54">key.enum.ts:54</a></li>
</ul>
</aside>
</section>
@@ -592,7 +592,7 @@
<div class="tsd-signature tsd-kind-icon">Left<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L84">key.enum.ts:84</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L84">key.enum.ts:84</a></li>
</ul>
</aside>
</section>
@@ -602,7 +602,7 @@
<div class="tsd-signature tsd-kind-icon">Left<wbr>Alt<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L9">key.enum.ts:9</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L9">key.enum.ts:9</a></li>
</ul>
</aside>
</section>
@@ -612,7 +612,7 @@
<div class="tsd-signature tsd-kind-icon">Left<wbr>Bracket<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L74">key.enum.ts:74</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L74">key.enum.ts:74</a></li>
</ul>
</aside>
</section>
@@ -622,7 +622,7 @@
<div class="tsd-signature tsd-kind-icon">Left<wbr>Control<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L10">key.enum.ts:10</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L10">key.enum.ts:10</a></li>
</ul>
</aside>
</section>
@@ -632,7 +632,7 @@
<div class="tsd-signature tsd-kind-icon">Left<wbr>Shift<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L14">key.enum.ts:14</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L14">key.enum.ts:14</a></li>
</ul>
</aside>
</section>
@@ -642,7 +642,7 @@
<div class="tsd-signature tsd-kind-icon">Left<wbr>Super<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L15">key.enum.ts:15</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L15">key.enum.ts:15</a></li>
</ul>
</aside>
</section>
@@ -652,7 +652,7 @@
<div class="tsd-signature tsd-kind-icon">M<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L55">key.enum.ts:55</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L55">key.enum.ts:55</a></li>
</ul>
</aside>
</section>
@@ -662,7 +662,7 @@
<div class="tsd-signature tsd-kind-icon">Minus<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L71">key.enum.ts:71</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L71">key.enum.ts:71</a></li>
</ul>
</aside>
</section>
@@ -672,7 +672,7 @@
<div class="tsd-signature tsd-kind-icon">Multiply<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L100">key.enum.ts:100</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L100">key.enum.ts:100</a></li>
</ul>
</aside>
</section>
@@ -682,7 +682,7 @@
<div class="tsd-signature tsd-kind-icon">N<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L56">key.enum.ts:56</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L56">key.enum.ts:56</a></li>
</ul>
</aside>
</section>
@@ -692,7 +692,7 @@
<div class="tsd-signature tsd-kind-icon">Num0<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L32">key.enum.ts:32</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L32">key.enum.ts:32</a></li>
</ul>
</aside>
</section>
@@ -702,7 +702,7 @@
<div class="tsd-signature tsd-kind-icon">Num1<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L33">key.enum.ts:33</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L33">key.enum.ts:33</a></li>
</ul>
</aside>
</section>
@@ -712,7 +712,7 @@
<div class="tsd-signature tsd-kind-icon">Num2<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L34">key.enum.ts:34</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L34">key.enum.ts:34</a></li>
</ul>
</aside>
</section>
@@ -722,7 +722,7 @@
<div class="tsd-signature tsd-kind-icon">Num3<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L35">key.enum.ts:35</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L35">key.enum.ts:35</a></li>
</ul>
</aside>
</section>
@@ -732,7 +732,7 @@
<div class="tsd-signature tsd-kind-icon">Num4<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L36">key.enum.ts:36</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L36">key.enum.ts:36</a></li>
</ul>
</aside>
</section>
@@ -742,7 +742,7 @@
<div class="tsd-signature tsd-kind-icon">Num5<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L37">key.enum.ts:37</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L37">key.enum.ts:37</a></li>
</ul>
</aside>
</section>
@@ -752,7 +752,7 @@
<div class="tsd-signature tsd-kind-icon">Num6<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L38">key.enum.ts:38</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L38">key.enum.ts:38</a></li>
</ul>
</aside>
</section>
@@ -762,7 +762,7 @@
<div class="tsd-signature tsd-kind-icon">Num7<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L39">key.enum.ts:39</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L39">key.enum.ts:39</a></li>
</ul>
</aside>
</section>
@@ -772,7 +772,7 @@
<div class="tsd-signature tsd-kind-icon">Num8<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L40">key.enum.ts:40</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L40">key.enum.ts:40</a></li>
</ul>
</aside>
</section>
@@ -782,7 +782,7 @@
<div class="tsd-signature tsd-kind-icon">Num9<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L41">key.enum.ts:41</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L41">key.enum.ts:41</a></li>
</ul>
</aside>
</section>
@@ -792,7 +792,7 @@
<div class="tsd-signature tsd-kind-icon">Num<wbr>Lock<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L118">key.enum.ts:118</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L118">key.enum.ts:118</a></li>
</ul>
</aside>
</section>
@@ -802,7 +802,7 @@
<div class="tsd-signature tsd-kind-icon">Num<wbr>Pad0<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L105">key.enum.ts:105</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L105">key.enum.ts:105</a></li>
</ul>
</aside>
</section>
@@ -812,7 +812,7 @@
<div class="tsd-signature tsd-kind-icon">Num<wbr>Pad1<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L106">key.enum.ts:106</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L106">key.enum.ts:106</a></li>
</ul>
</aside>
</section>
@@ -822,7 +822,7 @@
<div class="tsd-signature tsd-kind-icon">Num<wbr>Pad2<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L107">key.enum.ts:107</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L107">key.enum.ts:107</a></li>
</ul>
</aside>
</section>
@@ -832,7 +832,7 @@
<div class="tsd-signature tsd-kind-icon">Num<wbr>Pad3<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L108">key.enum.ts:108</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L108">key.enum.ts:108</a></li>
</ul>
</aside>
</section>
@@ -842,7 +842,7 @@
<div class="tsd-signature tsd-kind-icon">Num<wbr>Pad4<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L109">key.enum.ts:109</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L109">key.enum.ts:109</a></li>
</ul>
</aside>
</section>
@@ -852,7 +852,7 @@
<div class="tsd-signature tsd-kind-icon">Num<wbr>Pad5<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L110">key.enum.ts:110</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L110">key.enum.ts:110</a></li>
</ul>
</aside>
</section>
@@ -862,7 +862,7 @@
<div class="tsd-signature tsd-kind-icon">Num<wbr>Pad6<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L111">key.enum.ts:111</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L111">key.enum.ts:111</a></li>
</ul>
</aside>
</section>
@@ -872,7 +872,7 @@
<div class="tsd-signature tsd-kind-icon">Num<wbr>Pad7<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L112">key.enum.ts:112</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L112">key.enum.ts:112</a></li>
</ul>
</aside>
</section>
@@ -882,7 +882,7 @@
<div class="tsd-signature tsd-kind-icon">Num<wbr>Pad8<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L113">key.enum.ts:113</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L113">key.enum.ts:113</a></li>
</ul>
</aside>
</section>
@@ -892,7 +892,7 @@
<div class="tsd-signature tsd-kind-icon">Num<wbr>Pad9<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L114">key.enum.ts:114</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L114">key.enum.ts:114</a></li>
</ul>
</aside>
</section>
@@ -902,7 +902,7 @@
<div class="tsd-signature tsd-kind-icon">O<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L57">key.enum.ts:57</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L57">key.enum.ts:57</a></li>
</ul>
</aside>
</section>
@@ -912,7 +912,7 @@
<div class="tsd-signature tsd-kind-icon">P<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L58">key.enum.ts:58</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L58">key.enum.ts:58</a></li>
</ul>
</aside>
</section>
@@ -922,7 +922,7 @@
<div class="tsd-signature tsd-kind-icon">Page<wbr>Down<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L96">key.enum.ts:96</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L96">key.enum.ts:96</a></li>
</ul>
</aside>
</section>
@@ -932,7 +932,7 @@
<div class="tsd-signature tsd-kind-icon">Page<wbr>Up<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L95">key.enum.ts:95</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L95">key.enum.ts:95</a></li>
</ul>
</aside>
</section>
@@ -942,7 +942,7 @@
<div class="tsd-signature tsd-kind-icon">Pause<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L90">key.enum.ts:90</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L90">key.enum.ts:90</a></li>
</ul>
</aside>
</section>
@@ -952,7 +952,7 @@
<div class="tsd-signature tsd-kind-icon">Period<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L81">key.enum.ts:81</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L81">key.enum.ts:81</a></li>
</ul>
</aside>
</section>
@@ -962,7 +962,7 @@
<div class="tsd-signature tsd-kind-icon">Print<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L89">key.enum.ts:89</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L89">key.enum.ts:89</a></li>
</ul>
</aside>
</section>
@@ -972,7 +972,7 @@
<div class="tsd-signature tsd-kind-icon">Q<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L59">key.enum.ts:59</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L59">key.enum.ts:59</a></li>
</ul>
</aside>
</section>
@@ -982,7 +982,7 @@
<div class="tsd-signature tsd-kind-icon">Quote<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L78">key.enum.ts:78</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L78">key.enum.ts:78</a></li>
</ul>
</aside>
</section>
@@ -992,7 +992,7 @@
<div class="tsd-signature tsd-kind-icon">R<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L60">key.enum.ts:60</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L60">key.enum.ts:60</a></li>
</ul>
</aside>
</section>
@@ -1002,7 +1002,7 @@
<div class="tsd-signature tsd-kind-icon">Return<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L79">key.enum.ts:79</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L79">key.enum.ts:79</a></li>
</ul>
</aside>
</section>
@@ -1012,7 +1012,7 @@
<div class="tsd-signature tsd-kind-icon">Right<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L86">key.enum.ts:86</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L86">key.enum.ts:86</a></li>
</ul>
</aside>
</section>
@@ -1022,7 +1022,7 @@
<div class="tsd-signature tsd-kind-icon">Right<wbr>Alt<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L11">key.enum.ts:11</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L11">key.enum.ts:11</a></li>
</ul>
</aside>
</section>
@@ -1032,7 +1032,7 @@
<div class="tsd-signature tsd-kind-icon">Right<wbr>Bracket<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L75">key.enum.ts:75</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L75">key.enum.ts:75</a></li>
</ul>
</aside>
</section>
@@ -1042,7 +1042,7 @@
<div class="tsd-signature tsd-kind-icon">Right<wbr>Control<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L12">key.enum.ts:12</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L12">key.enum.ts:12</a></li>
</ul>
</aside>
</section>
@@ -1052,7 +1052,7 @@
<div class="tsd-signature tsd-kind-icon">Right<wbr>Shift<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L16">key.enum.ts:16</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L16">key.enum.ts:16</a></li>
</ul>
</aside>
</section>
@@ -1062,7 +1062,7 @@
<div class="tsd-signature tsd-kind-icon">Right<wbr>Super<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L17">key.enum.ts:17</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L17">key.enum.ts:17</a></li>
</ul>
</aside>
</section>
@@ -1072,7 +1072,7 @@
<div class="tsd-signature tsd-kind-icon">S<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L61">key.enum.ts:61</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L61">key.enum.ts:61</a></li>
</ul>
</aside>
</section>
@@ -1082,7 +1082,7 @@
<div class="tsd-signature tsd-kind-icon">Scroll<wbr>Lock<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L117">key.enum.ts:117</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L117">key.enum.ts:117</a></li>
</ul>
</aside>
</section>
@@ -1092,7 +1092,7 @@
<div class="tsd-signature tsd-kind-icon">Semicolon<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L77">key.enum.ts:77</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L77">key.enum.ts:77</a></li>
</ul>
</aside>
</section>
@@ -1102,7 +1102,7 @@
<div class="tsd-signature tsd-kind-icon">Slash<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L82">key.enum.ts:82</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L82">key.enum.ts:82</a></li>
</ul>
</aside>
</section>
@@ -1112,7 +1112,7 @@
<div class="tsd-signature tsd-kind-icon">Space<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L5">key.enum.ts:5</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L5">key.enum.ts:5</a></li>
</ul>
</aside>
</section>
@@ -1122,7 +1122,7 @@
<div class="tsd-signature tsd-kind-icon">Subtract<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L99">key.enum.ts:99</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L99">key.enum.ts:99</a></li>
</ul>
</aside>
</section>
@@ -1132,7 +1132,7 @@
<div class="tsd-signature tsd-kind-icon">T<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L62">key.enum.ts:62</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L62">key.enum.ts:62</a></li>
</ul>
</aside>
</section>
@@ -1142,7 +1142,7 @@
<div class="tsd-signature tsd-kind-icon">Tab<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L7">key.enum.ts:7</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L7">key.enum.ts:7</a></li>
</ul>
</aside>
</section>
@@ -1152,7 +1152,7 @@
<div class="tsd-signature tsd-kind-icon">U<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L63">key.enum.ts:63</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L63">key.enum.ts:63</a></li>
</ul>
</aside>
</section>
@@ -1162,7 +1162,7 @@
<div class="tsd-signature tsd-kind-icon">Up<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L85">key.enum.ts:85</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L85">key.enum.ts:85</a></li>
</ul>
</aside>
</section>
@@ -1172,7 +1172,7 @@
<div class="tsd-signature tsd-kind-icon">V<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L64">key.enum.ts:64</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L64">key.enum.ts:64</a></li>
</ul>
</aside>
</section>
@@ -1182,7 +1182,7 @@
<div class="tsd-signature tsd-kind-icon">W<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L65">key.enum.ts:65</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L65">key.enum.ts:65</a></li>
</ul>
</aside>
</section>
@@ -1192,7 +1192,7 @@
<div class="tsd-signature tsd-kind-icon">X<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L66">key.enum.ts:66</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L66">key.enum.ts:66</a></li>
</ul>
</aside>
</section>
@@ -1202,7 +1202,7 @@
<div class="tsd-signature tsd-kind-icon">Y<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L67">key.enum.ts:67</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L67">key.enum.ts:67</a></li>
</ul>
</aside>
</section>
@@ -1212,7 +1212,7 @@
<div class="tsd-signature tsd-kind-icon">Z<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/key.enum.ts#L68">key.enum.ts:68</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/key.enum.ts#L68">key.enum.ts:68</a></li>
</ul>
</aside>
</section>
@@ -1561,11 +1561,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/globals.html
+79 -71
View File
@@ -83,7 +83,6 @@
<li class="tsd-kind-class"><a href="classes/assert.html" class="tsd-kind-icon">Assert</a></li>
<li class="tsd-kind-class"><a href="classes/bresenham.html" class="tsd-kind-icon">Bresenham</a></li>
<li class="tsd-kind-class"><a href="classes/clipboard.html" class="tsd-kind-icon">Clipboard</a></li>
<li class="tsd-kind-class"><a href="classes/clipboardaction.html" class="tsd-kind-icon">Clipboard<wbr>Action</a></li>
<li class="tsd-kind-class"><a href="classes/image.html" class="tsd-kind-icon">Image</a></li>
<li class="tsd-kind-class"><a href="classes/imagereader.html" class="tsd-kind-icon">Image<wbr>Reader</a></li>
<li class="tsd-kind-class"><a href="classes/imagewriter.html" class="tsd-kind-icon">Image<wbr>Writer</a></li>
@@ -105,6 +104,7 @@
<li class="tsd-kind-class"><a href="classes/visionadapter.html" class="tsd-kind-icon">Vision<wbr>Adapter</a></li>
<li class="tsd-kind-class"><a href="classes/window.html" class="tsd-kind-icon">Window</a></li>
<li class="tsd-kind-class"><a href="classes/windowaction.html" class="tsd-kind-icon">Window<wbr>Action</a></li>
<li class="tsd-kind-class"><a href="classes/default.html" class="tsd-kind-icon">default</a></li>
</ul>
</section>
<section class="tsd-index-section ">
@@ -118,6 +118,7 @@
<li class="tsd-kind-interface"><a href="interfaces/mouseactionprovider.html" class="tsd-kind-icon">Mouse<wbr>Action<wbr>Provider</a></li>
<li class="tsd-kind-interface"><a href="interfaces/movementapi.html" class="tsd-kind-icon">Movement<wbr>Api</a></li>
<li class="tsd-kind-interface"><a href="interfaces/screenactionprovider.html" class="tsd-kind-icon">Screen<wbr>Action<wbr>Provider</a></li>
<li class="tsd-kind-interface"><a href="interfaces/timoutconfig.html" class="tsd-kind-icon">Timout<wbr>Config</a></li>
<li class="tsd-kind-interface"><a href="interfaces/windowactionprovider.html" class="tsd-kind-icon">Window<wbr>Action<wbr>Provider</a></li>
<li class="tsd-kind-interface"><a href="interfaces/windowapi.html" class="tsd-kind-icon">Window<wbr>Api</a></li>
</ul>
@@ -141,11 +142,11 @@
<li class="tsd-kind-function"><a href="globals.html#busywaitfornanoseconds" class="tsd-kind-icon">busy<wbr>Wait<wbr>For<wbr>Nano<wbr>Seconds</a></li>
<li class="tsd-kind-function"><a href="globals.html#centerof" class="tsd-kind-icon">center<wbr>Of</a></li>
<li class="tsd-kind-function"><a href="globals.html#createmovementapi" class="tsd-kind-icon">create<wbr>Movement<wbr>Api</a></li>
<li class="tsd-kind-function"><a href="globals.html#createresultforinvalidsearch" class="tsd-kind-icon">create<wbr>Result<wbr>For<wbr>Invalid<wbr>Search</a></li>
<li class="tsd-kind-function"><a href="globals.html#createwindowapi" class="tsd-kind-icon">create<wbr>Window<wbr>Api</a></li>
<li class="tsd-kind-function"><a href="globals.html#debugimage" class="tsd-kind-icon">debug<wbr>Image</a></li>
<li class="tsd-kind-function"><a href="globals.html#determineroi" class="tsd-kind-icon">determineROI</a></li>
<li class="tsd-kind-function"><a href="globals.html#determinescaledsearchregion" class="tsd-kind-icon">determine<wbr>Scaled<wbr>Search<wbr>Region</a></li>
<li class="tsd-kind-function"><a href="globals.html#findedges" class="tsd-kind-icon">find<wbr>Edges</a></li>
<li class="tsd-kind-function"><a href="globals.html#fromimagewithalphachannel" class="tsd-kind-icon">from<wbr>Image<wbr>With<wbr>Alpha<wbr>Channel</a></li>
<li class="tsd-kind-function"><a href="globals.html#fromimagewithoutalphachannel" class="tsd-kind-icon">from<wbr>Image<wbr>Without<wbr>Alpha<wbr>Channel</a></li>
<li class="tsd-kind-function"><a href="globals.html#generateoutputpath" class="tsd-kind-icon">generate<wbr>Output<wbr>Path</a></li>
@@ -184,7 +185,7 @@
<div class="tsd-signature tsd-kind-icon">Find<wbr>Hook<wbr>Callback<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>target<span class="tsd-signature-symbol">: </span><a href="classes/matchresult.html" class="tsd-signature-type">MatchResult</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/screen.class.ts#L12">screen.class.ts:12</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/screen.class.ts#L13">screen.class.ts:13</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
@@ -215,7 +216,7 @@
<div class="tsd-signature tsd-kind-icon">String<wbr>OrKey<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="enums/key.html" class="tsd-signature-type">Key</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/keyboard.class.ts#L5">keyboard.class.ts:5</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/keyboard.class.ts#L5">keyboard.class.ts:5</a></li>
</ul>
</aside>
</section>
@@ -228,10 +229,10 @@
<div class="tsd-signature tsd-kind-icon">libnut<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;/Users/s1hofmann/Documents/git/nut-tree/nut.js/node_modules/@nut-tree/libnut/index&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-keyboard-action.class.ts#L1">provider/native/libnut-keyboard-action.class.ts:1</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-mouse-action.class.ts#L1">provider/native/libnut-mouse-action.class.ts:1</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-window-action.class.ts#L1">provider/native/libnut-window-action.class.ts:1</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/libnut-screen-action.class.ts#L1">provider/native/libnut-screen-action.class.ts:1</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-keyboard-action.class.ts#L1">provider/native/libnut-keyboard-action.class.ts:1</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-mouse-action.class.ts#L1">provider/native/libnut-mouse-action.class.ts:1</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-window-action.class.ts#L1">provider/native/libnut-window-action.class.ts:1</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/libnut-screen-action.class.ts#L1">provider/native/libnut-screen-action.class.ts:1</a></li>
</ul>
</aside>
</section>
@@ -248,7 +249,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/sleep.function.ts#L5">sleep.function.ts:5</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/sleep.function.ts#L5">sleep.function.ts:5</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -271,7 +272,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/location.function.ts#L8">location.function.ts:8</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/location.function.ts#L8">location.function.ts:8</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -304,7 +305,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/movement.function.ts#L6">movement.function.ts:6</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/movement.function.ts#L6">movement.function.ts:6</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -320,6 +321,29 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="createresultforinvalidsearch" class="tsd-anchor"></a>
<h3>create<wbr>Result<wbr>For<wbr>Invalid<wbr>Search</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">create<wbr>Result<wbr>For<wbr>Invalid<wbr>Search<span class="tsd-signature-symbol">(</span>currentScale<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="classes/scaledmatchresult.html" class="tsd-signature-type">ScaledMatchResult</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/opencv/template-matching-finder.class.ts#L63">provider/opencv/template-matching-finder.class.ts:63</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>currentScale: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="classes/scaledmatchresult.html" class="tsd-signature-type">ScaledMatchResult</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="createwindowapi" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> create<wbr>Window<wbr>Api</h3>
@@ -330,7 +354,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/window.function.ts#L5">window.function.ts:5</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/window.function.ts#L5">window.function.ts:5</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -353,7 +377,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/opencv/template-matching-finder.class.ts#L39">provider/opencv/template-matching-finder.class.ts:39</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/opencv/template-matching-finder.class.ts#L39">provider/opencv/template-matching-finder.class.ts:39</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -382,7 +406,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/opencv/image-processor.class.ts#L5">provider/opencv/image-processor.class.ts:5</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/opencv/image-processor.class.ts#L5">provider/opencv/image-processor.class.ts:5</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -408,7 +432,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/opencv/determine-searchregion.function.ts#L4">provider/opencv/determine-searchregion.function.ts:4</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/opencv/determine-searchregion.function.ts#L4">provider/opencv/determine-searchregion.function.ts:4</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -421,29 +445,6 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="findedges" class="tsd-anchor"></a>
<h3>find<wbr>Edges</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">find<wbr>Edges<span class="tsd-signature-symbol">(</span>image<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Mat</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Mat</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/opencv/find-edges.function.ts#L3">provider/opencv/find-edges.function.ts:3</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>image: <span class="tsd-signature-type">Mat</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Mat</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="fromimagewithalphachannel" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> from<wbr>Image<wbr>With<wbr>Alpha<wbr>Channel</h3>
@@ -454,7 +455,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/opencv/image-processor.class.ts#L22">provider/opencv/image-processor.class.ts:22</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/opencv/image-processor.class.ts#L22">provider/opencv/image-processor.class.ts:22</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -497,7 +498,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/opencv/image-processor.class.ts#L43">provider/opencv/image-processor.class.ts:43</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/opencv/image-processor.class.ts#L43">provider/opencv/image-processor.class.ts:43</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -540,7 +541,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/generate-output-path.function.ts#L10">generate-output-path.function.ts:10</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/generate-output-path.function.ts#L10">generate-output-path.function.ts:10</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -581,7 +582,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/keyboard.class.ts#L7">keyboard.class.ts:7</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/keyboard.class.ts#L7">keyboard.class.ts:7</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -604,7 +605,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/opencv/template-matching-finder.class.ts#L59">provider/opencv/template-matching-finder.class.ts:59</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/opencv/template-matching-finder.class.ts#L59">provider/opencv/template-matching-finder.class.ts:59</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -630,7 +631,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/movementtype.function.ts#L1">movementtype.function.ts:1</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/movementtype.function.ts#L1">movementtype.function.ts:1</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -656,7 +657,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/opencv/template-matching-finder.class.ts#L24">provider/opencv/template-matching-finder.class.ts:24</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/opencv/template-matching-finder.class.ts#L24">provider/opencv/template-matching-finder.class.ts:24</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -679,7 +680,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/opencv/template-matching-finder.class.ts#L17">provider/opencv/template-matching-finder.class.ts:17</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/opencv/template-matching-finder.class.ts#L17">provider/opencv/template-matching-finder.class.ts:17</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -702,7 +703,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/opencv/bound-value.function.ts#L1">provider/opencv/bound-value.function.ts:1</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/opencv/bound-value.function.ts#L1">provider/opencv/bound-value.function.ts:1</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -731,7 +732,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/opencv/match-image.function.ts#L5">provider/opencv/match-image.function.ts:5</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/opencv/match-image.function.ts#L5">provider/opencv/match-image.function.ts:5</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -757,7 +758,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/location.function.ts#L20">location.function.ts:20</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/location.function.ts#L20">location.function.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -790,7 +791,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/opencv/scale-image.function.ts#L4">provider/opencv/scale-image.function.ts:4</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/opencv/scale-image.function.ts#L4">provider/opencv/scale-image.function.ts:4</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -816,7 +817,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/opencv/scale-location.function.ts#L4">provider/opencv/scale-location.function.ts:4</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/opencv/scale-location.function.ts#L4">provider/opencv/scale-location.function.ts:4</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -842,7 +843,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/sleep.function.ts#L1">sleep.function.ts:1</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/sleep.function.ts#L1">sleep.function.ts:1</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -859,13 +860,13 @@
<a name="timeout" class="tsd-anchor"></a>
<h3>timeout</h3>
<ul class="tsd-signatures tsd-kind-function tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">timeout&lt;R&gt;<span class="tsd-signature-symbol">(</span>updateIntervalMs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, maxDurationMs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, action<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>params<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">R</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">R</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">timeout&lt;R&gt;<span class="tsd-signature-symbol">(</span>updateIntervalMs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, maxDurationMs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, action<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>params<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">R</span><span class="tsd-signature-symbol">&gt;</span>, config<span class="tsd-signature-symbol">?: </span><a href="interfaces/timoutconfig.html" class="tsd-signature-type">TimoutConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">R</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/util/poll-action.function.ts#L1">util/poll-action.function.ts:1</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/util/timeout.function.ts#L7">util/timeout.function.ts:7</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@@ -903,6 +904,9 @@
</li>
</ul>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> config: <a href="interfaces/timoutconfig.html" class="tsd-signature-type">TimoutConfig</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">R</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
@@ -918,7 +922,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/expect/matchers/toBeAt.function.ts#L4">expect/matchers/toBeAt.function.ts:4</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/expect/matchers/toBeAt.function.ts#L4">expect/matchers/toBeAt.function.ts:4</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -944,7 +948,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/expect/matchers/toBeIn.function.ts#L4">expect/matchers/toBeIn.function.ts:4</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/expect/matchers/toBeIn.function.ts#L4">expect/matchers/toBeIn.function.ts:4</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -970,7 +974,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/expect/matchers/toShow.function.ts#L4">expect/matchers/toShow.function.ts:4</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/expect/matchers/toShow.function.ts#L4">expect/matchers/toShow.function.ts:4</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -999,7 +1003,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/opencv/bound-value.function.ts#L5">provider/opencv/bound-value.function.ts:5</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/opencv/bound-value.function.ts#L5">provider/opencv/bound-value.function.ts:5</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1027,7 +1031,7 @@
<div class="tsd-signature tsd-kind-icon">jest<wbr>Matchers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/expect/jest.matcher.function.ts#L17">expect/jest.matcher.function.ts:17</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/expect/jest.matcher.function.ts#L17">expect/jest.matcher.function.ts:17</a></li>
</ul>
</aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
@@ -1036,7 +1040,7 @@
<div class="tsd-signature tsd-kind-icon">to<wbr>BeAt<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">toBeAt</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/expect/jest.matcher.function.ts#L18">expect/jest.matcher.function.ts:18</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/expect/jest.matcher.function.ts#L18">expect/jest.matcher.function.ts:18</a></li>
</ul>
</aside>
</section>
@@ -1046,7 +1050,7 @@
<div class="tsd-signature tsd-kind-icon">to<wbr>BeIn<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">toBeIn</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/expect/jest.matcher.function.ts#L19">expect/jest.matcher.function.ts:19</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/expect/jest.matcher.function.ts#L19">expect/jest.matcher.function.ts:19</a></li>
</ul>
</aside>
</section>
@@ -1056,7 +1060,7 @@
<div class="tsd-signature tsd-kind-icon">to<wbr>Show<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">toShow</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/expect/jest.matcher.function.ts#L20">expect/jest.matcher.function.ts:20</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/expect/jest.matcher.function.ts#L20">expect/jest.matcher.function.ts:20</a></li>
</ul>
</aside>
</section>
@@ -1097,9 +1101,6 @@
<li class=" tsd-kind-class">
<a href="classes/clipboard.html" class="tsd-kind-icon">Clipboard</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/clipboardaction.html" class="tsd-kind-icon">Clipboard<wbr>Action</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/image.html" class="tsd-kind-icon">Image</a>
</li>
@@ -1163,6 +1164,9 @@
<li class=" tsd-kind-class">
<a href="classes/windowaction.html" class="tsd-kind-icon">Window<wbr>Action</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/default.html" class="tsd-kind-icon">default</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/clipboardactionprovider.html" class="tsd-kind-icon">Clipboard<wbr>Action<wbr>Provider</a>
</li>
@@ -1187,6 +1191,9 @@
<li class=" tsd-kind-interface">
<a href="interfaces/screenactionprovider.html" class="tsd-kind-icon">Screen<wbr>Action<wbr>Provider</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/timoutconfig.html" class="tsd-kind-icon">Timout<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/windowactionprovider.html" class="tsd-kind-icon">Window<wbr>Action<wbr>Provider</a>
</li>
@@ -1211,6 +1218,9 @@
<li class=" tsd-kind-function">
<a href="globals.html#createmovementapi" class="tsd-kind-icon">create<wbr>Movement<wbr>Api</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#createresultforinvalidsearch" class="tsd-kind-icon">create<wbr>Result<wbr>For<wbr>Invalid<wbr>Search</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#createwindowapi" class="tsd-kind-icon">create<wbr>Window<wbr>Api</a>
</li>
@@ -1223,9 +1233,6 @@
<li class=" tsd-kind-function">
<a href="globals.html#determinescaledsearchregion" class="tsd-kind-icon">determine<wbr>Scaled<wbr>Search<wbr>Region</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#findedges" class="tsd-kind-icon">find<wbr>Edges</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#fromimagewithalphachannel" class="tsd-kind-icon">from<wbr>Image<wbr>With<wbr>Alpha<wbr>Channel</a>
</li>
@@ -1301,11 +1308,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/index.html
+32 -23
View File
@@ -67,21 +67,21 @@
<thead>
<tr>
<th align="center"></th>
<th align="center">Travis</th>
<th align="center">Appveyor</th>
<th align="center">GitHub Actions</th>
</tr>
</thead>
<tbody><tr>
<td align="center">Master</td>
<td align="center"><a href="https://travis-ci.com/nut-tree/nut.js"><img src="https://travis-ci.com/nut-tree/nut.js.svg?branch=master" alt="Build Status"></a></td>
<td align="center"><a href="https://ci.appveyor.com/project/s1hofmann/nut-js/branch/master"><img src="https://ci.appveyor.com/api/projects/status/iohwxc5t46gcuvby/branch/master?svg=true" alt="Build status"></a></td>
<td align="center"><img src="https://github.com/nut-tree/nut.js/workflows/Create%20tagged%20release/badge.svg" alt="Create tagged release"></td>
</tr>
<tr>
<td align="center">Develop</td>
<td align="center"><a href="https://travis-ci.com/nut-tree/nut.js"><img src="https://travis-ci.com/nut-tree/nut.js.svg?branch=develop" alt="Build Status"></a></td>
<td align="center"><a href="https://ci.appveyor.com/project/s1hofmann/nut-js/branch/develop"><img src="https://ci.appveyor.com/api/projects/status/iohwxc5t46gcuvby/branch/develop?svg=true" alt="Build status"></a></td>
<td align="center"><img src="https://github.com/nut-tree/nut.js/workflows/Create%20snapshot%20release/badge.svg" alt="Create snapshot release"></td>
</tr>
</tbody></table>
<p><img src="https://img.shields.io/badge/node%40lts-erbium%2C%20fermium-green" alt="Supported node LTS versions">
<img src="https://img.shields.io/badge/node-15.x.x-green" alt="Supported node versions">
<img src="https://img.shields.io/badge/electron-8.x.x%20--%2012.x.x-green" alt="Supported Electron versions"></p>
<p><a href="https://sonarcloud.io/dashboard?id=nut-tree%3Anut.js"><img src="https://sonarcloud.io/api/project_badges/measure?project=nut-tree%3Anut.js&metric=alert_status" alt="SonarCloud badge"></a>
<a href="https://sonarcloud.io/component_measures?id=nut-tree%3Anut.js&amp;metric=coverage"><img src="https://sonarcloud.io/api/project_badges/measure?project=nut-tree%3Anut.js&metric=coverage" alt="SonarCloud Coverage"></a></p>
<p><a href="https://www.npmjs.com/package/@nut-tree/nut-js"><img src="https://img.shields.io/npm/dm/@nut-tree/nut-js" alt="Downloads per month"></a></p>
@@ -106,6 +106,14 @@
<h1>Examples</h1>
</a>
<p><a href="https://github.com/nut-tree/trailmix">nut-tree/trailmix</a> contains a set of ready to use examples which demo the usage ot nut.js.</p>
<a href="#discussion" id="discussion" style="color: inherit; text-decoration: none;">
<h1>Discussion</h1>
</a>
<p>In <a href="https://github.com/nut-tree/rfc">nut-tree/rfc</a> documents regarding larger design / implementation changes in nut.js are up for discussion.</p>
<a href="#community" id="community" style="color: inherit; text-decoration: none;">
<h1>Community</h1>
</a>
<p>Feel free to join our <a href="https://discord.gg/sJkN7789XR">Discord community</a></p>
<a href="#modules" id="modules" style="color: inherit; text-decoration: none;">
<h1>Modules</h1>
</a>
@@ -163,9 +171,9 @@
<h1>Sample</h1>
</a>
<p>The following snippet shows a valid <code>nut.js</code> example (on macOS)</p>
<pre><code class="language-js"><span class="hljs-meta">"use strict"</span>;
<pre><code class="language-js"><span class="hljs-meta">&quot;use strict&quot;</span>;
<span class="hljs-keyword">const</span> { keyboard, Key, mouse, left, right, up, down, screen } = <span class="hljs-built_in">require</span>(<span class="hljs-string">"@nut-tree/nut-js"</span>);
<span class="hljs-keyword">const</span> { keyboard, Key, mouse, left, right, up, down, screen } = <span class="hljs-built_in">require</span>(<span class="hljs-string">&quot;@nut-tree/nut-js&quot;</span>);
<span class="hljs-keyword">const</span> square = <span class="hljs-keyword">async</span> () =&gt; {
<span class="hljs-keyword">await</span> mouse.move(right(<span class="hljs-number">500</span>));
@@ -181,15 +189,12 @@
<span class="hljs-keyword">await</span> keyboard.releaseKey(Key.LeftSuper);
};
describe(<span class="hljs-string">"Basic test"</span>, () =&gt; {
it(<span class="hljs-string">"Should run a simple test"</span>, <span class="hljs-keyword">async</span> () =&gt; {
(<span class="hljs-keyword">async</span> () =&gt; {
<span class="hljs-keyword">await</span> square();
<span class="hljs-keyword">await</span> openSpotlight();
<span class="hljs-keyword">await</span> keyboard.type(<span class="hljs-string">"calculator"</span>);
<span class="hljs-keyword">await</span> keyboard.type(<span class="hljs-string">&quot;calculator&quot;</span>);
<span class="hljs-keyword">await</span> keyboard.type(Key.Return);
});
});
</code></pre>
})();</code></pre>
<a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
<h1>Installation</h1>
</a>
@@ -346,9 +351,6 @@ describe(<span class="hljs-string">"Basic test"</span>, () =&gt; {
<li class=" tsd-kind-class">
<a href="classes/clipboard.html" class="tsd-kind-icon">Clipboard</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/clipboardaction.html" class="tsd-kind-icon">Clipboard<wbr>Action</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/image.html" class="tsd-kind-icon">Image</a>
</li>
@@ -412,6 +414,9 @@ describe(<span class="hljs-string">"Basic test"</span>, () =&gt; {
<li class=" tsd-kind-class">
<a href="classes/windowaction.html" class="tsd-kind-icon">Window<wbr>Action</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/default.html" class="tsd-kind-icon">default</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/clipboardactionprovider.html" class="tsd-kind-icon">Clipboard<wbr>Action<wbr>Provider</a>
</li>
@@ -436,6 +441,9 @@ describe(<span class="hljs-string">"Basic test"</span>, () =&gt; {
<li class=" tsd-kind-interface">
<a href="interfaces/screenactionprovider.html" class="tsd-kind-icon">Screen<wbr>Action<wbr>Provider</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/timoutconfig.html" class="tsd-kind-icon">Timout<wbr>Config</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/windowactionprovider.html" class="tsd-kind-icon">Window<wbr>Action<wbr>Provider</a>
</li>
@@ -460,6 +468,9 @@ describe(<span class="hljs-string">"Basic test"</span>, () =&gt; {
<li class=" tsd-kind-function">
<a href="globals.html#createmovementapi" class="tsd-kind-icon">create<wbr>Movement<wbr>Api</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#createresultforinvalidsearch" class="tsd-kind-icon">create<wbr>Result<wbr>For<wbr>Invalid<wbr>Search</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#createwindowapi" class="tsd-kind-icon">create<wbr>Window<wbr>Api</a>
</li>
@@ -472,9 +483,6 @@ describe(<span class="hljs-string">"Basic test"</span>, () =&gt; {
<li class=" tsd-kind-function">
<a href="globals.html#determinescaledsearchregion" class="tsd-kind-icon">determine<wbr>Scaled<wbr>Search<wbr>Region</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#findedges" class="tsd-kind-icon">find<wbr>Edges</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#fromimagewithalphachannel" class="tsd-kind-icon">from<wbr>Image<wbr>With<wbr>Alpha<wbr>Channel</a>
</li>
@@ -550,11 +558,12 @@ describe(<span class="hljs-string">"Basic test"</span>, () =&gt; {
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/interfaces/__global.jest.matchers.html
+3 -3
View File
@@ -107,7 +107,7 @@
<div class="tsd-signature tsd-kind-icon">to<wbr>BeAt<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>position<span class="tsd-signature-symbol">: </span><a href="../classes/point.html" class="tsd-signature-type">Point</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-symbol">{}</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/expect/jest.matcher.function.ts#L10">expect/jest.matcher.function.ts:10</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/expect/jest.matcher.function.ts#L10">expect/jest.matcher.function.ts:10</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
@@ -140,7 +140,7 @@
<div class="tsd-signature tsd-kind-icon">to<wbr>BeIn<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>region<span class="tsd-signature-symbol">: </span><a href="../classes/region.html" class="tsd-signature-type">Region</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-symbol">{}</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/expect/jest.matcher.function.ts#L11">expect/jest.matcher.function.ts:11</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/expect/jest.matcher.function.ts#L11">expect/jest.matcher.function.ts:11</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
@@ -173,7 +173,7 @@
<div class="tsd-signature tsd-kind-icon">to<wbr>Show<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>needle<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, confidence<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-symbol">{}</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/expect/jest.matcher.function.ts#L12">expect/jest.matcher.function.ts:12</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/expect/jest.matcher.function.ts#L12">expect/jest.matcher.function.ts:12</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
docs/interfaces/clipboardactionprovider.html
+9 -8
View File
@@ -80,7 +80,7 @@
<section class="tsd-panel">
<h3>Implemented by</h3>
<ul class="tsd-hierarchy">
<li><a href="../classes/clipboardaction.html" class="tsd-signature-type">ClipboardAction</a></li>
<li><a href="../classes/default.html" class="tsd-signature-type">default</a></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
@@ -111,7 +111,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/clipboard-action-provider.interface.ts#L17">provider/native/clipboard-action-provider.interface.ts:17</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/clipboard-action-provider.interface.ts#L17">provider/native/clipboard-action-provider.interface.ts:17</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -134,7 +134,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/clipboard-action-provider.interface.ts#L24">provider/native/clipboard-action-provider.interface.ts:24</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/clipboard-action-provider.interface.ts#L24">provider/native/clipboard-action-provider.interface.ts:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -165,7 +165,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/clipboard-action-provider.interface.ts#L10">provider/native/clipboard-action-provider.interface.ts:10</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/clipboard-action-provider.interface.ts#L10">provider/native/clipboard-action-provider.interface.ts:10</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -188,7 +188,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/clipboard-action-provider.interface.ts#L31">provider/native/clipboard-action-provider.interface.ts:31</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/clipboard-action-provider.interface.ts#L31">provider/native/clipboard-action-provider.interface.ts:31</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -249,11 +249,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/interfaces/datasink.html
+5 -4
View File
@@ -113,7 +113,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/opencv/data-sink.interface.ts#L12">provider/opencv/data-sink.interface.ts:12</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/opencv/data-sink.interface.ts#L12">provider/opencv/data-sink.interface.ts:12</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -179,11 +179,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/interfaces/datasource.html
+5 -4
View File
@@ -113,7 +113,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/opencv/data-source.interface.ts#L11">provider/opencv/data-source.interface.ts:11</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/opencv/data-source.interface.ts#L11">provider/opencv/data-source.interface.ts:11</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -173,11 +173,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/interfaces/finderinterface.html
+6 -5
View File
@@ -115,7 +115,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/opencv/finder.interface.ts#L19">provider/opencv/finder.interface.ts:19</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/opencv/finder.interface.ts#L19">provider/opencv/finder.interface.ts:19</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -153,7 +153,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/opencv/finder.interface.ts#L29">provider/opencv/finder.interface.ts:29</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/opencv/finder.interface.ts#L29">provider/opencv/finder.interface.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -223,11 +223,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/interfaces/keyboardactionprovider.html
+9 -8
View File
@@ -112,7 +112,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/keyboard-action-provider.interface.ts#L26">provider/native/keyboard-action-provider.interface.ts:26</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/keyboard-action-provider.interface.ts#L26">provider/native/keyboard-action-provider.interface.ts:26</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -143,7 +143,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/keyboard-action-provider.interface.ts#L33">provider/native/keyboard-action-provider.interface.ts:33</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/keyboard-action-provider.interface.ts#L33">provider/native/keyboard-action-provider.interface.ts:33</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -174,7 +174,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/keyboard-action-provider.interface.ts#L40">provider/native/keyboard-action-provider.interface.ts:40</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/keyboard-action-provider.interface.ts#L40">provider/native/keyboard-action-provider.interface.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -205,7 +205,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/keyboard-action-provider.interface.ts#L12">provider/native/keyboard-action-provider.interface.ts:12</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/keyboard-action-provider.interface.ts#L12">provider/native/keyboard-action-provider.interface.ts:12</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -236,7 +236,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/keyboard-action-provider.interface.ts#L19">provider/native/keyboard-action-provider.interface.ts:19</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/keyboard-action-provider.interface.ts#L19">provider/native/keyboard-action-provider.interface.ts:19</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -308,11 +308,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/interfaces/mouseactionprovider.html
+16 -15
View File
@@ -119,7 +119,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/mouse-action-provider.interface.ts#L27">provider/native/mouse-action-provider.interface.ts:27</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/mouse-action-provider.interface.ts#L27">provider/native/mouse-action-provider.interface.ts:27</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -142,7 +142,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/mouse-action-provider.interface.ts#L32">provider/native/mouse-action-provider.interface.ts:32</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/mouse-action-provider.interface.ts#L32">provider/native/mouse-action-provider.interface.ts:32</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -164,7 +164,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/mouse-action-provider.interface.ts#L42">provider/native/mouse-action-provider.interface.ts:42</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/mouse-action-provider.interface.ts#L42">provider/native/mouse-action-provider.interface.ts:42</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -186,7 +186,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/mouse-action-provider.interface.ts#L77">provider/native/mouse-action-provider.interface.ts:77</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/mouse-action-provider.interface.ts#L77">provider/native/mouse-action-provider.interface.ts:77</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -217,7 +217,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/mouse-action-provider.interface.ts#L84">provider/native/mouse-action-provider.interface.ts:84</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/mouse-action-provider.interface.ts#L84">provider/native/mouse-action-provider.interface.ts:84</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -248,7 +248,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/mouse-action-provider.interface.ts#L37">provider/native/mouse-action-provider.interface.ts:37</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/mouse-action-provider.interface.ts#L37">provider/native/mouse-action-provider.interface.ts:37</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -270,7 +270,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/mouse-action-provider.interface.ts#L56">provider/native/mouse-action-provider.interface.ts:56</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/mouse-action-provider.interface.ts#L56">provider/native/mouse-action-provider.interface.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -301,7 +301,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/mouse-action-provider.interface.ts#L63">provider/native/mouse-action-provider.interface.ts:63</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/mouse-action-provider.interface.ts#L63">provider/native/mouse-action-provider.interface.ts:63</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -332,7 +332,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/mouse-action-provider.interface.ts#L70">provider/native/mouse-action-provider.interface.ts:70</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/mouse-action-provider.interface.ts#L70">provider/native/mouse-action-provider.interface.ts:70</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -363,7 +363,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/mouse-action-provider.interface.ts#L49">provider/native/mouse-action-provider.interface.ts:49</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/mouse-action-provider.interface.ts#L49">provider/native/mouse-action-provider.interface.ts:49</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -394,7 +394,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/mouse-action-provider.interface.ts#L13">provider/native/mouse-action-provider.interface.ts:13</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/mouse-action-provider.interface.ts#L13">provider/native/mouse-action-provider.interface.ts:13</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -425,7 +425,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/mouse-action-provider.interface.ts#L20">provider/native/mouse-action-provider.interface.ts:20</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/mouse-action-provider.interface.ts#L20">provider/native/mouse-action-provider.interface.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -518,11 +518,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/interfaces/movementapi.html
+9 -8
View File
@@ -106,7 +106,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/movement-api.interface.ts#L11">movement-api.interface.ts:11</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/movement-api.interface.ts#L11">movement-api.interface.ts:11</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -137,7 +137,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/movement-api.interface.ts#L16">movement-api.interface.ts:16</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/movement-api.interface.ts#L16">movement-api.interface.ts:16</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -168,7 +168,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/movement-api.interface.ts#L21">movement-api.interface.ts:21</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/movement-api.interface.ts#L21">movement-api.interface.ts:21</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -199,7 +199,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/movement-api.interface.ts#L26">movement-api.interface.ts:26</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/movement-api.interface.ts#L26">movement-api.interface.ts:26</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -230,7 +230,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/movement-api.interface.ts#L31">movement-api.interface.ts:31</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/movement-api.interface.ts#L31">movement-api.interface.ts:31</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -302,11 +302,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/interfaces/screenactionprovider.html
+10 -9
View File
@@ -118,7 +118,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/screen-action-provider.interface.ts#L16">provider/native/screen-action-provider.interface.ts:16</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/screen-action-provider.interface.ts#L16">provider/native/screen-action-provider.interface.ts:16</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -142,7 +142,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/screen-action-provider.interface.ts#L24">provider/native/screen-action-provider.interface.ts:24</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/screen-action-provider.interface.ts#L24">provider/native/screen-action-provider.interface.ts:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -174,7 +174,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/screen-action-provider.interface.ts#L33">provider/native/screen-action-provider.interface.ts:33</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/screen-action-provider.interface.ts#L33">provider/native/screen-action-provider.interface.ts:33</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -217,7 +217,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/screen-action-provider.interface.ts#L47">provider/native/screen-action-provider.interface.ts:47</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/screen-action-provider.interface.ts#L47">provider/native/screen-action-provider.interface.ts:47</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -240,7 +240,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/screen-action-provider.interface.ts#L54">provider/native/screen-action-provider.interface.ts:54</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/screen-action-provider.interface.ts#L54">provider/native/screen-action-provider.interface.ts:54</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -263,7 +263,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/screen-action-provider.interface.ts#L40">provider/native/screen-action-provider.interface.ts:40</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/screen-action-provider.interface.ts#L40">provider/native/screen-action-provider.interface.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -330,11 +330,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/interfaces/windowactionprovider.html
+8 -7
View File
@@ -116,7 +116,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/window-action-provider.interface.ts#L22">provider/native/window-action-provider.interface.ts:22</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/window-action-provider.interface.ts#L22">provider/native/window-action-provider.interface.ts:22</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -139,7 +139,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/window-action-provider.interface.ts#L36">provider/native/window-action-provider.interface.ts:36</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/window-action-provider.interface.ts#L36">provider/native/window-action-provider.interface.ts:36</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -168,7 +168,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/window-action-provider.interface.ts#L29">provider/native/window-action-provider.interface.ts:29</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/window-action-provider.interface.ts#L29">provider/native/window-action-provider.interface.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -197,7 +197,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/provider/native/window-action-provider.interface.ts#L15">provider/native/window-action-provider.interface.ts:15</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/provider/native/window-action-provider.interface.ts#L15">provider/native/window-action-provider.interface.ts:15</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -259,11 +259,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/interfaces/windowapi.html
+6 -5
View File
@@ -96,7 +96,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/window-api.interface.ts#L8">window-api.interface.ts:8</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/window-api.interface.ts#L8">window-api.interface.ts:8</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/window.html" class="tsd-signature-type">Window</a><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -113,7 +113,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/e2352ac/lib/window-api.interface.ts#L7">window-api.interface.ts:7</a></li>
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/window-api.interface.ts#L7">window-api.interface.ts:7</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../classes/window.html" class="tsd-signature-type">Window</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -162,11 +162,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/modules/__global.html
+4 -3
View File
@@ -107,11 +107,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
docs/modules/__global.jest.html
+4 -3
View File
@@ -113,11 +113,12 @@
<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-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>
<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-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<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>
lib/optionalsearchparameters.class.ts
+11 -8
View File
@@ -1,14 +1,17 @@
import { Region } from "./region.class";
import {Region} from "./region.class";
import {AbortSignal} from "node-abort-controller";
/**
* {@link OptionalSearchParameters} serves as a data class holding location parameters for image search
*/
export class OptionalSearchParameters {
/**
* {@link OptionalSearchParameters} class constructor
* @param searchRegion Optional {@link Region} to limit the search space to
* @param confidence Optional confidence value to configure image match confidence
* @param searchMultipleScales Optional flag to indicate if the search should be conducted at different scales
*/
constructor(public searchRegion?: Region, public confidence?: number, public searchMultipleScales?: boolean) {}
/**
* {@link OptionalSearchParameters} class constructor
* @param searchRegion Optional {@link Region} to limit the search space to
* @param confidence Optional confidence value to configure image match confidence
* @param searchMultipleScales Optional flag to indicate if the search should be conducted at different scales
* @param abort An {@link AbortSignal} to cancel an ongoing call to `waitFor`
*/
constructor(public searchRegion?: Region, public confidence?: number, public searchMultipleScales?: boolean, public abort?: AbortSignal) {
}
}
lib/screen.class.e2e.spec.ts
+118 -92
View File
@@ -1,112 +1,138 @@
import { existsSync } from "fs";
import { VisionAdapter } from "./adapter/vision.adapter.class";
import { FileType } from "./file-type.enum";
import { Screen } from "./screen.class";
import { sleep } from "./sleep.function";
import {existsSync} from "fs";
import {VisionAdapter} from "./adapter/vision.adapter.class";
import {FileType} from "./file-type.enum";
import {Screen} from "./screen.class";
import {sleep} from "./sleep.function";
import AbortController from "node-abort-controller";
describe("Screen.", () => {
it("should capture the screen", () => {
// GIVEN
const visionAdapter = new VisionAdapter();
const SUT = new Screen(visionAdapter);
it("should capture the screen", () => {
// GIVEN
const visionAdapter = new VisionAdapter();
const SUT = new Screen(visionAdapter);
// WHEN
SUT.capture("asdf", FileType.PNG).then(filename => {
// THEN
expect(filename).not.toBeNull();
sleep(1000).then(() => {
expect(existsSync(filename)).toBeTruthy();
});
// WHEN
SUT.capture("asdf", FileType.PNG).then(filename => {
// THEN
expect(filename).not.toBeNull();
sleep(1000).then(() => {
expect(existsSync(filename)).toBeTruthy();
});
});
});
});
it("should capture the screen and save to JPG", () => {
// GIVEN
const visionAdapter = new VisionAdapter();
const SUT = new Screen(visionAdapter);
it("should capture the screen and save to JPG", () => {
// GIVEN
const visionAdapter = new VisionAdapter();
const SUT = new Screen(visionAdapter);
// WHEN
SUT.capture("asdf", FileType.JPG).then(filename => {
// THEN
expect(filename).not.toBeNull();
sleep(1000).then(() => {
expect(existsSync(filename)).toBeTruthy();
});
// WHEN
SUT.capture("asdf", FileType.JPG).then(filename => {
// THEN
expect(filename).not.toBeNull();
sleep(1000).then(() => {
expect(existsSync(filename)).toBeTruthy();
});
});
});
});
it("should capture the screen and save file with prefix", () => {
// GIVEN
const visionAdapter = new VisionAdapter();
const SUT = new Screen(visionAdapter);
const prefix = "foo_";
it("should capture the screen and save file with prefix", () => {
// GIVEN
const visionAdapter = new VisionAdapter();
const SUT = new Screen(visionAdapter);
const prefix = "foo_";
// WHEN
SUT.capture("asdf", FileType.JPG, "./", prefix).then(filename => {
// THEN
expect(filename.includes(prefix)).toBeTruthy();
expect(filename).not.toBeNull();
sleep(1000).then(() => {
expect(existsSync(filename)).toBeTruthy();
});
// WHEN
SUT.capture("asdf", FileType.JPG, "./", prefix).then(filename => {
// THEN
expect(filename.includes(prefix)).toBeTruthy();
expect(filename).not.toBeNull();
sleep(1000).then(() => {
expect(existsSync(filename)).toBeTruthy();
});
});
});
});
it("should capture the screen and save file with postfix", () => {
// GIVEN
const visionAdapter = new VisionAdapter();
const SUT = new Screen(visionAdapter);
const postfix = "_bar";
it("should capture the screen and save file with postfix", () => {
// GIVEN
const visionAdapter = new VisionAdapter();
const SUT = new Screen(visionAdapter);
const postfix = "_bar";
// WHEN
SUT.capture("asdf", FileType.JPG, "./", "", postfix).then(filename => {
// THEN
expect(filename.includes(postfix)).toBeTruthy();
expect(filename).not.toBeNull();
sleep(1000).then(() => {
expect(existsSync(filename)).toBeTruthy();
});
// WHEN
SUT.capture("asdf", FileType.JPG, "./", "", postfix).then(filename => {
// THEN
expect(filename.includes(postfix)).toBeTruthy();
expect(filename).not.toBeNull();
sleep(1000).then(() => {
expect(existsSync(filename)).toBeTruthy();
});
});
});
});
it("should capture the screen and save file with pre- and postfix", () => {
// GIVEN
const visionAdapter = new VisionAdapter();
const SUT = new Screen(visionAdapter);
const filename = "asdf";
const prefix = "foo_";
const postfix = "_bar";
it("should capture the screen and save file with pre- and postfix", () => {
// GIVEN
const visionAdapter = new VisionAdapter();
const SUT = new Screen(visionAdapter);
const filename = "asdf";
const prefix = "foo_";
const postfix = "_bar";
// WHEN
SUT.capture("asdf", FileType.JPG, "./", prefix, postfix).then(output => {
// THEN
expect(output.includes(`${prefix}${filename}${postfix}`)).toBeTruthy();
expect(output).not.toBeNull();
sleep(1000).then(() => {
expect(existsSync(output)).toBeTruthy();
});
// WHEN
SUT.capture("asdf", FileType.JPG, "./", prefix, postfix).then(output => {
// THEN
expect(output.includes(`${prefix}${filename}${postfix}`)).toBeTruthy();
expect(output).not.toBeNull();
sleep(1000).then(() => {
expect(existsSync(output)).toBeTruthy();
});
});
});
});
it("should reject after timeout", async () => {
// GIVEN
jest.setTimeout(10000);
const timeout = 5000;
const visionAdapter = new VisionAdapter();
const SUT = new Screen(visionAdapter);
SUT.config.resourceDirectory = "./e2e/assets";
it("should reject after timeout", async () => {
// GIVEN
jest.setTimeout(10000);
const timeout = 5000;
const visionAdapter = new VisionAdapter();
const SUT = new Screen(visionAdapter);
SUT.config.resourceDirectory = "./e2e/assets";
// WHEN
const start = Date.now();
try {
await SUT.waitFor("calculator.png", timeout);
} catch (e) {
// THEN
expect(e).toBe(`Action timed out after ${timeout} ms`);
}
const end = Date.now();
// WHEN
const start = Date.now();
try {
await SUT.waitFor("calculator.png", timeout);
} catch (e) {
// THEN
expect(e).toBe(`Action timed out after ${timeout} ms`);
}
const end = Date.now();
// THEN
expect(end - start).toBeGreaterThanOrEqual(timeout);
});
// THEN
expect(end - start).toBeGreaterThanOrEqual(timeout);
});
it("should abort via signal", (done) => {
// GIVEN
jest.setTimeout(10000);
const timeout = 5000;
const abortAfterMs = 1000;
const controller = new AbortController();
const signal = controller.signal;
const visionAdapter = new VisionAdapter();
const SUT = new Screen(visionAdapter);
SUT.config.resourceDirectory = "./e2e/assets";
// WHEN
const start = Date.now();
SUT.waitFor("calculator.png", timeout, {abort: signal}).catch(e => {
const end = Date.now();
// THEN
expect(e).toBe(`Action aborted by signal`);
expect(end - start).toBeGreaterThanOrEqual(abortAfterMs);
expect(end - start).toBeLessThan(timeout);
done();
});
setTimeout(() => controller.abort(), abortAfterMs);
});
});
lib/screen.class.ts
+9 -9
View File
@@ -7,8 +7,8 @@ import {LocationParameters} from "./locationparameters.class";
import {MatchRequest} from "./match-request.class";
import {MatchResult} from "./match-result.class";
import {Region} from "./region.class";
import {timeout} from "./util/poll-action.function";
import { Image } from "./image.class";
import {timeout} from "./util/timeout.function";
import {Image} from "./image.class";
export type FindHookCallback = (target: MatchResult) => Promise<void>;
@@ -101,16 +101,16 @@ export class Screen {
);
function validateSearchRegion(search: Region, screen: Region) {
if ( search.left < 0 || search.top < 0 || search.width < 0 || search.height < 0 ) {
if (search.left < 0 || search.top < 0 || search.width < 0 || search.height < 0) {
throw new Error(`Negative values in search region ${search}`)
}
if ( isNaN(search.left) || isNaN(search.top) || isNaN(search.width) || isNaN(search.height) ) {
if (isNaN(search.left) || isNaN(search.top) || isNaN(search.width) || isNaN(search.height)) {
throw new Error(`NaN values in search region ${search}`)
}
if ( search.width < 2 || search.height < 2 ) {
if (search.width < 2 || search.height < 2) {
throw new Error(`Search region ${search} is not large enough. Must be at least two pixels in both width and height.`)
}
if ( search.left + search.width > screen.width || search.top + search.height > screen.height ) {
if (search.left + search.width > screen.width || search.top + search.height > screen.height) {
throw new Error(`Search region ${search} extends beyond screen boundaries (${screen.width}x${screen.height})`)
}
}
@@ -171,7 +171,7 @@ export class Screen {
timeoutMs: number = 5000,
params?: LocationParameters,
): Promise<Region> {
return timeout(500, timeoutMs, () => this.find(templateImageFilename, params));
return timeout(500, timeoutMs, () => this.find(templateImageFilename, params), {signal: params?.abort});
}
/**
@@ -239,8 +239,8 @@ export class Screen {
fileName: string,
fileFormat: FileType,
filePath: string,
fileNamePrefix: string ,
fileNamePostfix: string){
fileNamePrefix: string,
fileNamePostfix: string) {
const outputPath = generateOutputPath(fileName, {
path: filePath,
postfix: fileNamePostfix,
lib/util/poll-action.function.ts
-45
View File
@@ -1,45 +0,0 @@
export function timeout<R>(updateIntervalMs: number, maxDurationMs: number, action: (...params: any) => Promise<R>): Promise<R> {
return new Promise<R>((resolve, reject) => {
let interval: NodeJS.Timeout;
let timerCleaned = false
function executeInterval() {
action().then(validateResult).catch(handleRejection);
}
function validateResult(result: R){
if (!result && !timerCleaned) {
interval = setTimeout(executeInterval, updateIntervalMs);
} else {
cleanupTimer();
resolve(result);
}
}
function handleRejection() {
if(!timerCleaned){
interval = setTimeout(executeInterval, updateIntervalMs);
}
}
function cleanupTimer(){
timerCleaned = true
if(maxTimeout){
clearTimeout(maxTimeout);
}
if(interval){
clearTimeout(interval);
}
}
const maxTimeout = setTimeout(
() => {
cleanupTimer();
reject(`Action timed out after ${maxDurationMs} ms`);
},
maxDurationMs
);
executeInterval()
});
}
lib/util/poll-action.function.spec.ts → lib/util/timeout.function.spec.ts
+25 -2
View File
@@ -1,6 +1,7 @@
import {timeout} from "./poll-action.function";
import {timeout} from "./timeout.function";
import AbortController from "node-abort-controller";
describe("poll-action", () => {
describe("timeout", () => {
it("should timeout after maxDuration if action rejects", async () => {
// GIVEN
const updateInterval = 200;
@@ -160,4 +161,26 @@ describe("poll-action", () => {
done();
}, 500);
});
it("should be externally abortable", async () => {
// GIVEN
const controller = new AbortController();
const signal = controller.signal;
const updateInterval = 100;
const maxDuration = 3000;
const action = jest.fn(() => {
return new Promise<boolean>((_, reject) => {
setTimeout(() => {
reject((undefined as unknown) as boolean);
}, 20);
});
});
// WHEN
const SUT = timeout(updateInterval, maxDuration, action, {signal});
setTimeout(() => controller.abort(), 1000);
// THEN
await expect(SUT).rejects.toBe(`Action aborted by signal`);
});
});
lib/util/timeout.function.ts
+58
View File
@@ -0,0 +1,58 @@
import {AbortSignal} from "node-abort-controller";
export interface TimoutConfig {
signal?: AbortSignal
}
export function timeout<R>(updateIntervalMs: number, maxDurationMs: number, action: (...params: any) => Promise<R>, config?: TimoutConfig): Promise<R> {
return new Promise<R>((resolve, reject) => {
let interval: NodeJS.Timeout;
let timerCleaned = false
if (config?.signal) {
config.signal.onabort = () => {
cleanupTimer();
reject(`Action aborted by signal`);
}
}
function executeInterval() {
action().then(validateResult).catch(handleRejection);
}
function validateResult(result: R) {
if (!result && !timerCleaned) {
interval = setTimeout(executeInterval, updateIntervalMs);
} else {
cleanupTimer();
resolve(result);
}
}
function handleRejection() {
if (!timerCleaned) {
interval = setTimeout(executeInterval, updateIntervalMs);
}
}
function cleanupTimer() {
timerCleaned = true
if (maxTimeout) {
clearTimeout(maxTimeout);
}
if (interval) {
clearTimeout(interval);
}
}
const maxTimeout = setTimeout(
() => {
cleanupTimer();
reject(`Action timed out after ${maxDurationMs} ms`);
},
maxDurationMs
);
executeInterval()
});
}
package-lock.json
Generated
+5
View File
@@ -5297,6 +5297,11 @@
"semver": "^5.4.1"
}
},
"node-abort-controller": {
"version": "2.0.0",
"resolved": "https://registry.npmjs.org/node-abort-controller/-/node-abort-controller-2.0.0.tgz",
"integrity": "sha512-L8RfEgjBTHAISTuagw51PprVAqNZoG6KSB6LQ6H1bskMVkFs5E71IyjauLBv3XbuomJlguWF/VnRHdJ1gqiAqA=="
},
"node-addon-api": {
"version": "3.0.0",
"resolved": "https://registry.npmjs.org/node-addon-api/-/node-addon-api-3.0.0.tgz",
package.json
+1
View File
@@ -62,6 +62,7 @@
"dependencies": {
"@nut-tree/libnut": "2.1.1",
"clipboardy": "2.0.0",
"node-abort-controller": "^2.0.0",
"opencv4nodejs-prebuilt": "5.3.1"
},
"devDependencies": {