docs(compress-stringify): Document setPipelinesBaseUrl, getPipelinesB…

…aseUrl
InsightSoftwareConsortium · Jan 18, 2023 · 7fad14e · 7fad14e
1 parent 6b08205
commit 7fad14e
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 1 deletion.
diff --git a/packages/compress-stringify/typescript/README.md b/packages/compress-stringify/typescript/README.md
@@ -56,7 +56,7 @@ async function compressStringify(
 
 #### parseStringDecompress
 
-*Given a binary or string produced with CompressedStringify, decompress and optionally base64 decode.*
+*Given a binary or string produced with compressStringify, decompress and optionally base64 decode.*
 
 ```ts
 async function parseStringDecompress(
@@ -149,3 +149,21 @@ async function parseStringDecompressNode(
 | Property |     Type     | Description                |
 | :------: | :----------: | :------------------------- |
 | `output` | *Uint8Array* | Output decompressed binary |
+
+#### setPipelinesBaseUrl
+
+*Set base URL for WebAssembly assets when vendored.*
+
+```ts
+function setPipelinesBaseUrl(
+  baseUrl: string | URL
+) : void
+```
+
+#### getPipelinesBaseUrl
+
+*Get base URL for WebAssembly assets when vendored.*
+
+```ts
+function getPipelinesBaseUrl() : string | URL
+```
diff --git a/packages/compress-stringify/typescript/test/browser/index.html b/packages/compress-stringify/typescript/test/browser/index.html
@@ -24,12 +24,14 @@
       <a href="https://wasm.itk.org/" target="_blank">
         <img src="./logo.svg" class="logo vanilla" alt="ITK Wasm logo" />
       </a>
+
       <h1>itk-compress-stringify</h1>
         package
       <div class="card">
         <h2>functions</h2>
         <ul id="pipeline-functions-list">
         </ul>
+
         <sl-divider style="--width:2px;"></sl-divider>
         <h3 id="compressStringify-function"><code>compressStringify</code></h3>
         <i>Given a binary, compress and optionally base64 encode.</i>
@@ -68,6 +70,7 @@ <h4>Outputs</h4>
               Output file
           </sp-button>
         </div>
+
         <sl-divider style="--width:2px;"></sl-divider>
         <h3 id="parseStringDecompress-function"><code>parseStringDecompress</code></h3>
         <i>Given a binary or string produced with compressStringify, decompress and optionally base64 decode.</i>
@@ -103,6 +106,14 @@ <h4>Outputs</h4>
               Output file
           </sp-button>
         </div>
+
+        <sl-divider style="--width:2px;"></sl-divider>
+        <h3 id="setPipelinesBaseUrl-function"><code>setPipelinesBaseUrl</code></h3>
+        <i>Set base URL for WebAssembly assets when vendored.</i>
+
+        <sl-divider style="--width:2px;"></sl-divider>
+        <h3 id="getPipelinesBaseUrl-function"><code>getPipelinesBaseUrl</code></h3>
+        <i>Get base URL for WebAssembly assets when vendored.</i>
     </div>
 
     <script type="module" src="./app.ts"></script>