Skip to content

Commit fa788ce

Browse files
s1hofmanns1hofmann
committed
(#87) Generated API docs
1 parent f1c6e47 commit fa788ce

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+17612
-0
lines changed

Diff for: ‎docs/assets/css/main.css

+2,333
Large diffs are not rendered by default.

Diff for: ‎docs/assets/images/icons.png

9.39 KB
Loading

Diff for: ‎docs/assets/images/[email protected]

27.5 KB
Loading

Diff for: ‎docs/assets/images/widgets.png

480 Bytes
Loading

Diff for: ‎docs/assets/images/[email protected]

855 Bytes
Loading

Diff for: ‎docs/assets/js/main.js

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: ‎docs/assets/js/search.js

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: ‎docs/classes/assert.html

+280
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,280 @@
1+
<!doctype html>
2+
<html class="default no-js">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<title>Assert | @nut-tree/nut-js</title>
7+
<meta name="description" content="">
8+
<meta name="viewport" content="width=device-width, initial-scale=1">
9+
<link rel="stylesheet" href="../assets/css/main.css">
10+
</head>
11+
<body>
12+
<header>
13+
<div class="tsd-page-toolbar">
14+
<div class="container">
15+
<div class="table-wrap">
16+
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
17+
<div class="field">
18+
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19+
<input id="tsd-search-field" type="text" />
20+
</div>
21+
<ul class="results">
22+
<li class="state loading">Preparing search index...</li>
23+
<li class="state failure">The search index is not available</li>
24+
</ul>
25+
<a href="../index.html" class="title">@nut-tree/nut-js</a>
26+
</div>
27+
<div class="table-cell" id="tsd-widgets">
28+
<div id="tsd-filter">
29+
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30+
<div class="tsd-filter-group">
31+
<div class="tsd-select" id="tsd-filter-visibility">
32+
<span class="tsd-select-label">All</span>
33+
<ul class="tsd-select-list">
34+
<li data-value="public">Public</li>
35+
<li data-value="protected">Public/Protected</li>
36+
<li data-value="private" class="selected">All</li>
37+
</ul>
38+
</div>
39+
<input type="checkbox" id="tsd-filter-inherited" checked />
40+
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41+
<input type="checkbox" id="tsd-filter-only-exported" />
42+
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
43+
</div>
44+
</div>
45+
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
46+
</div>
47+
</div>
48+
</div>
49+
</div>
50+
<div class="tsd-page-title">
51+
<div class="container">
52+
<ul class="tsd-breadcrumb">
53+
<li>
54+
<a href="../globals.html">Globals</a>
55+
</li>
56+
<li>
57+
<a href="assert.html">Assert</a>
58+
</li>
59+
</ul>
60+
<h1>Class Assert</h1>
61+
</div>
62+
</div>
63+
</header>
64+
<div class="container container-main">
65+
<div class="row">
66+
<div class="col-8 col-content">
67+
<section class="tsd-panel tsd-hierarchy">
68+
<h3>Hierarchy</h3>
69+
<ul class="tsd-hierarchy">
70+
<li>
71+
<span class="target">Assert</span>
72+
</li>
73+
</ul>
74+
</section>
75+
<section class="tsd-panel-group tsd-index-group">
76+
<h2>Index</h2>
77+
<section class="tsd-panel tsd-index-panel">
78+
<div class="tsd-index-content">
79+
<section class="tsd-index-section ">
80+
<h3>Constructors</h3>
81+
<ul class="tsd-index-list">
82+
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="assert.html#constructor" class="tsd-kind-icon">constructor</a></li>
83+
</ul>
84+
</section>
85+
<section class="tsd-index-section ">
86+
<h3>Methods</h3>
87+
<ul class="tsd-index-list">
88+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="assert.html#isvisible" class="tsd-kind-icon">is<wbr>Visible</a></li>
89+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="assert.html#notvisible" class="tsd-kind-icon">not<wbr>Visible</a></li>
90+
</ul>
91+
</section>
92+
</div>
93+
</section>
94+
</section>
95+
<section class="tsd-panel-group tsd-member-group ">
96+
<h2>Constructors</h2>
97+
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
98+
<a name="constructor" class="tsd-anchor"></a>
99+
<h3>constructor</h3>
100+
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
101+
<li class="tsd-signature tsd-kind-icon">new <wbr>Assert<span class="tsd-signature-symbol">(</span>screen<span class="tsd-signature-symbol">: </span><a href="screen.html" class="tsd-signature-type">Screen</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="assert.html" class="tsd-signature-type">Assert</a></li>
102+
</ul>
103+
<ul class="tsd-descriptions">
104+
<li class="tsd-description">
105+
<aside class="tsd-sources">
106+
<ul>
107+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/assert.class.ts#L5">assert.class.ts:5</a></li>
108+
</ul>
109+
</aside>
110+
<h4 class="tsd-parameters-title">Parameters</h4>
111+
<ul class="tsd-parameters">
112+
<li>
113+
<h5>screen: <a href="screen.html" class="tsd-signature-type">Screen</a></h5>
114+
</li>
115+
</ul>
116+
<h4 class="tsd-returns-title">Returns <a href="assert.html" class="tsd-signature-type">Assert</a></h4>
117+
</li>
118+
</ul>
119+
</section>
120+
</section>
121+
<section class="tsd-panel-group tsd-member-group ">
122+
<h2>Methods</h2>
123+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
124+
<a name="isvisible" class="tsd-anchor"></a>
125+
<h3>is<wbr>Visible</h3>
126+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
127+
<li class="tsd-signature tsd-kind-icon">is<wbr>Visible<span class="tsd-signature-symbol">(</span>pathToNeedle<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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><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>
128+
</ul>
129+
<ul class="tsd-descriptions">
130+
<li class="tsd-description">
131+
<aside class="tsd-sources">
132+
<ul>
133+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/assert.class.ts#L8">assert.class.ts:8</a></li>
134+
</ul>
135+
</aside>
136+
<h4 class="tsd-parameters-title">Parameters</h4>
137+
<ul class="tsd-parameters">
138+
<li>
139+
<h5>pathToNeedle: <span class="tsd-signature-type">string</span></h5>
140+
</li>
141+
<li>
142+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> searchRegion: <a href="region.html" class="tsd-signature-type">Region</a></h5>
143+
</li>
144+
<li>
145+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> confidence: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
146+
</li>
147+
</ul>
148+
<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>
149+
</li>
150+
</ul>
151+
</section>
152+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
153+
<a name="notvisible" class="tsd-anchor"></a>
154+
<h3>not<wbr>Visible</h3>
155+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
156+
<li class="tsd-signature tsd-kind-icon">not<wbr>Visible<span class="tsd-signature-symbol">(</span>pathToNeedle<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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><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>
157+
</ul>
158+
<ul class="tsd-descriptions">
159+
<li class="tsd-description">
160+
<aside class="tsd-sources">
161+
<ul>
162+
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/f1c6e47/lib/assert.class.ts#L25">assert.class.ts:25</a></li>
163+
</ul>
164+
</aside>
165+
<h4 class="tsd-parameters-title">Parameters</h4>
166+
<ul class="tsd-parameters">
167+
<li>
168+
<h5>pathToNeedle: <span class="tsd-signature-type">string</span></h5>
169+
</li>
170+
<li>
171+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> searchRegion: <a href="region.html" class="tsd-signature-type">Region</a></h5>
172+
</li>
173+
<li>
174+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> confidence: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
175+
</li>
176+
</ul>
177+
<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>
178+
</li>
179+
</ul>
180+
</section>
181+
</section>
182+
</div>
183+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
184+
<nav class="tsd-navigation primary">
185+
<ul>
186+
<li class="globals ">
187+
<a href="../globals.html"><em>Globals</em></a>
188+
</li>
189+
</ul>
190+
</nav>
191+
<nav class="tsd-navigation secondary menu-sticky">
192+
<ul class="before-current">
193+
</ul>
194+
<ul class="current">
195+
<li class="current tsd-kind-class">
196+
<a href="assert.html" class="tsd-kind-icon">Assert</a>
197+
<ul>
198+
<li class=" tsd-kind-constructor tsd-parent-kind-class">
199+
<a href="assert.html#constructor" class="tsd-kind-icon">constructor</a>
200+
</li>
201+
<li class=" tsd-kind-method tsd-parent-kind-class">
202+
<a href="assert.html#isvisible" class="tsd-kind-icon">is<wbr>Visible</a>
203+
</li>
204+
<li class=" tsd-kind-method tsd-parent-kind-class">
205+
<a href="assert.html#notvisible" class="tsd-kind-icon">not<wbr>Visible</a>
206+
</li>
207+
</ul>
208+
</li>
209+
</ul>
210+
<ul class="after-current">
211+
</ul>
212+
</nav>
213+
</div>
214+
</div>
215+
</div>
216+
<footer>
217+
<div class="container">
218+
<h2>Legend</h2>
219+
<div class="tsd-legend-group">
220+
<ul class="tsd-legend">
221+
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
222+
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
223+
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
224+
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
225+
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
226+
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
227+
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
228+
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
229+
</ul>
230+
<ul class="tsd-legend">
231+
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
232+
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
233+
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
234+
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
235+
</ul>
236+
<ul class="tsd-legend">
237+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
238+
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
239+
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
240+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
241+
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
242+
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
243+
</ul>
244+
<ul class="tsd-legend">
245+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
246+
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
247+
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
248+
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
249+
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
250+
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
251+
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
252+
</ul>
253+
<ul class="tsd-legend">
254+
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
255+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
256+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
257+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
258+
</ul>
259+
<ul class="tsd-legend">
260+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
261+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
262+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
263+
</ul>
264+
<ul class="tsd-legend">
265+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
266+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
267+
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
268+
</ul>
269+
<ul class="tsd-legend">
270+
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
271+
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
272+
</ul>
273+
</div>
274+
</div>
275+
</footer>
276+
<div class="overlay"></div>
277+
<script src="../assets/js/main.js"></script>
278+
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
279+
</body>
280+
</html>

0 commit comments

Comments
 (0)