Skip to content

Commit 65701fb

Browse files
7.1.8
1 parent 296b203 commit 65701fb

2 files changed

Lines changed: 39 additions & 1 deletion

File tree

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,11 @@ with valid options argument</p>
103103
<dt><a href="#init">init(options)</a><code><a href="#OpenwhiskClient">Promise.&lt;OpenwhiskClient&gt;</a></code></dt>
104104
<dd><p>Returns a Promise that resolves with a new RuntimeAPI object.</p>
105105
</dd>
106+
<dt><a href="#patchOWForTunnelingIssue">patchOWForTunnelingIssue(ow, use_proxy_from_env_var)</a><code>object</code></dt>
107+
<dd><p>This patches the Openwhisk client to handle a tunneling issue with openwhisk &gt; v3.0.0
108+
See <a href="https://github.com/tomas/needle/issues/406">https://github.com/tomas/needle/issues/406</a></p>
109+
<p>Once openwhisk.js supports the use_proxy_from_env_var option (for needle), we can remove this patch.</p>
110+
</dd>
106111
<dt><a href="#printActionLogs">printActionLogs(config, logger, limit, filterActions, strip, tail, fetchLogsInterval, startTime)</a><code>object</code></dt>
107112
<dd><p>Prints action logs.</p>
108113
</dd>
@@ -277,6 +282,9 @@ for syncing managed projects.</p>
277282
<dt><a href="#getSupportedServerRuntimes">getSupportedServerRuntimes(apihost)</a> ⇒ <code>Array.&lt;string&gt;</code></dt>
278283
<dd><p>Gets a list of the supported runtime kinds from the apihost.</p>
279284
</dd>
285+
<dt><a href="#getProxyAgent">getProxyAgent(endpoint, proxyUrl, proxyOptions)</a> ⇒ <code>PatchedHttpsProxyAgent</code> | <code>HttpProxyAgent</code></dt>
286+
<dd><p>Get the proxy agent for the given endpoint</p>
287+
</dd>
280288
</dl>
281289

282290
## Typedefs
@@ -661,6 +669,22 @@ Returns a Promise that resolves with a new RuntimeAPI object.
661669
| --- | --- | --- |
662670
| options | [<code>OpenwhiskOptions</code>](#OpenwhiskOptions) | options for initialization |
663671

672+
<a name="patchOWForTunnelingIssue"></a>
673+
674+
## patchOWForTunnelingIssue(ow, use_proxy_from_env_var) ⇒ <code>object</code>
675+
This patches the Openwhisk client to handle a tunneling issue with openwhisk > v3.0.0
676+
See https://github.com/tomas/needle/issues/406
677+
678+
Once openwhisk.js supports the use_proxy_from_env_var option (for needle), we can remove this patch.
679+
680+
**Kind**: global function
681+
**Returns**: <code>object</code> - the patched openwhisk object
682+
683+
| Param | Type | Description |
684+
| --- | --- | --- |
685+
| ow | <code>object</code> | the Openwhisk object to patch |
686+
| use_proxy_from_env_var | <code>boolean</code> | the needle option to add |
687+
664688
<a name="printActionLogs"></a>
665689

666690
## printActionLogs(config, logger, limit, filterActions, strip, tail, fetchLogsInterval, startTime) ⇒ <code>object</code>
@@ -1436,6 +1460,20 @@ Gets a list of the supported runtime kinds from the apihost.
14361460
| --- | --- | --- |
14371461
| apihost | <code>string</code> | the URL of the runtime apihost |
14381462

1463+
<a name="getProxyAgent"></a>
1464+
1465+
## getProxyAgent(endpoint, proxyUrl, proxyOptions) ⇒ <code>PatchedHttpsProxyAgent</code> \| <code>HttpProxyAgent</code>
1466+
Get the proxy agent for the given endpoint
1467+
1468+
**Kind**: global function
1469+
**Returns**: <code>PatchedHttpsProxyAgent</code> \| <code>HttpProxyAgent</code> - - The proxy agent
1470+
1471+
| Param | Type | Description |
1472+
| --- | --- | --- |
1473+
| endpoint | <code>string</code> | The endpoint to get the proxy agent for |
1474+
| proxyUrl | <code>string</code> | The proxy URL to use |
1475+
| proxyOptions | <code>object</code> | The proxy options to use |
1476+
14391477
<a name="ActionBuild"></a>
14401478

14411479
## ActionBuild : <code>object</code>

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@adobe/aio-lib-runtime",
3-
"version": "7.1.7",
3+
"version": "7.1.8",
44
"license": "Apache-2.0",
55
"main": "src/index.js",
66
"bugs": {

0 commit comments

Comments
 (0)