@zthun/webigail-web 2.4.1 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. package/dist/assets/icons.js +1 -1
  2. package/dist/assets/icons.svg +1 -1
  3. package/dist/assets/main.js +1 -1
  4. package/dist/assets/search.js +1 -1
  5. package/dist/assets/style.css +66 -21
  6. package/dist/classes/_zthun_webigail_http.ZHttpRequestBuilder.html +17 -17
  7. package/dist/classes/_zthun_webigail_http.ZHttpResultBuilder.html +7 -7
  8. package/dist/classes/_zthun_webigail_http.ZHttpService.html +3 -3
  9. package/dist/classes/_zthun_webigail_http.ZHttpServiceMock.html +4 -4
  10. package/dist/classes/_zthun_webigail_nest.ZHttpModule.html +3 -3
  11. package/dist/classes/_zthun_webigail_rest.ZRestfulService.html +11 -11
  12. package/dist/classes/_zthun_webigail_url.ZDataUrlBuilder.html +10 -10
  13. package/dist/classes/_zthun_webigail_url.ZUrlBuilder.html +35 -35
  14. package/dist/enums/_zthun_webigail_http.ZHttpCodeCategory.html +8 -8
  15. package/dist/enums/_zthun_webigail_http.ZHttpCodeClient.html +37 -37
  16. package/dist/enums/_zthun_webigail_http.ZHttpCodeInformationalResponse.html +7 -7
  17. package/dist/enums/_zthun_webigail_http.ZHttpCodeRedirection.html +12 -12
  18. package/dist/enums/_zthun_webigail_http.ZHttpCodeServer.html +14 -14
  19. package/dist/enums/_zthun_webigail_http.ZHttpCodeSeverity.html +7 -7
  20. package/dist/enums/_zthun_webigail_http.ZHttpCodeSuccess.html +13 -13
  21. package/dist/enums/_zthun_webigail_http.ZHttpMethod.html +10 -10
  22. package/dist/enums/_zthun_webigail_url.ZMimeTypeApplication.html +6 -6
  23. package/dist/enums/_zthun_webigail_url.ZMimeTypeImage.html +10 -10
  24. package/dist/enums/_zthun_webigail_url.ZMimeTypeText.html +10 -10
  25. package/dist/enums/_zthun_webigail_url.ZYouTubeApi.html +5 -5
  26. package/dist/functions/_zthun_webigail_http.fromContentType.html +2 -2
  27. package/dist/functions/_zthun_webigail_http.getHttpCodeCategory.html +2 -2
  28. package/dist/functions/_zthun_webigail_http.getHttpCodeDescription.html +2 -2
  29. package/dist/functions/_zthun_webigail_http.getHttpCodeName.html +2 -2
  30. package/dist/functions/_zthun_webigail_http.getHttpCodeSeverity.html +2 -2
  31. package/dist/functions/_zthun_webigail_http.isBodyInit.html +2 -2
  32. package/dist/functions/_zthun_webigail_http.toBodyInit.html +2 -2
  33. package/dist/hierarchy.html +1 -1
  34. package/dist/index.html +7 -6
  35. package/dist/interfaces/_zthun_webigail_http.IZHttpRequest.html +7 -7
  36. package/dist/interfaces/_zthun_webigail_http.IZHttpResult.html +5 -5
  37. package/dist/interfaces/_zthun_webigail_http.IZHttpService.html +3 -3
  38. package/dist/interfaces/_zthun_webigail_rest.IZRestfulCreate.html +3 -3
  39. package/dist/interfaces/_zthun_webigail_rest.IZRestfulDelete.html +3 -3
  40. package/dist/interfaces/_zthun_webigail_rest.IZRestfulGet.html +3 -3
  41. package/dist/interfaces/_zthun_webigail_rest.IZRestfulService.html +9 -9
  42. package/dist/interfaces/_zthun_webigail_rest.IZRestfulUpdate.html +3 -3
  43. package/dist/interfaces/_zthun_webigail_rest.IZRestfulUpsert.html +3 -3
  44. package/dist/interfaces/_zthun_webigail_url.IZDataUrlInfo.html +6 -6
  45. package/dist/interfaces/_zthun_webigail_url.IZUrlInfo.html +10 -10
  46. package/dist/modules/_zthun_webigail_http.html +14 -12
  47. package/dist/modules/_zthun_webigail_nest.html +6 -5
  48. package/dist/modules/_zthun_webigail_rest.html +5 -4
  49. package/dist/modules/_zthun_webigail_url.html +8 -7
  50. package/dist/modules.html +2 -0
  51. package/dist/types/_zthun_webigail_http.ZHttpCode.html +2 -2
  52. package/dist/types/_zthun_webigail_url.ZMimeType.html +2 -2
  53. package/dist/variables/_zthun_webigail_http.ZHttpCodeClientDescriptions.html +2 -2
  54. package/dist/variables/_zthun_webigail_http.ZHttpCodeClientNames.html +2 -2
  55. package/dist/variables/_zthun_webigail_http.ZHttpCodeInformationalResponseDescriptions.html +2 -2
  56. package/dist/variables/_zthun_webigail_http.ZHttpCodeInformationalResponseNames.html +2 -2
  57. package/dist/variables/_zthun_webigail_http.ZHttpCodeRedirectionDescriptions.html +2 -2
  58. package/dist/variables/_zthun_webigail_http.ZHttpCodeRedirectionNames.html +2 -2
  59. package/dist/variables/_zthun_webigail_http.ZHttpCodeServerDescriptions.html +2 -2
  60. package/dist/variables/_zthun_webigail_http.ZHttpCodeServerNames.html +2 -2
  61. package/dist/variables/_zthun_webigail_http.ZHttpCodeSuccessDescriptions.html +2 -2
  62. package/dist/variables/_zthun_webigail_http.ZHttpCodeSuccessNames.html +2 -2
  63. package/dist/variables/_zthun_webigail_nest.ZHttpServiceToken.html +2 -2
  64. package/dist/variables/_zthun_webigail_url.ZSupportedMimeTypes.html +2 -2
  65. package/package.json +7 -7
@@ -1,8 +1,9 @@
1
1
  <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@zthun/webigail-nest | Webigail</title><meta name="description" content="Documentation for Webigail"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../webigail.svg" />
