Skip to content

Commit dfc46c4

Browse files
prachirpfrankfarzan
prachirp
authored and
frankfarzan
committed
Update kpt-functions version, Add docs for new interfaces
1 parent 3232610 commit dfc46c4

17 files changed

+2461
-64
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_.functionconfigerror.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ <h3>constructor</h3>
119119
<li class="tsd-description">
120120
<aside class="tsd-sources">
121121
<ul>
122-
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/949dcdd/ts/kpt-functions/src/errors.ts#L20">src/errors.ts:20</a></li>
122+
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/3232610/ts/kpt-functions/src/errors.ts#L20">src/errors.ts:20</a></li>
123123
</ul>
124124
</aside>
125125
<h4 class="tsd-parameters-title">Parameters</h4>

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ <h3>constructor</h3>
112112
<li class="tsd-description">
113113
<aside class="tsd-sources">
114114
<ul>
115-
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/949dcdd/ts/kpt-functions/src/testing.ts#L23">src/testing.ts:23</a></li>
115+
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/3232610/ts/kpt-functions/src/testing.ts#L23">src/testing.ts:23</a></li>
116116
</ul>
117117
</aside>
118118
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -138,7 +138,7 @@ <h3>assert</h3>
138138
<li class="tsd-description">
139139
<aside class="tsd-sources">
140140
<ul>
141-
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/949dcdd/ts/kpt-functions/src/testing.ts#L46">src/testing.ts:46</a></li>
141+
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/3232610/ts/kpt-functions/src/testing.ts#L46">src/testing.ts:46</a></li>
142142
</ul>
143143
</aside>
144144
<div class="tsd-comment tsd-typography">
@@ -195,7 +195,7 @@ <h3>assert<wbr>Callback</h3>
195195
<li class="tsd-description">
196196
<aside class="tsd-sources">
197197
<ul>
198-
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/949dcdd/ts/kpt-functions/src/testing.ts#L79">src/testing.ts:79</a></li>
198+
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/3232610/ts/kpt-functions/src/testing.ts#L79">src/testing.ts:79</a></li>
199199
</ul>
200200
</aside>
201201
<div class="tsd-comment tsd-typography">

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

