Skip to content

Commit 8d326af

Browse files
frankfarzanfrankfarzan
committed
Regenerate docs for kpt-functions
1 parent fcf775f commit 8d326af

13 files changed

+566
-67
lines changed

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

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

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

Lines changed: 131 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ <h1>Class ConfigError</h1>
6868
<section class="tsd-panel tsd-comment">
6969
<div class="tsd-comment tsd-typography">
7070
<div class="lead">
71-
<p>Base class that represent a configuration-related error.</p>
71+
<p>Base class that represent a configuration issue.</p>
7272
</div>
7373
<p>Typically you should use one of the more specific child classes.</p>
7474
</div>
@@ -82,15 +82,15 @@ <h3>Hierarchy</h3>
8282
<li>
8383
<span class="target">ConfigError</span>
8484
<ul class="tsd-hierarchy">
85-
<li>
86-
<a href="_errors_.multiconfigerror.html" class="tsd-signature-type">MultiConfigError</a>
87-
</li>
8885
<li>
8986
<a href="_errors_.configfileerror.html" class="tsd-signature-type">ConfigFileError</a>
9087
</li>
9188
<li>
9289
<a href="_errors_.kubernetesobjecterror.html" class="tsd-signature-type">KubernetesObjectError</a>
9390
</li>
91+
<li>
92+
<a href="_errors_.multiconfigerror.html" class="tsd-signature-type">MultiConfigError</a>
93+
</li>
9494
</ul>
9595
</li>
9696
</ul>
@@ -112,10 +112,20 @@ <h3>Properties</h3>
112112
<ul class="tsd-index-list">
113113
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_errors_.configerror.html#message" class="tsd-kind-icon">message</a></li>
114114
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_errors_.configerror.html#name" class="tsd-kind-icon">name</a></li>
115+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_errors_.configerror.html#severity" class="tsd-kind-icon">severity</a></li>
115116
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"><a href="_errors_.configerror.html#stack" class="tsd-kind-icon">stack</a></li>
117+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_errors_.configerror.html#tags" class="tsd-kind-icon">tags</a></li>
116118
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_errors_.configerror.html#error" class="tsd-kind-icon">Error</a></li>
117119
</ul>
118120
</section>
121+
<section class="tsd-index-section ">
122+
<h3>Methods</h3>
123+
<ul class="tsd-index-list">
124+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_errors_.configerror.html#log" class="tsd-kind-icon">log</a></li>
125+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_errors_.configerror.html#toresults" class="tsd-kind-icon">to<wbr>Results</a></li>
126+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_errors_.configerror.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li>
127+
</ul>
128+
</section>
119129
</div>
120130
</section>
121131
</section>
@@ -125,20 +135,28 @@ <h2>Constructors</h2>
125135
<a name="constructor" class="tsd-anchor"></a>
126136
<h3>constructor</h3>
127137
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
128-
<li class="tsd-signature tsd-kind-icon">new <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_.configerror.html" class="tsd-signature-type">ConfigError</a></li>
138+
<li class="tsd-signature tsd-kind-icon">new <wbr>Config<wbr>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, severity<span class="tsd-signature-symbol">?: </span><a href="../modules/_types_.html#severity" class="tsd-signature-type">Severity</a>, tags<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_errors_.configerror.html" class="tsd-signature-type">ConfigError</a></li>
129139
</ul>
130140
<ul class="tsd-descriptions">
131141
<li class="tsd-description">
132142
<aside class="tsd-sources">
133143
<ul>
134-
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/3a40b95/ts/kpt-functions/src/errors.ts#L25">src/errors.ts:25</a></li>
144+
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/fcf775f/ts/kpt-functions/src/errors.ts#L29">src/errors.ts:29</a></li>
135145
</ul>
136146
</aside>
147+
<div class="tsd-comment tsd-typography">
148+
</div>
137149
<h4 class="tsd-parameters-title">Parameters</h4>
138150
<ul class="tsd-parameters">
139151
<li>
140152
<h5>message: <span class="tsd-signature-type">string</span></h5>
141153
</li>
154+
<li>
155+
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> severity: <a href="../modules/_types_.html#severity" class="tsd-signature-type">Severity</a><span class="tsd-signature-symbol"> = &quot;error&quot;</span></h5>
156+
</li>
157+
<li>
158+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> tags: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{}</span></h5>
159+
</li>
142160
</ul>
143161
<h4 class="tsd-returns-title">Returns <a href="_errors_.configerror.html" class="tsd-signature-type">ConfigError</a></h4>
144162
</li>
@@ -169,6 +187,16 @@ <h3>name</h3>
169187
</ul>
170188
</aside>
171189
</section>
190+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
191+
<a name="severity" class="tsd-anchor"></a>
192+
<h3>severity</h3>
193+
<div class="tsd-signature tsd-kind-icon">severity<span class="tsd-signature-symbol">:</span> <a href="../modules/_types_.html#severity" class="tsd-signature-type">Severity</a></div>
194+
<aside class="tsd-sources">
195+
<ul>
196+
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/fcf775f/ts/kpt-functions/src/errors.ts#L37">src/errors.ts:37</a></li>
197+
</ul>
198+
</aside>
199+
</section>
172200
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited">
173201
<a name="stack" class="tsd-anchor"></a>
174202
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
@@ -181,6 +209,16 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
181209
</ul>
182210
</aside>
183211
</section>
212+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
213+
<a name="tags" class="tsd-anchor"></a>
214+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> tags</h3>
215+
<div class="tsd-signature tsd-kind-icon">tags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{}</span></div>
216+
<aside class="tsd-sources">
217+
<ul>
218+
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/fcf775f/ts/kpt-functions/src/errors.ts#L38">src/errors.ts:38</a></li>
219+
</ul>
220+
</aside>
221+
</section>
184222
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
185223
<a name="error" class="tsd-anchor"></a>
186224
<h3><span class="tsd-flag ts-flagStatic">Static</span> Error</h3>
@@ -192,6 +230,75 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> Error</h3>
192230
</aside>
193231
</section>
194232
</section>
233+
<section class="tsd-panel-group tsd-member-group ">
234+
<h2>Methods</h2>
235+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
236+
<a name="log" class="tsd-anchor"></a>
237+
<h3>log</h3>
238+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
239+
<li class="tsd-signature tsd-kind-icon">log<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
240+
</ul>
241+
<ul class="tsd-descriptions">
242+
<li class="tsd-description">
243+
<aside class="tsd-sources">
244+
<ul>
245+
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/fcf775f/ts/kpt-functions/src/errors.ts#L67">src/errors.ts:67</a></li>
246+
</ul>
247+
</aside>
248+
<div class="tsd-comment tsd-typography">
249+
<div class="lead">
250+
<p>Logs issue to stderr.</p>
251+
</div>
252+
</div>
253+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
254+
</li>
255+
</ul>
256+
</section>
257+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
258+
<a name="toresults" class="tsd-anchor"></a>
259+
<h3>to<wbr>Results</h3>
260+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
261+
<li class="tsd-signature tsd-kind-icon">to<wbr>Results<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_types_.result.html" class="tsd-signature-type">Result</a><span class="tsd-signature-symbol">[]</span></li>
262+
</ul>
263+
<ul class="tsd-descriptions">
264+
<li class="tsd-description">
265+
<aside class="tsd-sources">
266+
<ul>
267+
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/fcf775f/ts/kpt-functions/src/errors.ts#L47">src/errors.ts:47</a></li>
268+
</ul>
269+
</aside>
270+
<div class="tsd-comment tsd-typography">
271+
<div class="lead">
272+
<p>Structured representation of the issue.</p>
273+
</div>
274+
</div>
275+
<h4 class="tsd-returns-title">Returns <a href="../interfaces/_types_.result.html" class="tsd-signature-type">Result</a><span class="tsd-signature-symbol">[]</span></h4>
276+
</li>
277+
</ul>
278+
</section>
279+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
280+
<a name="tostring" class="tsd-anchor"></a>
281+
<h3>to<wbr>String</h3>
282+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
283+
<li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
284+
</ul>
285+
<ul class="tsd-descriptions">
286+
<li class="tsd-description">
287+
<aside class="tsd-sources">
288+
<ul>
289+
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/fcf775f/ts/kpt-functions/src/errors.ts#L60">src/errors.ts:60</a></li>
290+
</ul>
291+
</aside>
292+
<div class="tsd-comment tsd-typography">
293+
<div class="lead">
294+
<p>String representation of the issue.</p>
295+
</div>
296+
</div>
297+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
298+
</li>
299+
</ul>
300+
</section>
301+
</section>
195302
</div>
196303
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
197304
<nav class="tsd-navigation primary">
@@ -232,19 +339,37 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> Error</h3>
232339
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
233340
<a href="_errors_.configerror.html#name" class="tsd-kind-icon">name</a>
234341
</li>
342+
<li class=" tsd-kind-property tsd-parent-kind-class">
343+
<a href="_errors_.configerror.html#severity" class="tsd-kind-icon">severity</a>
344+
</li>
235345
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited">
236346
<a href="_errors_.configerror.html#stack" class="tsd-kind-icon">stack</a>
237347
</li>
348+
<li class=" tsd-kind-property tsd-parent-kind-class">
349+
<a href="_errors_.configerror.html#tags" class="tsd-kind-icon">tags</a>
350+
</li>
238351
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
239352
<a href="_errors_.configerror.html#error" class="tsd-kind-icon">Error</a>
240353
</li>
354+
<li class=" tsd-kind-method tsd-parent-kind-class">
355+
<a href="_errors_.configerror.html#log" class="tsd-kind-icon">log</a>
356+
</li>
357+
<li class=" tsd-kind-method tsd-parent-kind-class">
358+
<a href="_errors_.configerror.html#toresults" class="tsd-kind-icon">to<wbr>Results</a>
359+
</li>
360+
<li class=" tsd-kind-method tsd-parent-kind-class">
361+
<a href="_errors_.configerror.html#tostring" class="tsd-kind-icon">to<wbr>String</a>
362+
</li>
241363
</ul>
242364
</li>
243365
</ul>
244366
<ul class="after-current">
245367
<li class=" tsd-kind-class tsd-parent-kind-external-module">
246368
<a href="_errors_.configfileerror.html" class="tsd-kind-icon">Config<wbr>File<wbr>Error</a>
247369
</li>
370+
<li class=" tsd-kind-class tsd-parent-kind-external-module">
371+
<a href="_errors_.functionconfigerror.html" class="tsd-kind-icon">Function<wbr>Config<wbr>Error</a>
372+
</li>
248373
<li class=" tsd-kind-class tsd-parent-kind-external-module">
249374
<a href="_errors_.kubernetesobjecterror.html" class="tsd-kind-icon">Kubernetes<wbr>Object<wbr>Error</a>
250375
</li>

0 commit comments

Comments
 (0)