2
- </head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Webigail</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Webigail</a></li><li><a href="_zthun_webigail_nest.html">@zthun/webigail-nest</a></li></ul><h1>Module @zthun/webigail-nest</h1></div><section class="tsd-panel tsd-typography"><a id="md:webigail-nest" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Webigail Nest<a href="#md:webigail-nest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p>NestJs already comes with an http module built in, so it is recommended to just use that one. If you are using
3
- webigail-http and you want to inject that service into your nest project, then this package comes with the module that
4
- will do that for you.</p>
5
- <a id="md:build-status" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Build Status<a href="#md:build-status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><a href="https://dl.circleci.com/status-badge/redirect/gh/zthun/webigail/tree/latest"><img src="https://dl.circleci.com/status-badge/img/gh/zthun/webigail/tree/latest.svg?style=shield" alt="CircleCI"></a></p>
2
+ </head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Webigail</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Webigail</a></li><li><a href="_zthun_webigail_nest.html">@zthun/webigail-nest</a></li></ul><h1>Module @zthun/webigail-nest</h1></div><section class="tsd-panel tsd-typography"><a id="md:webigail-nest" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Webigail Nest<a href="#md:webigail-nest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p>NestJs already comes with an http module built in, so it is recommended to just
3
+ use that one. If you are using webigail-http and you want to inject that service
4
+ into your nest project, then this package comes with the module that will do
5
+ that for you.</p>
6
+ <a id="md:build-status" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Build Status<a href="#md:build-status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><a href="https://dl.circleci.com/status-badge/redirect/gh/zthun/webigail/tree/latest" target="_blank" class="external"><img src="https://dl.circleci.com/status-badge/img/gh/zthun/webigail/tree/latest.svg?style=shield" alt="CircleCI"></a></p>
6
7
  <a id="md:usage" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Usage<a href="#md:usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Webigail is built in TypeScript and it exports both ESM and CJS modules.</p>
7
8
  <pre><code class="sh"><span class="hl-0"># NPM</span><br/><span class="hl-1">npm</span><span class="hl-2"> </span><span class="hl-3">install</span><span class="hl-2"> </span><span class="hl-3">@zthun/webigail-nest</span><br/><span class="hl-0"># Yarn</span><br/><span class="hl-1">yarn</span><span class="hl-2"> </span><span class="hl-3">add</span><span class="hl-2"> </span><span class="hl-3">@zthun/webigail-nest</span>
8
9
  </code><button type="button">Copy</button></pre>
@@ -12,4 +13,4 @@ will do that for you.</p>
12
13
 
13
14
  </section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/_zthun_webigail_nest.ZHttpModule.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZHttp<wbr/>Module</span></a>
14
15
  </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Variables</h3><div class="tsd-index-list"><a href="../variables/_zthun_webigail_nest.ZHttpServiceToken.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>ZHttp<wbr/>Service<wbr/>Token</span></a>
15
- </div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:webigail-nest"><span>Webigail <wbr/>Nest</span></a><ul><li><a href="#md:build-status"><span>Build <wbr/>Status</span></a></li><li><a href="#md:usage"><span>Usage</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Webigail</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
16
+ </div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:webigail-nest"><span>Webigail <wbr/>Nest</span></a><ul><li><a href="#md:build-status"><span>Build <wbr/>Status</span></a></li><li><a href="#md:usage"><span>Usage</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Webigail</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
@@ -1,11 +1,12 @@
1
1
  <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@zthun/webigail-rest | Webigail</title><meta name="description" content="Documentation for Webigail"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../webigail.svg" />
2
- </head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Webigail</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Webigail</a></li><li><a href="_zthun_webigail_rest.html">@zthun/webigail-rest</a></li></ul><h1>Module @zthun/webigail-rest</h1></div><section class="tsd-panel tsd-typography"><a id="md:webigail-rest" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Webigail REST<a href="#md:webigail-rest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p>Contains services and classes that help with querying REST services based on specific standards.</p>
3
- <a id="md:build-status" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Build Status<a href="#md:build-status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><a href="https://dl.circleci.com/status-badge/redirect/gh/zthun/webigail/tree/latest"><img src="https://dl.circleci.com/status-badge/img/gh/zthun/webigail/tree/latest.svg?style=shield" alt="CircleCI"></a></p>
2
+ </head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Webigail</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Webigail</a></li><li><a href="_zthun_webigail_rest.html">@zthun/webigail-rest</a></li></ul><h1>Module @zthun/webigail-rest</h1></div><section class="tsd-panel tsd-typography"><a id="md:webigail-rest" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Webigail REST<a href="#md:webigail-rest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p>Contains services and classes that help with querying REST services based on
3
+ specific standards.</p>
4
+ <a id="md:build-status" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Build Status<a href="#md:build-status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><a href="https://dl.circleci.com/status-badge/redirect/gh/zthun/webigail/tree/latest" target="_blank" class="external"><img src="https://dl.circleci.com/status-badge/img/gh/zthun/webigail/tree/latest.svg?style=shield" alt="CircleCI"></a></p>
4
5
  <a id="md:usage" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Usage<a href="#md:usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Webigail is built in TypeScript and it exports both ESM and CJS modules.</p>
5
6
  <pre><code class="sh"><span class="hl-0"># NPM</span><br/><span class="hl-1">npm</span><span class="hl-2"> </span><span class="hl-3">install</span><span class="hl-2"> </span><span class="hl-3">@zthun/webigail-rest</span><br/><span class="hl-0"># Yarn</span><br/><span class="hl-1">yarn</span><span class="hl-2"> </span><span class="hl-3">add</span><span class="hl-2"> </span><span class="hl-3">@zthun/webigail-rest</span>
6
7
  </code><button type="button">Copy</button></pre>
7
8
 
