From 7fad14e8c2eabd3f7361dfdc07d39ea9fbf5502c Mon Sep 17 00:00:00 2001 From: Matt McCormick Date: Wed, 18 Jan 2023 14:56:47 -0500 Subject: [PATCH] docs(compress-stringify): Document setPipelinesBaseUrl, getPipelinesBaseUrl --- .../compress-stringify/typescript/README.md | 20 ++++++++++++++++++- .../typescript/test/browser/index.html | 11 ++++++++++ 2 files changed, 30 insertions(+), 1 deletion(-) diff --git a/packages/compress-stringify/typescript/README.md b/packages/compress-stringify/typescript/README.md index bf1be00be..4b2f17858 100644 --- 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 +``` \ No newline at end of file diff --git a/packages/compress-stringify/typescript/test/browser/index.html b/packages/compress-stringify/typescript/test/browser/index.html index 67ce02e25..d3f92ddbd 100644 --- a/packages/compress-stringify/typescript/test/browser/index.html +++ b/packages/compress-stringify/typescript/test/browser/index.html @@ -24,12 +24,14 @@ +

itk-compress-stringify

package

functions

+

compressStringify

Given a binary, compress and optionally base64 encode. @@ -68,6 +70,7 @@

Outputs

Output file
+

parseStringDecompress

Given a binary or string produced with compressStringify, decompress and optionally base64 decode. @@ -103,6 +106,14 @@

Outputs

Output file + + +

setPipelinesBaseUrl

+ Set base URL for WebAssembly assets when vendored. + + +

getPipelinesBaseUrl

+ Get base URL for WebAssembly assets when vendored.