Skip to content

Commit ea3d48d

Browse files
author
Mengqi Yu
authored
upgrade typedoc (#339)
1 parent 1b4463a commit ea3d48d

37 files changed

+5784
-7771
lines changed

‎docs/api/assets/css/main.css‎

Lines changed: 1796 additions & 1457 deletions
Large diffs are not rendered by default.

‎docs/api/assets/js/main.js‎

Lines changed: 248 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/api/assets/js/search.js‎

Lines changed: 1 addition & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/api/classes/_errors_.functionconfigerror.html‎

Lines changed: 0 additions & 308 deletions
This file was deleted.

‎docs/api/classes/_testing_.testrunner.html‎

Lines changed: 0 additions & 375 deletions
This file was deleted.

‎docs/api/classes/_types_.resourcelist.html‎

Lines changed: 0 additions & 389 deletions
This file was deleted.

‎docs/api/classes/errors.functionconfigerror.html‎

Lines changed: 200 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,200 @@
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>FunctionConfigError | kpt-functions</title>
7+
<meta name="description" content="Documentation for kpt-functions">
8+
<meta name="viewport" content="width=device-width, initial-scale=1">
9+
<link rel="stylesheet" href="../assets/css/main.css">
10+
<script async src="../assets/js/search.js" id="search-script"></script>
11+
</head>
12+
<body>
13+
<header>
14+
<div class="tsd-page-toolbar">
15+
<div class="container">
16+
<div class="table-wrap">
17+
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18+
<div class="field">
19+
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20+
<input id="tsd-search-field" type="text" />
21+
</div>
22+
<ul class="results">
23+
<li class="state loading">Preparing search index...</li>
24+
<li class="state failure">The search index is not available</li>
25+
</ul>
26+
<a href="../index.html" class="title">kpt-functions</a>
27+
</div>
28+
<div class="table-cell" id="tsd-widgets">
29+
<div id="tsd-filter">
30+
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31+
<div class="tsd-filter-group">
32+
<div class="tsd-select" id="tsd-filter-visibility">
33+
<span class="tsd-select-label">All</span>
34+
<ul class="tsd-select-list">
35+
<li data-value="public">Public</li>
36+
<li data-value="protected">Public/Protected</li>
37+
<li data-value="private" class="selected">All</li>
38+
</ul>
39+
</div>
40+
<input type="checkbox" id="tsd-filter-inherited" checked />
41+
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42+
</div>
43+
</div>
44+
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
45+
</div>
46+
</div>
47+
</div>
48+
</div>
49+
<div class="tsd-page-title">
50+
<div class="container">
51+
<ul class="tsd-breadcrumb">
52+
<li>
53+
<a href="../index.html">kpt-functions</a>
54+
</li>
55+
<li>
56+
<a href="../modules/errors.html">errors</a>
57+
</li>
58+
<li>
59+
<a href="errors.functionconfigerror.html">FunctionConfigError</a>
60+
</li>
61+
</ul>
62+
<h1>Class FunctionConfigError</h1>
63+
</div>
64+
</div>
65+
</header>
66+
<div class="container container-main">
67+
<div class="row">
68+
<div class="col-8 col-content">
69+
<section class="tsd-panel tsd-comment">
70+
<div class="tsd-comment tsd-typography">
71+
<div class="lead">
72+
<p>Represents an error with the functionConfig used to parametrize the function.</p>
73+
</div>
74+
</div>
75+
</section>
76+
<section class="tsd-panel tsd-hierarchy">
77+
<h3>Hierarchy</h3>
78+
<ul class="tsd-hierarchy">
79+
<li>
80+
<span class="tsd-signature-type">Error</span>
81+
<ul class="tsd-hierarchy">
82+
<li>
83+
<span class="target">FunctionConfigError</span>
84+
</li>
85+
</ul>
86+
</li>
87+
</ul>
88+
</section>
89+
<section class="tsd-panel-group tsd-index-group">
90+
<h2>Index</h2>
91+
<section class="tsd-panel tsd-index-panel">
92+
<div class="tsd-index-content">
93+
<section class="tsd-index-section ">
94+
<h3>Constructors</h3>
95+
<ul class="tsd-index-list">
96+
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="errors.functionconfigerror.html#constructor" class="tsd-kind-icon">constructor</a></li>
97+
</ul>
98+
</section>
99+
</div>
100+
</section>
101+
</section>
102+
<section class="tsd-panel-group tsd-member-group ">
103+
<h2>Constructors</h2>
104+
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
105+
<a name="constructor" class="tsd-anchor"></a>
106+
<h3>constructor</h3>
107+
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
108+
<li class="tsd-signature tsd-kind-icon">new <wbr>Function<wbr>Config<wbr>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="errors.functionconfigerror.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionConfigError</a></li>
109+
</ul>
110+
<ul class="tsd-descriptions">
111+
<li class="tsd-description">
112+
<aside class="tsd-sources">
113+
<p>Overrides Error.constructor</p>
114+
<ul>
115+
<li>Defined in <a href="https://github.com/mengqiy/kpt-functions-sdk/blob/5bbba38/ts/kpt-functions/src/errors.ts#L20">errors.ts:20</a></li>
116+
</ul>
117+
</aside>
118+
<h4 class="tsd-parameters-title">Parameters</h4>
119+
<ul class="tsd-parameters">
120+
<li>
121+
<h5>message: <span class="tsd-signature-type">string</span></h5>
122+
</li>
123+
</ul>
124+
<h4 class="tsd-returns-title">Returns <a href="errors.functionconfigerror.html" class="tsd-signature-type" data-tsd-kind="Class">FunctionConfigError</a></h4>
125+
</li>
126+
</ul>
127+
</section>
128+
</section>
129+
</div>
130+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
131+
<nav class="tsd-navigation primary">
132+
<ul>
133+
<li class=" ">
134+
<a href="../index.html">Modules</a>
135+
</li>
136+
<li class="current tsd-kind-module">
137+
<a href="../modules/errors.html">errors</a>
138+
</li>
139+
<li class=" tsd-kind-module">
140+
<a href="../modules/metadata.html">metadata</a>
141+
</li>
142+
<li class=" tsd-kind-module">
143+
<a href="../modules/result.html">result</a>
144+
</li>
145+
<li class=" tsd-kind-module">
146+
<a href="../modules/run.html">run</a>
147+
</li>
148+
<li class=" tsd-kind-module">
149+
<a href="../modules/testing.html">testing</a>
150+
</li>
151+
<li class=" tsd-kind-module">
152+
<a href="../modules/types.html">types</a>
153+
</li>
154+
</ul>
155+
</nav>
156+
<nav class="tsd-navigation secondary menu-sticky">
157+
<ul class="before-current">
158+
</ul>
159+
<ul class="current">
160+
<li class="current tsd-kind-class tsd-parent-kind-module">
161+
<a href="errors.functionconfigerror.html" class="tsd-kind-icon">Function<wbr>Config<wbr>Error</a>
162+
<ul>
163+
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
164+
<a href="errors.functionconfigerror.html#constructor" class="tsd-kind-icon">constructor</a>
165+
</li>
166+
</ul>
167+
</li>
168+
</ul>
169+
<ul class="after-current">
170+
</ul>
171+
</nav>
172+
</div>
173+
</div>
174+
</div>
175+
<footer class="with-border-bottom">
176+
<div class="container">
177+
<h2>Legend</h2>
178+
<div class="tsd-legend-group">
179+
<ul class="tsd-legend">
180+
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
181+
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
182+
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
183+
</ul>
184+
<ul class="tsd-legend">
185+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
186+
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
187+
</ul>
188+
<ul class="tsd-legend">
189+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
190+
</ul>
191+
</div>
192+
</div>
193+
</footer>
194+
<div class="container tsd-generator">
195+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
196+
</div>
197+
<div class="overlay"></div>
198+
<script src="../assets/js/main.js"></script>
199+
</body>
200+
</html>

0 commit comments

Comments
 (0)