8
- <pre><code class="ts"><span class="hl-4">import</span><span class="hl-2"> { </span><span class="hl-5">ZDataRequestBuilder</span><span class="hl-2"> } </span><span class="hl-4">from</span><span class="hl-2"> </span><span class="hl-3">&#39;@zthun/helpful-query&#39;</span><span class="hl-2">;</span><br/><span class="hl-4">import</span><span class="hl-2"> { </span><span class="hl-5">ZHttpService</span><span class="hl-2"> } </span><span class="hl-4">from</span><span class="hl-2"> </span><span class="hl-3">&#39;@zthun/webigail-http&#39;</span><span class="hl-2">;</span><br/><span class="hl-4">import</span><span class="hl-2"> { </span><span class="hl-5">ZRestfulService</span><span class="hl-2"> } </span><span class="hl-4">from</span><span class="hl-2"> </span><span class="hl-3">&#39;@zthun/webigail-rest&#39;</span><span class="hl-2">;</span><br/><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-8">endpoint</span><span class="hl-2"> = </span><span class="hl-3">&#39;https://pokeapi.co/api/v2/pokemon-species&#39;</span><span class="hl-2">;</span><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-8">service</span><span class="hl-2"> = </span><span class="hl-6">new</span><span class="hl-2"> </span><span class="hl-1">ZRestfulService</span><span class="hl-2">(</span><span class="hl-6">new</span><span class="hl-2"> </span><span class="hl-1">ZHttpService</span><span class="hl-2">(), </span><span class="hl-5">endpoint</span><span class="hl-2">);</span><br/><br/><span class="hl-0">// Note that the following 2 requests have the expectation that the result for the</span><br/><span class="hl-0">// API is in the form of { count, data } or { count, result };</span><br/><span class="hl-0">// Counts the resources that match the request - uses GET verb</span><br/><span class="hl-5">service</span><span class="hl-2">.</span><span class="hl-1">count</span><span class="hl-2">(</span><span class="hl-6">new</span><span class="hl-2"> </span><span class="hl-1">ZDataRequestBuilder</span><span class="hl-2">().</span><span class="hl-1">search</span><span class="hl-2">(</span><span class="hl-3">&#39;bulbasaur&#39;</span><span class="hl-2">).</span><span class="hl-1">build</span><span class="hl-2">()).</span><span class="hl-1">then</span><span class="hl-2">((</span><span class="hl-5">count</span><span class="hl-2">) </span><span class="hl-6">=&gt;</span><span class="hl-2"> </span><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-5">count</span><span class="hl-2">));</span><br/><span class="hl-0">// Get a page of resources - uses GET verb</span><br/><span class="hl-5">service</span><span class="hl-2">.</span><span class="hl-1">request</span><span class="hl-2">(</span><span class="hl-6">new</span><span class="hl-2"> </span><span class="hl-1">ZDataRequestBuilder</span><span class="hl-2">().</span><span class="hl-1">page</span><span class="hl-2">(</span><span class="hl-9">1</span><span class="hl-2">).</span><span class="hl-1">size</span><span class="hl-2">(</span><span class="hl-9">50</span><span class="hl-2">).</span><span class="hl-1">build</span><span class="hl-2">()).</span><span class="hl-1">then</span><span class="hl-2">((</span><span class="hl-5">page</span><span class="hl-2">) </span><span class="hl-6">=&gt;</span><span class="hl-2"> </span><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-5">page</span><span class="hl-2">));</span><br/><br/><span class="hl-0">// Get a single resource - uses GET verb</span><br/><span class="hl-5">service</span><span class="hl-2">.</span><span class="hl-1">get</span><span class="hl-2">(</span><span class="hl-3">&#39;ditto&#39;</span><span class="hl-2">).</span><span class="hl-1">then</span><span class="hl-2">((</span><span class="hl-5">ditto</span><span class="hl-2">) </span><span class="hl-6">=&gt;</span><span class="hl-2"> </span><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-5">ditto</span><span class="hl-2">));</span><br/><br/><span class="hl-0">// Note: The pokemon API is read only, but these would still invoke the endpoint with the given verbs</span><br/><span class="hl-0">// The would just fail with 404s, but these are here to illustrate the usage of a full rest service.</span><br/><span class="hl-0">// There is also an assumption that the return values on the services return the data that was mutated.</span><br/><span class="hl-0">// Delete is assumed to return a 204 - No Content if successful.</span><br/><br/><span class="hl-0">// Create a new resource - uses POST verb</span><br/><span class="hl-5">service</span><span class="hl-2">.</span><span class="hl-1">create</span><span class="hl-2">({ </span><span class="hl-5">name:</span><span class="hl-2"> </span><span class="hl-3">&#39;not-really-a-pokemon&#39;</span><span class="hl-2"> }).</span><span class="hl-1">then</span><span class="hl-2">((</span><span class="hl-5">created</span><span class="hl-2">) </span><span class="hl-6">=&gt;</span><span class="hl-2"> </span><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-5">created</span><span class="hl-2">));</span><br/><span class="hl-0">// Upsert a resource - Creates if not exists, updates if exists - uses PUT verb</span><br/><span class="hl-5">service</span><span class="hl-2">.</span><span class="hl-1">upsert</span><span class="hl-2">({ </span><span class="hl-5">id:</span><span class="hl-2"> </span><span class="hl-3">&#39;missing-no&#39;</span><span class="hl-2">, </span><span class="hl-5">name:</span><span class="hl-2"> </span><span class="hl-3">&#39;MissingNo&#39;</span><span class="hl-2"> }).</span><span class="hl-1">then</span><span class="hl-2">((</span><span class="hl-5">upserted</span><span class="hl-2">) </span><span class="hl-6">=&gt;</span><span class="hl-2"> </span><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-5">upserted</span><span class="hl-2">));</span><br/><span class="hl-0">// Updates a resource - uses PATCH verb</span><br/><span class="hl-5">service</span><span class="hl-2">.</span><span class="hl-1">update</span><span class="hl-2">(</span><span class="hl-3">&#39;pikachu&#39;</span><span class="hl-2">, { </span><span class="hl-5">name:</span><span class="hl-2"> </span><span class="hl-3">&#39;Pika-who?&#39;</span><span class="hl-2"> }).</span><span class="hl-1">then</span><span class="hl-2">((</span><span class="hl-5">updated</span><span class="hl-2">) </span><span class="hl-6">=&gt;</span><span class="hl-2"> </span><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-5">updated</span><span class="hl-2">));</span><br/><span class="hl-0">// Deletes a resource - uses DELETE verb</span><br/><span class="hl-5">service</span><span class="hl-2">.</span><span class="hl-1">delete</span><span class="hl-2">(</span><span class="hl-3">&#39;pikachu&#39;</span><span class="hl-2">).</span><span class="hl-1">then</span><span class="hl-2">(() </span><span class="hl-6">=&gt;</span><span class="hl-2"> </span><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-3">&#39;Pikachu has fainted from existence&#39;</span><span class="hl-2">));</span>
9
+ <pre><code class="ts"><span class="hl-4">import</span><span class="hl-2"> { </span><span class="hl-5">ZDataRequestBuilder</span><span class="hl-2"> } </span><span class="hl-4">from</span><span class="hl-2"> </span><span class="hl-3">&quot;@zthun/helpful-query&quot;</span><span class="hl-2">;</span><br/><span class="hl-4">import</span><span class="hl-2"> { </span><span class="hl-5">ZHttpService</span><span class="hl-2"> } </span><span class="hl-4">from</span><span class="hl-2"> </span><span class="hl-3">&quot;@zthun/webigail-http&quot;</span><span class="hl-2">;</span><br/><span class="hl-4">import</span><span class="hl-2"> { </span><span class="hl-5">ZRestfulService</span><span class="hl-2"> } </span><span class="hl-4">from</span><span class="hl-2"> </span><span class="hl-3">&quot;@zthun/webigail-rest&quot;</span><span class="hl-2">;</span><br/><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-8">endpoint</span><span class="hl-2"> = </span><span class="hl-3">&quot;https://pokeapi.co/api/v2/pokemon-species&quot;</span><span class="hl-2">;</span><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-8">service</span><span class="hl-2"> = </span><span class="hl-6">new</span><span class="hl-2"> </span><span class="hl-1">ZRestfulService</span><span class="hl-2">(</span><span class="hl-6">new</span><span class="hl-2"> </span><span class="hl-1">ZHttpService</span><span class="hl-2">(), </span><span class="hl-5">endpoint</span><span class="hl-2">);</span><br/><br/><span class="hl-0">// Note that the following 2 requests have the expectation that the result for the</span><br/><span class="hl-0">// API is in the form of { count, data } or { count, result };</span><br/><span class="hl-0">// Counts the resources that match the request - uses GET verb</span><br/><span class="hl-5">service</span><br/><span class="hl-2"> .</span><span class="hl-1">count</span><span class="hl-2">(</span><span class="hl-6">new</span><span class="hl-2"> </span><span class="hl-1">ZDataRequestBuilder</span><span class="hl-2">().</span><span class="hl-1">search</span><span class="hl-2">(</span><span class="hl-3">&quot;bulbasaur&quot;</span><span class="hl-2">).</span><span class="hl-1">build</span><span class="hl-2">())</span><br/><span class="hl-2"> .</span><span class="hl-1">then</span><span class="hl-2">((</span><span class="hl-5">count</span><span class="hl-2">) </span><span class="hl-6">=&gt;</span><span class="hl-2"> </span><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-5">count</span><span class="hl-2">));</span><br/><span class="hl-0">// Get a page of resources - uses GET verb</span><br/><span class="hl-5">service</span><br/><span class="hl-2"> .</span><span class="hl-1">request</span><span class="hl-2">(</span><span class="hl-6">new</span><span class="hl-2"> </span><span class="hl-1">ZDataRequestBuilder</span><span class="hl-2">().</span><span class="hl-1">page</span><span class="hl-2">(</span><span class="hl-9">1</span><span class="hl-2">).</span><span class="hl-1">size</span><span class="hl-2">(</span><span class="hl-9">50</span><span class="hl-2">).</span><span class="hl-1">build</span><span class="hl-2">())</span><br/><span class="hl-2"> .</span><span class="hl-1">then</span><span class="hl-2">((</span><span class="hl-5">page</span><span class="hl-2">) </span><span class="hl-6">=&gt;</span><span class="hl-2"> </span><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-5">page</span><span class="hl-2">));</span><br/><br/><span class="hl-0">// Get a single resource - uses GET verb</span><br/><span class="hl-5">service</span><span class="hl-2">.</span><span class="hl-1">get</span><span class="hl-2">(</span><span class="hl-3">&quot;ditto&quot;</span><span class="hl-2">).</span><span class="hl-1">then</span><span class="hl-2">((</span><span class="hl-5">ditto</span><span class="hl-2">) </span><span class="hl-6">=&gt;</span><span class="hl-2"> </span><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-5">ditto</span><span class="hl-2">));</span><br/><br/><span class="hl-0">// Note: The pokemon API is read only, but these would still invoke the endpoint with the given verbs</span><br/><span class="hl-0">// The would just fail with 404s, but these are here to illustrate the usage of a full rest service.</span><br/><span class="hl-0">// There is also an assumption that the return values on the services return the data that was mutated.</span><br/><span class="hl-0">// Delete is assumed to return a 204 - No Content if successful.</span><br/><br/><span class="hl-0">// Create a new resource - uses POST verb</span><br/><span class="hl-5">service</span><br/><span class="hl-2"> .</span><span class="hl-1">create</span><span class="hl-2">({ </span><span class="hl-5">name:</span><span class="hl-2"> </span><span class="hl-3">&quot;not-really-a-pokemon&quot;</span><span class="hl-2"> })</span><br/><span class="hl-2"> .</span><span class="hl-1">then</span><span class="hl-2">((</span><span class="hl-5">created</span><span class="hl-2">) </span><span class="hl-6">=&gt;</span><span class="hl-2"> </span><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-5">created</span><span class="hl-2">));</span><br/><span class="hl-0">// Upsert a resource - Creates if not exists, updates if exists - uses PUT verb</span><br/><span class="hl-5">service</span><br/><span class="hl-2"> .</span><span class="hl-1">upsert</span><span class="hl-2">({ </span><span class="hl-5">id:</span><span class="hl-2"> </span><span class="hl-3">&quot;missing-no&quot;</span><span class="hl-2">, </span><span class="hl-5">name:</span><span class="hl-2"> </span><span class="hl-3">&quot;MissingNo&quot;</span><span class="hl-2"> })</span><br/><span class="hl-2"> .</span><span class="hl-1">then</span><span class="hl-2">((</span><span class="hl-5">upserted</span><span class="hl-2">) </span><span class="hl-6">=&gt;</span><span class="hl-2"> </span><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-5">upserted</span><span class="hl-2">));</span><br/><span class="hl-0">// Updates a resource - uses PATCH verb</span><br/><span class="hl-5">service</span><br/><span class="hl-2"> .</span><span class="hl-1">update</span><span class="hl-2">(</span><span class="hl-3">&quot;pikachu&quot;</span><span class="hl-2">, { </span><span class="hl-5">name:</span><span class="hl-2"> </span><span class="hl-3">&quot;Pika-who?&quot;</span><span class="hl-2"> })</span><br/><span class="hl-2"> .</span><span class="hl-1">then</span><span class="hl-2">((</span><span class="hl-5">updated</span><span class="hl-2">) </span><span class="hl-6">=&gt;</span><span class="hl-2"> </span><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-5">updated</span><span class="hl-2">));</span><br/><span class="hl-0">// Deletes a resource - uses DELETE verb</span><br/><span class="hl-5">service</span><br/><span class="hl-2"> .</span><span class="hl-1">delete</span><span class="hl-2">(</span><span class="hl-3">&quot;pikachu&quot;</span><span class="hl-2">)</span><br/><span class="hl-2"> .</span><span class="hl-1">then</span><span class="hl-2">(() </span><span class="hl-6">=&gt;</span><span class="hl-2"> </span><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-3">&quot;Pikachu has fainted from existence&quot;</span><span class="hl-2">));</span>
9
10
  </code><button type="button">Copy</button></pre>
