deploy: faasjs/faasjs@4245763

Author: zfben

doc/dev/classes/FuncWarper.html

@@ -113,11 +113,9 @@ <h5 id="tresult" tabindex="-1">TResult</h5>
 <p>Expected response type returned by the handler.</p>
 <h4 id="parameters-1" tabindex="-1">Parameters</h4>
 <h5 id="event%3F" tabindex="-1">event?</h5>
-<p><code>any</code> = <code>...</code></p>
-<p>Runtime event passed to the exported handler.</p>
+<p><code>Record</code>&lt;<code>string</code>, <code>unknown</code>&gt; = <code>...</code></p>
 <h5 id="context%3F" tabindex="-1">context?</h5>
-<p><code>any</code> = <code>...</code></p>
-<p>Runtime context passed to the exported handler.</p>
+<p><code>Record</code>&lt;<code>string</code>, <code>unknown</code>&gt; = <code>...</code></p>
 <h4 id="returns-1" tabindex="-1">Returns</h4>
 <p><code>Promise</code>&lt;<code>TResult</code>&gt;</p>
 <p>Handler result.</p>

doc/dev/functions/streamToObject.html

@@ -67,7 +67,7 @@ <h1 id="function%3A-streamtoobject()" tabindex="-1">Function: streamToObject()</
 <blockquote>
 <p><strong>streamToObject</strong>&lt;<code>T</code>&gt;(<code>stream</code>): <code>Promise</code>&lt;<code>T</code>&gt;</p>
 </blockquote>
-<p>Convert ReadableStream to object.</p>
+<p>Parse a JSON value from a byte stream.</p>
 <h2 id="type-parameters" tabindex="-1">Type Parameters</h2>
 <h3 id="t" tabindex="-1">T</h3>
 <p><code>T</code> = <code>any</code></p>
@@ -78,9 +78,11 @@ <h3 id="stream" tabindex="-1">stream</h3>
 <p>Readable stream to decode as JSON.</p>
 <h2 id="returns" tabindex="-1">Returns</h2>
 <p><code>Promise</code>&lt;<code>T</code>&gt;</p>
-<p>Parsed JSON object from the stream body.</p>
+<p>Parsed JSON value from the stream body.</p>
 <h2 id="throws" tabindex="-1">Throws</h2>
 <p>If stream is not a ReadableStream instance.</p>
+<h2 id="throws-1" tabindex="-1">Throws</h2>
+<p>If the stream body is not valid JSON.</p>
 <h2 id="example" tabindex="-1">Example</h2>
 <pre><code class="hljs language-ts"><span class="hljs-keyword">import</span> { streamToObject } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;@faasjs/node-utils&#x27;</span>
 

doc/dev/functions/streamToText.html

@@ -67,7 +67,7 @@ <h1 id="function%3A-streamtotext()" tabindex="-1">Function: streamToText()</h1>
 <blockquote>
 <p><strong>streamToText</strong>(<code>stream</code>): <code>Promise</code>&lt;<code>string</code>&gt;</p>
 </blockquote>
-<p>Convert ReadableStream to text.</p>
+<p>Read a byte stream into a UTF-8 string.</p>
 <h2 id="parameters" tabindex="-1">Parameters</h2>
 <h3 id="stream" tabindex="-1">stream</h3>
 <p><code>ReadableStream</code>&lt;<code>Uint8Array</code>&lt;<code>ArrayBufferLike</code>&gt;&gt;</p>

doc/dev/variables/streamToString.html

@@ -67,8 +67,8 @@ <h1 id="variable%3A-streamtostring" tabindex="-1">Variable: streamToString</h1>
 <blockquote>
 <p><code>const</code> <strong>streamToString</strong>: (<code>stream</code>) =&gt; <code>Promise</code>&lt;<code>string</code>&gt; = <code>streamToText</code></p>
 </blockquote>
-<p>Alias of <a href="/doc/dev/functions/streamToText.html">streamToText</a>.</p>
-<p>Convert ReadableStream to text.</p>
+<p>Alias of <a href="/doc/dev/functions/streamToText.html">streamToText</a> for string-oriented call sites.</p>
+<p>Read a byte stream into a UTF-8 string.</p>
 <h2 id="parameters" tabindex="-1">Parameters</h2>
 <h3 id="stream" tabindex="-1">stream</h3>
 <p><code>ReadableStream</code>&lt;<code>Uint8Array</code>&lt;<code>ArrayBufferLike</code>&gt;&gt;</p>