Lines changed: 27 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ <h3>constructor</h3>
131131
<li class="tsd-description">
132132
<aside class="tsd-sources">
133133
<ul>
134-
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/949dcdd/ts/kpt-functions/src/types.ts#L45">src/types.ts:45</a></li>
134+
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/3232610/ts/kpt-functions/src/types.ts#L45">src/types.ts:45</a></li>
135135
</ul>
136136
</aside>
137137
<div class="tsd-comment tsd-typography">
@@ -181,7 +181,7 @@ <h3>log<wbr>ToStd<wbr>Err</h3>
181181
<div class="tsd-signature tsd-kind-icon">log<wbr>ToStd<wbr>Err<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></div>
182182
<aside class="tsd-sources">
183183
<ul>
184-
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/949dcdd/ts/kpt-functions/src/types.ts#L311">src/types.ts:311</a></li>
184+
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/3232610/ts/kpt-functions/src/types.ts#L311">src/types.ts:311</a></li>
185185
</ul>
186186
</aside>
187187
<div class="tsd-comment tsd-typography">
@@ -203,7 +203,7 @@ <h3>add<wbr>Results</h3>
203203
<li class="tsd-description">
204204
<aside class="tsd-sources">
205205
<ul>
206-
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/949dcdd/ts/kpt-functions/src/types.ts#L225">src/types.ts:225</a></li>
206+
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/3232610/ts/kpt-functions/src/types.ts#L225">src/types.ts:225</a></li>
207207
</ul>
208208
</aside>
209209
<div class="tsd-comment tsd-typography">
@@ -231,7 +231,7 @@ <h3>deep<wbr>Copy</h3>
231231
<li class="tsd-description">
232232
<aside class="tsd-sources">
233233
<ul>
234-
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/949dcdd/ts/kpt-functions/src/types.ts#L252">src/types.ts:252</a></li>
234+
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/3232610/ts/kpt-functions/src/types.ts#L252">src/types.ts:252</a></li>
235235
</ul>
236236
</aside>
237237
<div class="tsd-comment tsd-typography">
@@ -253,7 +253,7 @@ <h3>delete</h3>
253253
<li class="tsd-description">
254254
<aside class="tsd-sources">
255255
<ul>
256-
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/949dcdd/ts/kpt-functions/src/types.ts#L120">src/types.ts:120</a></li>
256+
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/3232610/ts/kpt-functions/src/types.ts#L120">src/types.ts:120</a></li>
257257
</ul>
258258
</aside>
259259
<div class="tsd-comment tsd-typography">
@@ -285,7 +285,7 @@ <h3>delete<wbr>All</h3>
285285
<li class="tsd-description">
286286
<aside class="tsd-sources">
287287
<ul>
288-
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/949dcdd/ts/kpt-functions/src/types.ts#L133">src/types.ts:133</a></li>
288+
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/3232610/ts/kpt-functions/src/types.ts#L133">src/types.ts:133</a></li>
289289
</ul>
290290
</aside>
291291
<div class="tsd-comment tsd-typography">
@@ -307,7 +307,7 @@ <h3>get</h3>
307307
<li class="tsd-description">
308308
<aside class="tsd-sources">
309309
<ul>
310-
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/949dcdd/ts/kpt-functions/src/types.ts#L87">src/types.ts:87</a></li>
310+
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/3232610/ts/kpt-functions/src/types.ts#L87">src/types.ts:87</a></li>
311311
</ul>
312312
</aside>
313313
<div class="tsd-comment tsd-typography">
@@ -365,7 +365,7 @@ <h3>get<wbr>All</h3>
365365
<li class="tsd-description">
366366
<aside class="tsd-sources">
367367
<ul>
368-
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/949dcdd/ts/kpt-functions/src/types.ts#L72">src/types.ts:72</a></li>
368+
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/3232610/ts/kpt-functions/src/types.ts#L72">src/types.ts:72</a></li>
369369
</ul>
370370
</aside>
371371
<div class="tsd-comment tsd-typography">
@@ -389,7 +389,7 @@ <h3>get<wbr>Function<wbr>Config</h3>
389389
<li class="tsd-description">
390390
<aside class="tsd-sources">
391391
<ul>
392-
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/949dcdd/ts/kpt-functions/src/types.ts#L165">src/types.ts:165</a></li>
392+
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/3232610/ts/kpt-functions/src/types.ts#L165">src/types.ts:165</a></li>
393393
</ul>
394394
</aside>
395395
<div class="tsd-comment tsd-typography">
@@ -411,7 +411,7 @@ <h3>get<wbr>Function<wbr>Config<wbr>Map</h3>
411411
<li class="tsd-description">
412412
<aside class="tsd-sources">
413413
<ul>
414-
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/949dcdd/ts/kpt-functions/src/types.ts#L175">src/types.ts:175</a></li>
414+
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/3232610/ts/kpt-functions/src/types.ts#L175">src/types.ts:175</a></li>
415415
</ul>
416416
</aside>
417417
<div class="tsd-comment tsd-typography">
@@ -435,7 +435,7 @@ <h3>get<wbr>Function<wbr>Config<wbr>Value</h3>
435435
<li class="tsd-description">
436436
<aside class="tsd-sources">
437437
<ul>
438-
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/949dcdd/ts/kpt-functions/src/types.ts#L204">src/types.ts:204</a></li>
438+
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/3232610/ts/kpt-functions/src/types.ts#L204">src/types.ts:204</a></li>
439439
</ul>
440440
</aside>
441441
<div class="tsd-comment tsd-typography">
@@ -471,7 +471,7 @@ <h3>get<wbr>Function<wbr>Config<wbr>Value<wbr>OrThrow</h3>
471471
<li class="tsd-description">
472472
<aside class="tsd-sources">
473473
<ul>
474-
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/949dcdd/ts/kpt-functions/src/types.ts#L212">src/types.ts:212</a></li>
474+
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/3232610/ts/kpt-functions/src/types.ts#L212">src/types.ts:212</a></li>
475475
</ul>
476476
</aside>
477477
<div class="tsd-comment tsd-typography">
@@ -499,7 +499,7 @@ <h3>get<wbr>Results</h3>
499499
<li class="tsd-description">
500500
<aside class="tsd-sources">
501501
<ul>
502-
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/949dcdd/ts/kpt-functions/src/types.ts#L235">src/types.ts:235</a></li>
502+
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/3232610/ts/kpt-functions/src/types.ts#L235">src/types.ts:235</a></li>
503503
</ul>
504504
</aside>
505505
<div class="tsd-comment tsd-typography">
@@ -515,13 +515,13 @@ <h4 class="tsd-returns-title">Returns <a href="../interfaces/_types_.result.html
515515
<a name="groupby" class="tsd-anchor"></a>
516516
<h3>group<wbr>By</h3>
517517
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
518-
<li class="tsd-signature tsd-kind-icon">group<wbr>By<span class="tsd-signature-symbol">(</span>keyFn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>object<span class="tsd-signature-symbol">: </span><a href="../interfaces/_types_.kubernetesobject.html" class="tsd-signature-type">KubernetesObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/_types_.kubernetesobject.html" class="tsd-signature-type">KubernetesObject</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></li>
518+
<li class="tsd-signature tsd-kind-icon">group<wbr>By<span class="tsd-signature-symbol">(</span>keyFn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>object<span class="tsd-signature-symbol">: </span><a href="../interfaces/_types_.kubernetesobject.html" class="tsd-signature-type">KubernetesObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_types_.jsonarray.html#array" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/_types_.kubernetesobject.html" class="tsd-signature-type">KubernetesObject</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></li>
519519
</ul>
520520
<ul class="tsd-descriptions">
521521
<li class="tsd-description">
522522
<aside class="tsd-sources">
523523
<ul>
524-
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/949dcdd/ts/kpt-functions/src/types.ts#L150">src/types.ts:150</a></li>
524+
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/3232610/ts/kpt-functions/src/types.ts#L150">src/types.ts:150</a></li>
525525
</ul>
526526
</aside>
527527
<div class="tsd-comment tsd-typography">
@@ -559,7 +559,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</s
559559
</ul>
560560
</li>
561561
</ul>
562-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/_types_.kubernetesobject.html" class="tsd-signature-type">KubernetesObject</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h4>
562+
<h4 class="tsd-returns-title">Returns <a href="../interfaces/_types_.jsonarray.html#array" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/_types_.kubernetesobject.html" class="tsd-signature-type">KubernetesObject</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h4>
563563
</li>
564564
</ul>
565565
</section>
@@ -573,7 +573,7 @@ <h3>insert</h3>
573573
<li class="tsd-description">
574574
<aside class="tsd-sources">
575575
<ul>
576-
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/949dcdd/ts/kpt-functions/src/types.ts#L105">src/types.ts:105</a></li>
576+
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/3232610/ts/kpt-functions/src/types.ts#L105">src/types.ts:105</a></li>
577577
</ul>
578578
</aside>
579579
<div class="tsd-comment tsd-typography">
@@ -608,7 +608,7 @@ <h3>to<wbr>Resource<wbr>List</h3>
608608
<li class="tsd-description">
609609
<aside class="tsd-sources">
610610
<ul>
611-
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/949dcdd/ts/kpt-functions/src/types.ts#L242">src/types.ts:242</a></li>
611+
<li>Defined in <a href="https://github.com/GoogleContainerTools/kpt-functions-sdk/blob/3232610/ts/kpt-functions/src/types.ts#L242">src/types.ts:242</a></li>
612612
</ul>
613613
</aside>
614614
<div class="tsd-comment tsd-typography">
@@ -713,6 +713,12 @@ <h4 class="tsd-returns-title">Returns <a href="_types_.resourcelist.html" class=
713713
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
714714
<a href="../interfaces/_types_.fieldinfo.html" class="tsd-kind-icon">Field<wbr>Info</a>
715715
</li>
716+
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
717+
<a href="../interfaces/_types_.jsonarray.html" class="tsd-kind-icon">Json<wbr>Array</a>
718+
</li>
719+
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
720+
<a href="../interfaces/_types_.jsonmap.html" class="tsd-kind-icon">Json<wbr>Map</a>
721+
</li>
716722
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
717723
<a href="../interfaces/_types_.kptfunc.html" class="tsd-kind-icon">Kpt<wbr>Func</a>
718724
</li>
@@ -722,6 +728,9 @@ <h4 class="tsd-returns-title">Returns <a href="_types_.resourcelist.html" class=
722728
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
723729
<a href="../interfaces/_types_.result.html" class="tsd-kind-icon">Result</a>
724730
</li>
731+
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
732+
<a href="../modules/_types_.html#json" class="tsd-kind-icon">Json</a>
733+
</li>
725734
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
726735
<a href="../modules/_types_.html#severity" class="tsd-kind-icon">Severity</a>
727736
</li>

0 commit comments

Comments
 (0)