10
11
 
11
12
  </section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/_zthun_webigail_rest.ZRestfulService.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZRestful<wbr/>Service</span></a>
@@ -15,4 +16,4 @@
15
16
  <a href="../interfaces/_zthun_webigail_rest.IZRestfulService.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZRestful<wbr/>Service</span></a>
16
17
  <a href="../interfaces/_zthun_webigail_rest.IZRestfulUpdate.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZRestful<wbr/>Update</span></a>
17
18
  <a href="../interfaces/_zthun_webigail_rest.IZRestfulUpsert.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZRestful<wbr/>Upsert</span></a>
18
- </div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:webigail-rest"><span>Webigail REST</span></a><ul><li><a href="#md:build-status"><span>Build <wbr/>Status</span></a></li><li><a href="#md:usage"><span>Usage</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Webigail</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
19
+ </div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:webigail-rest"><span>Webigail REST</span></a><ul><li><a href="#md:build-status"><span>Build <wbr/>Status</span></a></li><li><a href="#md:usage"><span>Usage</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Webigail</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
@@ -1,20 +1,21 @@
1
1
  <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@zthun/webigail-url | Webigail</title><meta name="description" content="Documentation for Webigail"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../webigail.svg" />
2
- </head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Webigail</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Webigail</a></li><li><a href="_zthun_webigail_url.html">@zthun/webigail-url</a></li></ul><h1>Module @zthun/webigail-url</h1></div><section class="tsd-panel tsd-typography"><a id="md:webigail-url" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Webigail URL<a href="#md:webigail-url" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p>It's easy to make mistakes when making REST invocations and public API calls. Webigail solves this by using the builder
3
- pattern to construct a full URL given different parts of a URI.</p>
4
- <a id="md:build-status" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Build Status<a href="#md:build-status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><a href="https://dl.circleci.com/status-badge/redirect/gh/zthun/webigail/tree/latest"><img src="https://dl.circleci.com/status-badge/img/gh/zthun/webigail/tree/latest.svg?style=shield" alt="CircleCI"></a></p>
2
+ </head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Webigail</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Webigail</a></li><li><a href="_zthun_webigail_url.html">@zthun/webigail-url</a></li></ul><h1>Module @zthun/webigail-url</h1></div><section class="tsd-panel tsd-typography"><a id="md:webigail-url" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Webigail URL<a href="#md:webigail-url" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p>It's easy to make mistakes when making REST invocations and public API calls.
3
+ Webigail solves this by using the builder pattern to construct a full URL given
4
+ different parts of a URI.</p>
5
+ <a id="md:build-status" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Build Status<a href="#md:build-status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><a href="https://dl.circleci.com/status-badge/redirect/gh/zthun/webigail/tree/latest" target="_blank" class="external"><img src="https://dl.circleci.com/status-badge/img/gh/zthun/webigail/tree/latest.svg?style=shield" alt="CircleCI"></a></p>
5
6
  <a id="md:usage" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Usage<a href="#md:usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Webigail is built in TypeScript and it exports both ESM and CJS modules.</p>
