Skip to content

Commit

Permalink
Update kpt-functions version, Add docs for new interfaces
Browse files Browse the repository at this point in the history
  • Loading branch information
@prachirp @frankfarzan
prachirp authored and frankfarzan committed Aug 20, 2020
1 parent 3232610 commit dfc46c4
Show file tree
Hide file tree
Showing 17 changed files with 2,461 additions and 64 deletions.
2 changes: 1 addition & 1 deletion docs/api/assets/js/search.js
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/api/classes/_errors_.functionconfigerror.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<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>
<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>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down
6 changes: 3 additions & 3 deletions docs/api/classes/_testing_.testrunner.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<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>
<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>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -138,7 +138,7 @@ <h3>assert</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<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>
<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>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -195,7 +195,7 @@ <h3>assert<wbr>Callback</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<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>
<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>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
45 changes: 27 additions & 18 deletions docs/api/classes/_types_.configs.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<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>
<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>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -181,7 +181,7 @@ <h3>log<wbr>ToStd<wbr>Err</h3>
<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>
<aside class="tsd-sources">
<ul>
<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>
<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>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -203,7 +203,7 @@ <h3>add<wbr>Results</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<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>
<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>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -231,7 +231,7 @@ <h3>deep<wbr>Copy</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<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>
<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>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -253,7 +253,7 @@ <h3>delete</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<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>
<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>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -285,7 +285,7 @@ <h3>delete<wbr>All</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<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>
<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>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -307,7 +307,7 @@ <h3>get</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<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>
<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>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -365,7 +365,7 @@ <h3>get<wbr>All</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<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>
<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>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -389,7 +389,7 @@ <h3>get<wbr>Function<wbr>Config</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<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>
<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>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -411,7 +411,7 @@ <h3>get<wbr>Function<wbr>Config<wbr>Map</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<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>
<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>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -435,7 +435,7 @@ <h3>get<wbr>Function<wbr>Config<wbr>Value</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<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>
<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>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -471,7 +471,7 @@ <h3>get<wbr>Function<wbr>Config<wbr>Value<wbr>OrThrow</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<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>
<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>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -499,7 +499,7 @@ <h3>get<wbr>Results</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<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>
<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>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -515,13 +515,13 @@ <h4 class="tsd-returns-title">Returns <a href="../interfaces/_types_.result.html
<a name="groupby" class="tsd-anchor"></a>
<h3>group<wbr>By</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<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>
<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>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<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>
<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>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -559,7 +559,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</s
</ul>
</li>
</ul>
<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>
<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>
</li>
</ul>
</section>
Expand All @@ -573,7 +573,7 @@ <h3>insert</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<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>
<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>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -608,7 +608,7 @@ <h3>to<wbr>Resource<wbr>List</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<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>
<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>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -713,6 +713,12 @@ <h4 class="tsd-returns-title">Returns <a href="_types_.resourcelist.html" class=
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_types_.fieldinfo.html" class="tsd-kind-icon">Field<wbr>Info</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_types_.jsonarray.html" class="tsd-kind-icon">Json<wbr>Array</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_types_.jsonmap.html" class="tsd-kind-icon">Json<wbr>Map</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_types_.kptfunc.html" class="tsd-kind-icon">Kpt<wbr>Func</a>
</li>
Expand All @@ -722,6 +728,9 @@ <h4 class="tsd-returns-title">Returns <a href="_types_.resourcelist.html" class=
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_types_.result.html" class="tsd-kind-icon">Result</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="../modules/_types_.html#json" class="tsd-kind-icon">Json</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="../modules/_types_.html#severity" class="tsd-kind-icon">Severity</a>
</li>
Expand Down
Loading

0 comments on commit dfc46c4

Please sign in to comment.