@@ -90,6 +90,18 @@ <h2 id="example" tabindex="-1">Example</h2>
 
 <span class="hljs-keyword">await</span> <span class="hljs-title function_">streamToText</span>(stream) <span class="hljs-comment">// &#x27;hello&#x27;</span>
 </code></pre>
+<h2 id="example-1" tabindex="-1">Example</h2>
+<pre><code class="hljs language-ts"><span class="hljs-keyword">import</span> { streamToString } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;@faasjs/node-utils&#x27;</span>
+
+<span class="hljs-keyword">const</span> stream = <span class="hljs-keyword">new</span> <span class="hljs-title class_">ReadableStream</span>&lt;<span class="hljs-title class_">Uint8Array</span>&gt;({
+  <span class="hljs-title function_">start</span>(<span class="hljs-params">controller</span>) {
+    controller.<span class="hljs-title function_">enqueue</span>(<span class="hljs-keyword">new</span> <span class="hljs-title class_">TextEncoder</span>().<span class="hljs-title function_">encode</span>(<span class="hljs-string">&#x27;hello&#x27;</span>))
+    controller.<span class="hljs-title function_">close</span>()
+  },
+})
+
+<span class="hljs-keyword">await</span> <span class="hljs-title function_">streamToString</span>(stream) <span class="hljs-comment">// &#x27;hello&#x27;</span>
+</code></pre>
 </div></div>
           </div>
 

doc/node-utils/classes/Logger.html

@@ -170,6 +170,9 @@ <h5 id="level%3F" tabindex="-1">level?</h5>
 <h4 id="returns-5" tabindex="-1">Returns</h4>
 <p><code>Logger</code></p>
 <p>The current logger for chaining.</p>
+<h4 id="default" tabindex="-1">Default</h4>
+<pre><code class="hljs language-ts"><span class="hljs-string">&#x27;debug&#x27;</span>
+</code></pre>
 <h3 id="timeend()" tabindex="-1">timeEnd()</h3>
 <blockquote>
 <p><strong>timeEnd</strong>(<code>key</code>, <code>message</code>, ...<code>args</code>): <code>Logger</code></p>
@@ -210,15 +213,15 @@ <h3 id="colorfyoutput" tabindex="-1">colorfyOutput</h3>
 <p><strong>colorfyOutput</strong>: <code>boolean</code> = <code>true</code></p>
 </blockquote>
 <p>Whether terminal output should use ANSI colors.</p>
-<h4 id="default" tabindex="-1">Default</h4>
+<h4 id="default-1" tabindex="-1">Default</h4>
 <pre><code class="hljs language-ts"><span class="hljs-literal">true</span>
 </code></pre>
 <h3 id="disabletransport" tabindex="-1">disableTransport</h3>
 <blockquote>
 <p><strong>disableTransport</strong>: <code>boolean</code> = <code>false</code></p>
 </blockquote>
 <p>Disable forwarding log messages to the shared transport.</p>
-<h4 id="default-1" tabindex="-1">Default</h4>
+<h4 id="default-2" tabindex="-1">Default</h4>
 <pre><code class="hljs language-ts"><span class="hljs-literal">false</span>
 </code></pre>
 <h3 id="label%3F-1" tabindex="-1">label?</h3>
@@ -231,23 +234,23 @@ <h3 id="level" tabindex="-1">level</h3>
 <p><strong>level</strong>: <a href="/doc/node-utils/type-aliases/Level.html"><code>Level</code></a> = <code>'debug'</code></p>
 </blockquote>
 <p>Minimum level that will be emitted.</p>
-<h4 id="default-2" tabindex="-1">Default</h4>
+<h4 id="default-3" tabindex="-1">Default</h4>
 <pre><code class="hljs language-ts"><span class="hljs-string">&#x27;debug&#x27;</span>
 </code></pre>
 <h3 id="silent" tabindex="-1">silent</h3>
 <blockquote>
 <p><strong>silent</strong>: <code>boolean</code> = <code>false</code></p>
 </blockquote>
 <p>When true, suppresses all output and transport forwarding.</p>
-<h4 id="default-3" tabindex="-1">Default</h4>
+<h4 id="default-4" tabindex="-1">Default</h4>
 <pre><code class="hljs language-ts"><span class="hljs-literal">false</span>
 </code></pre>
 <h3 id="size" tabindex="-1">size</h3>
 <blockquote>
 <p><strong>size</strong>: <code>number</code> = <code>1000</code></p>
 </blockquote>
 <p>Maximum plain-text payload length before non-error logs are truncated.</p>
-<h4 id="default-4" tabindex="-1">Default</h4>
+<h4 id="default-5" tabindex="-1">Default</h4>
 <pre><code class="hljs language-ts"><span class="hljs-number">1000</span>
 </code></pre>
 <h3 id="stderr" tabindex="-1">stderr</h3>
@@ -260,7 +263,7 @@ <h5 id="text" tabindex="-1">text</h5>
 <p><code>string</code></p>
 <h4 id="returns-8" tabindex="-1">Returns</h4>
 <p><code>void</code></p>
-<h4 id="default-5" tabindex="-1">Default</h4>
+<h4 id="default-6" tabindex="-1">Default</h4>
 <pre><code class="hljs language-ts"><span class="hljs-variable language_">console</span>.<span class="hljs-property">error</span>
 </code></pre>
 <h3 id="stdout" tabindex="-1">stdout</h3>
@@ -273,7 +276,7 @@ <h5 id="text-1" tabindex="-1">text</h5>
 <p><code>string</code></p>
 <h4 id="returns-9" tabindex="-1">Returns</h4>
 <p><code>void</code></p>
-<h4 id="default-6" tabindex="-1">Default</h4>
+<h4 id="default-7" tabindex="-1">Default</h4>
 <pre><code class="hljs language-ts"><span class="hljs-variable language_">console</span>.<span class="hljs-property">log</span>
 </code></pre>
 </div></div>

doc/node-utils/functions/loadEnvFileIfExists.html

@@ -76,6 +76,10 @@ <h3 id="options%3F" tabindex="-1">options?</h3>
 <h2 id="returns" tabindex="-1">Returns</h2>
 <p><code>string</code> | <code>null</code></p>
 <p>Resolved env file path, or <code>null</code> when the file does not exist.</p>
+<h2 id="default" tabindex="-1">Default</h2>
+<pre><code class="hljs language-ts">{
+}
+</code></pre>
 <h2 id="throws" tabindex="-1">Throws</h2>
 <p>If the resolved path exists but cannot be read as a file.</p>
 <h2 id="example" tabindex="-1">Example</h2>

doc/node-utils/functions/loadPackage.html

@@ -87,6 +87,13 @@ <h3 id="options%3F" tabindex="-1">options?</h3>
 <h2 id="returns" tabindex="-1">Returns</h2>
 <p><code>Promise</code>&lt;<code>T</code>&gt;</p>
 <p>Loaded export value or the full module namespace when no preferred key exists.</p>
+<h2 id="default" tabindex="-1">Default</h2>
+<pre><code class="hljs language-ts"><span class="hljs-string">&#x27;default&#x27;</span>
+</code></pre>
+<h2 id="default-1" tabindex="-1">Default</h2>
+<pre><code class="hljs language-ts">{
+}
+</code></pre>
 <h2 id="throws" tabindex="-1">Throws</h2>
 <p>If the runtime cannot be detected or the requested module fails to load.</p>
 <h2 id="example" tabindex="-1">Example</h2>

doc/node-utils/functions/registerNodeModuleHooks.html

@@ -76,6 +76,10 @@ <h3 id="options%3F" tabindex="-1">options?</h3>
 <p>Hook registration options such as entry file, root, tsconfig path, and cache-busting version.</p>
 <h2 id="returns" tabindex="-1">Returns</h2>
 <p><code>void</code></p>
+<h2 id="default" tabindex="-1">Default</h2>
+<pre><code class="hljs language-ts">{
+}
+</code></pre>
 <h2 id="example" tabindex="-1">Example</h2>
 <pre><code class="hljs language-ts"><span class="hljs-keyword">import</span> { registerNodeModuleHooks } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;@faasjs/node-utils&#x27;</span>