6
7
  <pre><code class="sh"><span class="hl-0"># NPM</span><br/><span class="hl-1">npm</span><span class="hl-2"> </span><span class="hl-3">install</span><span class="hl-2"> </span><span class="hl-3">@zthun/webigail-url</span><br/><span class="hl-0"># Yarn</span><br/><span class="hl-1">yarn</span><span class="hl-2"> </span><span class="hl-3">add</span><span class="hl-2"> </span><span class="hl-3">@zthun/webigail-url</span>
7
8
  </code><button type="button">Copy</button></pre>
8
9
 
9
- <pre><code class="ts"><span class="hl-4">import</span><span class="hl-2"> { </span><span class="hl-5">ZUrlBuilder</span><span class="hl-2"> } </span><span class="hl-4">from</span><span class="hl-2"> </span><span class="hl-3">&#39;@zthun/webigail-url&#39;</span><span class="hl-2">;</span><br/><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-8">url</span><span class="hl-2"> = </span><span class="hl-6">new</span><span class="hl-2"> </span><span class="hl-1">ZUrlBuilder</span><span class="hl-2">().</span><span class="hl-1">protocol</span><span class="hl-2">(</span><span class="hl-3">&#39;https&#39;</span><span class="hl-2">).</span><span class="hl-1">hostname</span><span class="hl-2">(</span><span class="hl-3">&#39;zthunworks.com&#39;</span><span class="hl-2">).</span><span class="hl-1">subdomain</span><span class="hl-2">(</span><span class="hl-3">&#39;webigail&#39;</span><span class="hl-2">).</span><span class="hl-1">build</span><span class="hl-2">();</span><br/><br/><span class="hl-0">// Outputs https://webigail.zthunworks.com</span><br/><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-5">url</span><span class="hl-2">);</span>
10
+ <pre><code class="ts"><span class="hl-4">import</span><span class="hl-2"> { </span><span class="hl-5">ZUrlBuilder</span><span class="hl-2"> } </span><span class="hl-4">from</span><span class="hl-2"> </span><span class="hl-3">&quot;@zthun/webigail-url&quot;</span><span class="hl-2">;</span><br/><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-8">url</span><span class="hl-2"> = </span><span class="hl-6">new</span><span class="hl-2"> </span><span class="hl-1">ZUrlBuilder</span><span class="hl-2">()</span><br/><span class="hl-2"> .</span><span class="hl-1">protocol</span><span class="hl-2">(</span><span class="hl-3">&quot;https&quot;</span><span class="hl-2">)</span><br/><span class="hl-2"> .</span><span class="hl-1">hostname</span><span class="hl-2">(</span><span class="hl-3">&quot;zthunworks.com&quot;</span><span class="hl-2">)</span><br/><span class="hl-2"> .</span><span class="hl-1">subdomain</span><span class="hl-2">(</span><span class="hl-3">&quot;webigail&quot;</span><span class="hl-2">)</span><br/><span class="hl-2"> .</span><span class="hl-1">build</span><span class="hl-2">();</span><br/><br/><span class="hl-0">// Outputs https://webigail.zthunworks.com</span><br/><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-5">url</span><span class="hl-2">);</span>
10
11
  </code><button type="button">Copy</button></pre>
11
12
 
12
13
  <p>There are also some utility functions for common use cases.</p>
13
- <pre><code class="ts"><span class="hl-4">import</span><span class="hl-2"> { </span><span class="hl-5">ZUrlBuilder</span><span class="hl-2"> } </span><span class="hl-4">from</span><span class="hl-2"> </span><span class="hl-3">&#39;@zthun/webigail-url&#39;</span><span class="hl-2">;</span><br/><br/><span class="hl-0">// Note: Browser only unless you&#39;re using jsdom in node. Outputs the current</span><br/><span class="hl-0">// browser location with /api appended to it.</span><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-8">locationUrl</span><span class="hl-2"> = </span><span class="hl-6">new</span><span class="hl-2"> </span><span class="hl-1">ZUrlBuilder</span><span class="hl-2">().</span><span class="hl-1">location</span><span class="hl-2">(</span><span class="hl-5">location</span><span class="hl-2">).</span><span class="hl-1">path</span><span class="hl-2">(</span><span class="hl-3">&#39;/api&#39;</span><span class="hl-2">).</span><span class="hl-1">build</span><span class="hl-2">();</span><br/><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-5">url</span><span class="hl-2">);</span><br/><br/><span class="hl-0">// Url for a persons gravatar if one exists.</span><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-8">avatar</span><span class="hl-2"> = </span><span class="hl-6">new</span><span class="hl-2"> </span><span class="hl-1">ZUrlBuilder</span><span class="hl-2">().</span><span class="hl-1">gravatar</span><span class="hl-2">(</span><span class="hl-1">md5</span><span class="hl-2">(</span><span class="hl-3">&#39;john-doe@gmail.com&#39;</span><span class="hl-2">), </span><span class="hl-9">256</span><span class="hl-2">).</span><span class="hl-1">build</span><span class="hl-2">();</span><br/><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-5">avatar</span><span class="hl-2">);</span><br/><br/><span class="hl-0">// Outputs the existing pieces of the url.</span><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-8">existingInfo</span><span class="hl-2"> = </span><span class="hl-6">new</span><span class="hl-2"> </span><span class="hl-1">ZUrlBuilder</span><span class="hl-2">().</span><span class="hl-1">parse</span><span class="hl-2">(</span><span class="hl-3">&#39;https://webigail.zthunworks.com/api/path?filter=hello&#39;</span><span class="hl-2">).</span><span class="hl-1">info</span><span class="hl-2">();</span><br/><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-5">existingInfo</span><span class="hl-2">);</span>
14
+ <pre><code class="ts"><span class="hl-4">import</span><span class="hl-2"> { </span><span class="hl-5">ZUrlBuilder</span><span class="hl-2"> } </span><span class="hl-4">from</span><span class="hl-2"> </span><span class="hl-3">&quot;@zthun/webigail-url&quot;</span><span class="hl-2">;</span><br/><br/><span class="hl-0">// Note: Browser only unless you&#39;re using jsdom in node. Outputs the current</span><br/><span class="hl-0">// browser location with /api appended to it.</span><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-8">locationUrl</span><span class="hl-2"> = </span><span class="hl-6">new</span><span class="hl-2"> </span><span class="hl-1">ZUrlBuilder</span><span class="hl-2">().</span><span class="hl-1">location</span><span class="hl-2">(</span><span class="hl-5">location</span><span class="hl-2">).</span><span class="hl-1">path</span><span class="hl-2">(</span><span class="hl-3">&quot;/api&quot;</span><span class="hl-2">).</span><span class="hl-1">build</span><span class="hl-2">();</span><br/><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-5">url</span><span class="hl-2">);</span><br/><br/><span class="hl-0">// Url for a persons gravatar if one exists.</span><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-8">avatar</span><span class="hl-2"> = </span><span class="hl-6">new</span><span class="hl-2"> </span><span class="hl-1">ZUrlBuilder</span><span class="hl-2">()</span><br/><span class="hl-2"> .</span><span class="hl-1">gravatar</span><span class="hl-2">(</span><span class="hl-1">md5</span><span class="hl-2">(</span><span class="hl-3">&quot;john-doe@gmail.com&quot;</span><span class="hl-2">), </span><span class="hl-9">256</span><span class="hl-2">)</span><br/><span class="hl-2"> .</span><span class="hl-1">build</span><span class="hl-2">();</span><br/><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-5">avatar</span><span class="hl-2">);</span><br/><br/><span class="hl-0">// Outputs the existing pieces of the url.</span><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-8">existingInfo</span><span class="hl-2"> = </span><span class="hl-6">new</span><span class="hl-2"> </span><span class="hl-1">ZUrlBuilder</span><span class="hl-2">()</span><br/><span class="hl-2"> .</span><span class="hl-1">parse</span><span class="hl-2">(</span><span class="hl-3">&quot;https://webigail.zthunworks.com/api/path?filter=hello&quot;</span><span class="hl-2">)</span><br/><span class="hl-2"> .</span><span class="hl-1">info</span><span class="hl-2">();</span><br/><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-5">existingInfo</span><span class="hl-2">);</span>
14
15
  </code><button type="button">Copy</button></pre>
15
16
 
16
17
  <a id="md:data-urls" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Data URLs<a href="#md:data-urls" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Webigail also supports building and parsing data urls as well.</p>
17
- <pre><code class="ts"><span class="hl-4">import</span><span class="hl-2"> { </span><span class="hl-5">ZDataUrlBuilder</span><span class="hl-2">, </span><span class="hl-5">ZMimeTypeApplication</span><span class="hl-2"> } </span><span class="hl-4">from</span><span class="hl-2"> </span><span class="hl-3">&#39;@zthun/webigail-url&#39;</span><span class="hl-2">;</span><br/><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-8">raw</span><span class="hl-2"> = </span><span class="hl-1">require</span><span class="hl-2">(</span><span class="hl-3">&#39;my-data.json&#39;</span><span class="hl-2">);</span><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-8">mimeType</span><span class="hl-2"> = </span><span class="hl-5">ZMimeTypeApplication</span><span class="hl-2">.</span><span class="hl-8">JSON</span><span class="hl-2">;</span><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-8">url</span><span class="hl-2"> = </span><span class="hl-6">new</span><span class="hl-2"> </span><span class="hl-1">ZDataUrlBuilder</span><span class="hl-2">().</span><span class="hl-1">mimeType</span><span class="hl-2">(</span><span class="hl-5">mimeType</span><span class="hl-2">).</span><span class="hl-1">buffer</span><span class="hl-2">(</span><span class="hl-5">Buffer</span><span class="hl-2">.</span><span class="hl-1">from</span><span class="hl-2">(</span><span class="hl-5">raw</span><span class="hl-2">)).</span><span class="hl-1">encode</span><span class="hl-2">(</span><span class="hl-3">&#39;base64&#39;</span><span class="hl-2">).</span><span class="hl-1">build</span><span class="hl-2">();</span><br/><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-5">url</span><span class="hl-2">);</span>
18
+ <pre><code class="ts"><span class="hl-4">import</span><span class="hl-2"> { </span><span class="hl-5">ZDataUrlBuilder</span><span class="hl-2">, </span><span class="hl-5">ZMimeTypeApplication</span><span class="hl-2"> } </span><span class="hl-4">from</span><span class="hl-2"> </span><span class="hl-3">&quot;@zthun/webigail-url&quot;</span><span class="hl-2">;</span><br/><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-8">raw</span><span class="hl-2"> = </span><span class="hl-1">require</span><span class="hl-2">(</span><span class="hl-3">&quot;my-data.json&quot;</span><span class="hl-2">);</span><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-8">mimeType</span><span class="hl-2"> = </span><span class="hl-5">ZMimeTypeApplication</span><span class="hl-2">.</span><span class="hl-8">JSON</span><span class="hl-2">;</span><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-8">url</span><span class="hl-2"> = </span><span class="hl-6">new</span><span class="hl-2"> </span><span class="hl-1">ZDataUrlBuilder</span><span class="hl-2">()</span><br/><span class="hl-2"> .</span><span class="hl-1">mimeType</span><span class="hl-2">(</span><span class="hl-5">mimeType</span><span class="hl-2">)</span><br/><span class="hl-2"> .</span><span class="hl-1">buffer</span><span class="hl-2">(</span><span class="hl-5">Buffer</span><span class="hl-2">.</span><span class="hl-1">from</span><span class="hl-2">(</span><span class="hl-5">raw</span><span class="hl-2">))</span><br/><span class="hl-2"> .</span><span class="hl-1">encode</span><span class="hl-2">(</span><span class="hl-3">&quot;base64&quot;</span><span class="hl-2">)</span><br/><span class="hl-2"> .</span><span class="hl-1">build</span><span class="hl-2">();</span><br/><span class="hl-5">console</span><span class="hl-2">.</span><span class="hl-1">log</span><span class="hl-2">(</span><span class="hl-5">url</span><span class="hl-2">);</span>
18
19
  </code><button type="button">Copy</button></pre>
19
20
 
20
21
  </section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumerations</h3><div class="tsd-index-list"><a href="../enums/_zthun_webigail_url.ZMimeTypeApplication.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>ZMime<wbr/>Type<wbr/>Application</span></a>
@@ -27,4 +28,4 @@ pattern to construct a full URL given different parts of a URI.</p>
27
28
  <a href="../interfaces/_zthun_webigail_url.IZUrlInfo.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZUrl<wbr/>Info</span></a>
28
29
  </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Type Aliases</h3><div class="tsd-index-list"><a href="../types/_zthun_webigail_url.ZMimeType.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>ZMime<wbr/>Type</span></a>
29
30
  </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Variables</h3><div class="tsd-index-list"><a href="../variables/_zthun_webigail_url.ZSupportedMimeTypes.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>ZSupported<wbr/>Mime<wbr/>Types</span></a>
30
- </div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:webigail-url"><span>Webigail URL</span></a><ul><li><a href="#md:build-status"><span>Build <wbr/>Status</span></a></li><li><a href="#md:usage"><span>Usage</span></a></li><li><a href="#md:data-urls"><span>Data URLs</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Webigail</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
31
+ </div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:webigail-url"><span>Webigail URL</span></a><ul><li><a href="#md:build-status"><span>Build <wbr/>Status</span></a></li><li><a href="#md:usage"><span>Usage</span></a></li><li><a href="#md:data-urls"><span>Data URLs</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Webigail</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
@@ -0,0 +1,2 @@
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Webigail</title><meta name="description" content="Documentation for Webigail"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="webigail.svg" />
2
+ </head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">Webigail</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="modules.html">Webigail</a></li></ul><h1>Webigail</h1></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>Webigail</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
@@ -1,3 +1,3 @@
1
1
  <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ZHttpCode | Webigail</title><meta name="description" content="Documentation for Webigail"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../webigail.svg" />
2
- </head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Webigail</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Webigail</a></li><li><a href="../modules/_zthun_webigail_http.html">@zthun/webigail-http</a></li><li><a href="_zthun_webigail_http.ZHttpCode.html">ZHttpCode</a></li></ul><h1>Type Alias ZHttpCode</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">ZHttp<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <br/><span>    </span><span class="tsd-signature-symbol">| </span><a href="../enums/_zthun_webigail_http.ZHttpCodeInformationalResponse.html" class="tsd-signature-type tsd-kind-enum">ZHttpCodeInformationalResponse</a><br/><span>    </span><span class="tsd-signature-symbol">| </span><a href="../enums/_zthun_webigail_http.ZHttpCodeSuccess.html" class="tsd-signature-type tsd-kind-enum">ZHttpCodeSuccess</a><br/><span>    </span><span class="tsd-signature-symbol">| </span><a href="../enums/_zthun_webigail_http.ZHttpCodeRedirection.html" class="tsd-signature-type tsd-kind-enum">ZHttpCodeRedirection</a><br/><span>    </span><span class="tsd-signature-symbol">| </span><a href="../enums/_zthun_webigail_http.ZHttpCodeClient.html" class="tsd-signature-type tsd-kind-enum">ZHttpCodeClient</a><br/><span>    </span><span class="tsd-signature-symbol">| </span><a href="../enums/_zthun_webigail_http.ZHttpCodeServer.html" class="tsd-signature-type tsd-kind-enum">ZHttpCodeServer</a></div><div class="tsd-comment tsd-typography"><p>Represents a category of http code.</p>
3
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/559871da9e5d29049ebca34c00f257ce0c0718bc/packages/webigail-http/src/result/http-code.mts#L18">result/http-code.mts:18</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Webigail</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
2
+ </head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Webigail</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Webigail</a></li><li><a href="../modules/_zthun_webigail_http.html">@zthun/webigail-http</a></li><li><a href="_zthun_webigail_http.ZHttpCode.html">ZHttpCode</a></li></ul><h1>Type Alias ZHttpCode</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">ZHttp<wbr/>Code</span><span class="tsd-signature-symbol">:</span> <br/><span>    </span><span class="tsd-signature-symbol">| </span><a href="../enums/_zthun_webigail_http.ZHttpCodeInformationalResponse.html" class="tsd-signature-type tsd-kind-enum">ZHttpCodeInformationalResponse</a><br/><span>    </span><span class="tsd-signature-symbol">| </span><a href="../enums/_zthun_webigail_http.ZHttpCodeSuccess.html" class="tsd-signature-type tsd-kind-enum">ZHttpCodeSuccess</a><br/><span>    </span><span class="tsd-signature-symbol">| </span><a href="../enums/_zthun_webigail_http.ZHttpCodeRedirection.html" class="tsd-signature-type tsd-kind-enum">ZHttpCodeRedirection</a><br/><span>    </span><span class="tsd-signature-symbol">| </span><a href="../enums/_zthun_webigail_http.ZHttpCodeClient.html" class="tsd-signature-type tsd-kind-enum">ZHttpCodeClient</a><br/><span>    </span><span class="tsd-signature-symbol">| </span><a href="../enums/_zthun_webigail_http.ZHttpCodeServer.html" class="tsd-signature-type tsd-kind-enum">ZHttpCodeServer</a></div><div class="tsd-comment tsd-typography"><p>Represents a category of http code.</p>
3
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/2018b1ae6c4c7541da1052450896da8c16993859/packages/webigail-http/src/result/http-code.mts#L30">result/http-code.mts:30</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Webigail</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
@@ -1,3 +1,3 @@
1
1
  <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ZMimeType | Webigail</title><meta name="description" content="Documentation for Webigail"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../webigail.svg" />
2
- </head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Webigail</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Webigail</a></li><li><a href="../modules/_zthun_webigail_url.html">@zthun/webigail-url</a></li><li><a href="_zthun_webigail_url.ZMimeType.html">ZMimeType</a></li></ul><h1>Type Alias ZMimeType</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">ZMime<wbr/>Type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/_zthun_webigail_url.ZMimeTypeApplication.html" class="tsd-signature-type tsd-kind-enum">ZMimeTypeApplication</a><span class="tsd-signature-symbol"> | </span><a href="../enums/_zthun_webigail_url.ZMimeTypeText.html" class="tsd-signature-type tsd-kind-enum">ZMimeTypeText</a><span class="tsd-signature-symbol"> | </span><a href="../enums/_zthun_webigail_url.ZMimeTypeImage.html" class="tsd-signature-type tsd-kind-enum">ZMimeTypeImage</a></div><div class="tsd-comment tsd-typography"><p>Mime types for file data.</p>
3
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/559871da9e5d29049ebca34c00f257ce0c0718bc/packages/webigail-url/src/mime/mime-type.mts#L9">mime/mime-type.mts:9</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Webigail</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
2
+ </head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Webigail</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Webigail</a></li><li><a href="../modules/_zthun_webigail_url.html">@zthun/webigail-url</a></li><li><a href="_zthun_webigail_url.ZMimeType.html">ZMimeType</a></li></ul><h1>Type Alias ZMimeType</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">ZMime<wbr/>Type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/_zthun_webigail_url.ZMimeTypeApplication.html" class="tsd-signature-type tsd-kind-enum">ZMimeTypeApplication</a><span class="tsd-signature-symbol"> | </span><a href="../enums/_zthun_webigail_url.ZMimeTypeText.html" class="tsd-signature-type tsd-kind-enum">ZMimeTypeText</a><span class="tsd-signature-symbol"> | </span><a href="../enums/_zthun_webigail_url.ZMimeTypeImage.html" class="tsd-signature-type tsd-kind-enum">ZMimeTypeImage</a></div><div class="tsd-comment tsd-typography"><p>Mime types for file data.</p>
3
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/2018b1ae6c4c7541da1052450896da8c16993859/packages/webigail-url/src/mime/mime-type.mts#L9">mime/mime-type.mts:9</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Webigail</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
@@ -1,3 +1,3 @@
1
1
  <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ZHttpCodeClientDescriptions | Webigail</title><meta name="description" content="Documentation for Webigail"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../webigail.svg" />
2
- </head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Webigail</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Webigail</a></li><li><a href="../modules/_zthun_webigail_http.html">@zthun/webigail-http</a></li><li><a href="_zthun_webigail_http.ZHttpCodeClientDescriptions.html">ZHttpCodeClientDescriptions</a></li></ul><h1>Variable ZHttpCodeClientDescriptions<code class="tsd-tag">Const</code></h1></div><div class="tsd-signature"><span class="tsd-kind-variable">ZHttp<wbr/>Code<wbr/>Client<wbr/>Descriptions</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><a href="../enums/_zthun_webigail_http.ZHttpCodeClient.html" class="tsd-signature-type tsd-kind-enum">ZHttpCodeClient</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>English friendly descriptions of HttpClientCodes</p>
3
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/559871da9e5d29049ebca34c00f257ce0c0718bc/packages/webigail-http/src/result/http-code-client.mts#L216">result/http-code-client.mts:216</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Webigail</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
2
+ </head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Webigail</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Webigail</a></li><li><a href="../modules/_zthun_webigail_http.html">@zthun/webigail-http</a></li><li><a href="_zthun_webigail_http.ZHttpCodeClientDescriptions.html">ZHttpCodeClientDescriptions</a></li></ul><h1>Variable ZHttpCodeClientDescriptions<code class="tsd-tag">Const</code></h1></div><div class="tsd-signature"><span class="tsd-kind-variable">ZHttp<wbr/>Code<wbr/>Client<wbr/>Descriptions</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><a href="../enums/_zthun_webigail_http.ZHttpCodeClient.html" class="tsd-signature-type tsd-kind-enum">ZHttpCodeClient</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>English friendly descriptions of HttpClientCodes</p>
3
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/2018b1ae6c4c7541da1052450896da8c16993859/packages/webigail-http/src/result/http-code-client.mts#L218">result/http-code-client.mts:218</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Webigail</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
@@ -1,3 +1,3 @@
1
1
  <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ZHttpCodeClientNames | Webigail</title><meta name="description" content="Documentation for Webigail"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../webigail.svg" />
2
- </head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Webigail</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Webigail</a></li><li><a href="../modules/_zthun_webigail_http.html">@zthun/webigail-http</a></li><li><a href="_zthun_webigail_http.ZHttpCodeClientNames.html">ZHttpCodeClientNames</a></li></ul><h1>Variable ZHttpCodeClientNames<code class="tsd-tag">Const</code></h1></div><div class="tsd-signature"><span class="tsd-kind-variable">ZHttp<wbr/>Code<wbr/>Client<wbr/>Names</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><a href="../enums/_zthun_webigail_http.ZHttpCodeClient.html" class="tsd-signature-type tsd-kind-enum">ZHttpCodeClient</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>English friendly names of the codes.</p>
3
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/559871da9e5d29049ebca34c00f257ce0c0718bc/packages/webigail-http/src/result/http-code-client.mts#L182">result/http-code-client.mts:182</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Webigail</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
2
+ </head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Webigail</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Webigail</a></li><li><a href="../modules/_zthun_webigail_http.html">@zthun/webigail-http</a></li><li><a href="_zthun_webigail_http.ZHttpCodeClientNames.html">ZHttpCodeClientNames</a></li></ul><h1>Variable ZHttpCodeClientNames<code class="tsd-tag">Const</code></h1></div><div class="tsd-signature"><span class="tsd-kind-variable">ZHttp<wbr/>Code<wbr/>Client<wbr/>Names</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><a href="../enums/_zthun_webigail_http.ZHttpCodeClient.html" class="tsd-signature-type tsd-kind-enum">ZHttpCodeClient</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>English friendly names of the codes.</p>
3
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/2018b1ae6c4c7541da1052450896da8c16993859/packages/webigail-http/src/result/http-code-client.mts#L182">result/http-code-client.mts:182</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Webigail</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>