@zthun/webigail-web 3.1.2 → 3.2.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.
- package/LICENSE +13 -14
- package/dist/assets/hierarchy.js +1 -0
- package/dist/assets/icons.js +1 -1
- package/dist/assets/icons.svg +1 -1
- package/dist/assets/main.js +5 -5
- package/dist/assets/navigation.js +1 -1
- package/dist/assets/search.js +1 -1
- package/dist/assets/style.css +1405 -1288
- package/dist/classes/{_zthun_webigail_http.ZHttpRequestBuilder.html → _zthun_webigail-http.ZHttpRequestBuilder.html} +45 -46
- package/dist/classes/_zthun_webigail-http.ZHttpResultBuilder.html +20 -0
- package/dist/classes/_zthun_webigail-http.ZHttpService.html +6 -0
- package/dist/classes/_zthun_webigail-http.ZHttpServiceMock.html +14 -0
- package/dist/classes/_zthun_webigail-nest.ZHttpModule.html +3 -0
- package/dist/classes/_zthun_webigail-rest.ZRestfulService.html +55 -0
- package/dist/classes/_zthun_webigail-rest.ZRestfulUrlBuilder.html +17 -0
- package/dist/classes/{_zthun_webigail_url.ZDataUrlBuilder.html → _zthun_webigail-url.ZDataUrlBuilder.html} +19 -20
- package/dist/classes/{_zthun_webigail_url.ZUrlBuilder.html → _zthun_webigail-url.ZUrlBuilder.html} +74 -75
- package/dist/enums/{_zthun_webigail_http.ZHttpCodeCategory.html → _zthun_webigail-http.ZHttpCodeCategory.html} +12 -13
- package/dist/enums/{_zthun_webigail_http.ZHttpCodeClient.html → _zthun_webigail-http.ZHttpCodeClient.html} +59 -60
- package/dist/enums/{_zthun_webigail_http.ZHttpCodeInformationalResponse.html → _zthun_webigail-http.ZHttpCodeInformationalResponse.html} +10 -11
- package/dist/enums/{_zthun_webigail_http.ZHttpCodeRedirection.html → _zthun_webigail-http.ZHttpCodeRedirection.html} +20 -21
- package/dist/enums/{_zthun_webigail_http.ZHttpCodeServer.html → _zthun_webigail-http.ZHttpCodeServer.html} +24 -25
- package/dist/enums/{_zthun_webigail_http.ZHttpCodeSeverity.html → _zthun_webigail-http.ZHttpCodeSeverity.html} +10 -11
- package/dist/enums/{_zthun_webigail_http.ZHttpCodeSuccess.html → _zthun_webigail-http.ZHttpCodeSuccess.html} +22 -23
- package/dist/enums/{_zthun_webigail_http.ZHttpMethod.html → _zthun_webigail-http.ZHttpMethod.html} +16 -17
- package/dist/enums/{_zthun_webigail_url.ZMimeTypeApplication.html → _zthun_webigail-url.ZMimeTypeApplication.html} +8 -9
- package/dist/enums/{_zthun_webigail_url.ZMimeTypeImage.html → _zthun_webigail-url.ZMimeTypeImage.html} +16 -17
- package/dist/enums/{_zthun_webigail_url.ZMimeTypeText.html → _zthun_webigail-url.ZMimeTypeText.html} +16 -17
- package/dist/enums/{_zthun_webigail_url.ZYouTubeApi.html → _zthun_webigail-url.ZYouTubeApi.html} +6 -7
- package/dist/functions/_zthun_webigail-http.fromContentType.html +4 -0
- package/dist/functions/_zthun_webigail-http.getHttpCodeCategory.html +4 -0
- package/dist/functions/_zthun_webigail-http.getHttpCodeDescription.html +4 -0
- package/dist/functions/_zthun_webigail-http.getHttpCodeName.html +4 -0
- package/dist/functions/_zthun_webigail-http.getHttpCodeSeverity.html +4 -0
- package/dist/functions/_zthun_webigail-http.isBodyInit.html +6 -0
- package/dist/functions/_zthun_webigail-http.toBodyInit.html +8 -0
- package/dist/hierarchy.html +1 -2
- package/dist/index.html +4 -5
- package/dist/interfaces/{_zthun_webigail_http.IZHttpRequest.html → _zthun_webigail-http.IZHttpRequest.html} +12 -13
- package/dist/interfaces/{_zthun_webigail_http.IZHttpResult.html → _zthun_webigail-http.IZHttpResult.html} +8 -9
- package/dist/interfaces/_zthun_webigail-http.IZHttpService.html +8 -0
- package/dist/interfaces/_zthun_webigail-rest.IZRestfulCreate.html +8 -0
- package/dist/interfaces/_zthun_webigail-rest.IZRestfulDelete.html +6 -0
- package/dist/interfaces/_zthun_webigail-rest.IZRestfulGet.html +8 -0
- package/dist/interfaces/_zthun_webigail-rest.IZRestfulService.html +42 -0
- package/dist/interfaces/_zthun_webigail-rest.IZRestfulUpdate.html +9 -0
- package/dist/interfaces/_zthun_webigail-rest.IZRestfulUpsert.html +11 -0
- package/dist/interfaces/{_zthun_webigail_url.IZDataUrlInfo.html → _zthun_webigail-url.IZDataUrlInfo.html} +7 -8
- package/dist/interfaces/{_zthun_webigail_url.IZUrlInfo.html → _zthun_webigail-url.IZUrlInfo.html} +17 -18
- package/dist/modules/_zthun_webigail-http.html +22 -0
- package/dist/modules/_zthun_webigail-nest.html +13 -0
- package/dist/modules/_zthun_webigail-rest.html +11 -0
- package/dist/modules/_zthun_webigail-url.html +20 -0
- package/dist/modules.html +1 -2
- package/dist/types/_zthun_webigail-http.ZHttpCode.html +2 -0
- package/dist/types/_zthun_webigail-url.ZMimeType.html +2 -0
- package/dist/variables/_zthun_webigail-http.ZHttpCodeClientDescriptions.html +2 -0
- package/dist/variables/_zthun_webigail-http.ZHttpCodeClientNames.html +2 -0
- package/dist/variables/_zthun_webigail-http.ZHttpCodeInformationalResponseDescriptions.html +2 -0
- package/dist/variables/_zthun_webigail-http.ZHttpCodeInformationalResponseNames.html +2 -0
- package/dist/variables/_zthun_webigail-http.ZHttpCodeRedirectionDescriptions.html +2 -0
- package/dist/variables/_zthun_webigail-http.ZHttpCodeRedirectionNames.html +2 -0
- package/dist/variables/_zthun_webigail-http.ZHttpCodeServerDescriptions.html +2 -0
- package/dist/variables/_zthun_webigail-http.ZHttpCodeServerNames.html +2 -0
- package/dist/variables/_zthun_webigail-http.ZHttpCodeSuccessDescriptions.html +2 -0
- package/dist/variables/_zthun_webigail-http.ZHttpCodeSuccessNames.html +2 -0
- package/dist/variables/_zthun_webigail-nest.ZHttpServiceToken.html +2 -0
- package/dist/variables/_zthun_webigail-url.ZSupportedMimeTypes.html +2 -0
- package/package.json +8 -11
- package/dist/classes/_zthun_webigail_http.ZHttpResultBuilder.html +0 -21
- package/dist/classes/_zthun_webigail_http.ZHttpService.html +0 -7
- package/dist/classes/_zthun_webigail_http.ZHttpServiceMock.html +0 -15
- package/dist/classes/_zthun_webigail_nest.ZHttpModule.html +0 -4
- package/dist/classes/_zthun_webigail_rest.ZRestfulService.html +0 -56
- package/dist/functions/_zthun_webigail_http.fromContentType.html +0 -5
- package/dist/functions/_zthun_webigail_http.getHttpCodeCategory.html +0 -5
- package/dist/functions/_zthun_webigail_http.getHttpCodeDescription.html +0 -5
- package/dist/functions/_zthun_webigail_http.getHttpCodeName.html +0 -5
- package/dist/functions/_zthun_webigail_http.getHttpCodeSeverity.html +0 -5
- package/dist/functions/_zthun_webigail_http.isBodyInit.html +0 -7
- package/dist/functions/_zthun_webigail_http.toBodyInit.html +0 -9
- package/dist/interfaces/_zthun_webigail_http.IZHttpService.html +0 -9
- package/dist/interfaces/_zthun_webigail_rest.IZRestfulCreate.html +0 -9
- package/dist/interfaces/_zthun_webigail_rest.IZRestfulDelete.html +0 -7
- package/dist/interfaces/_zthun_webigail_rest.IZRestfulGet.html +0 -9
- package/dist/interfaces/_zthun_webigail_rest.IZRestfulService.html +0 -43
- package/dist/interfaces/_zthun_webigail_rest.IZRestfulUpdate.html +0 -10
- package/dist/interfaces/_zthun_webigail_rest.IZRestfulUpsert.html +0 -12
- package/dist/modules/_zthun_webigail_http.html +0 -56
- package/dist/modules/_zthun_webigail_nest.html +0 -16
- package/dist/modules/_zthun_webigail_rest.html +0 -19
- package/dist/modules/_zthun_webigail_url.html +0 -31
- package/dist/types/_zthun_webigail_http.ZHttpCode.html +0 -3
- package/dist/types/_zthun_webigail_url.ZMimeType.html +0 -3
- package/dist/variables/_zthun_webigail_http.ZHttpCodeClientDescriptions.html +0 -3
- package/dist/variables/_zthun_webigail_http.ZHttpCodeClientNames.html +0 -3
- package/dist/variables/_zthun_webigail_http.ZHttpCodeInformationalResponseDescriptions.html +0 -3
- package/dist/variables/_zthun_webigail_http.ZHttpCodeInformationalResponseNames.html +0 -3
- package/dist/variables/_zthun_webigail_http.ZHttpCodeRedirectionDescriptions.html +0 -3
- package/dist/variables/_zthun_webigail_http.ZHttpCodeRedirectionNames.html +0 -3
- package/dist/variables/_zthun_webigail_http.ZHttpCodeServerDescriptions.html +0 -3
- package/dist/variables/_zthun_webigail_http.ZHttpCodeServerNames.html +0 -3
- package/dist/variables/_zthun_webigail_http.ZHttpCodeSuccessDescriptions.html +0 -3
- package/dist/variables/_zthun_webigail_http.ZHttpCodeSuccessNames.html +0 -3
- package/dist/variables/_zthun_webigail_nest.ZHttpServiceToken.html +0 -3
- package/dist/variables/_zthun_webigail_url.ZSupportedMimeTypes.html +0 -3
- /package/dist/{webigail.svg → assets/favicon.svg} +0 -0
package/dist/interfaces/{_zthun_webigail_url.IZUrlInfo.html → _zthun_webigail-url.IZUrlInfo.html}
RENAMED
|
@@ -1,21 +1,20 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IZUrlInfo | 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><
|
|
2
|
-
</
|
|
3
|
-
|
|
4
|
-
<a href="
|
|
5
|
-
<a href="
|
|
6
|
-
<a href="
|
|
7
|
-
<a href="
|
|
8
|
-
<a href="
|
|
9
|
-
<a href="
|
|
10
|
-
<a href="_zthun_webigail_url.IZUrlInfo.html#username" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>username?</span></a>
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IZUrlInfo | Webigail</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></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"><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.IZUrlInfo.html">IZUrlInfo</a></li></ul><h1>Interface IZUrlInfo</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents information about a url.</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">IZUrlInfo</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="_zthun_webigail-url.IZUrlInfo.html#hash">hash</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_webigail-url.IZUrlInfo.html#hostname">hostname</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_webigail-url.IZUrlInfo.html#params">params</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">val</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_webigail-url.IZUrlInfo.html#password">password</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_webigail-url.IZUrlInfo.html#path">path</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_webigail-url.IZUrlInfo.html#port">port</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_webigail-url.IZUrlInfo.html#protocol">protocol</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_webigail-url.IZUrlInfo.html#username">username</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/caccb994a5f400344c17102e3008ec3abd6dfa98/packages/webigail-url/src/url/url.mts#L7">url/url.mts:7</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_zthun_webigail-url.IZUrlInfo.html#hash" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hash?</span></a>
|
|
3
|
+
<a href="_zthun_webigail-url.IZUrlInfo.html#hostname" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hostname</span></a>
|
|
4
|
+
<a href="_zthun_webigail-url.IZUrlInfo.html#params" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>params</span></a>
|
|
5
|
+
<a href="_zthun_webigail-url.IZUrlInfo.html#password" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>password?</span></a>
|
|
6
|
+
<a href="_zthun_webigail-url.IZUrlInfo.html#path" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>path</span></a>
|
|
7
|
+
<a href="_zthun_webigail-url.IZUrlInfo.html#port" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>port?</span></a>
|
|
8
|
+
<a href="_zthun_webigail-url.IZUrlInfo.html#protocol" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>protocol</span></a>
|
|
9
|
+
<a href="_zthun_webigail-url.IZUrlInfo.html#username" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>username?</span></a>
|
|
11
10
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="hash" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>hash</span><a href="#hash" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hash</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The client side hash route.</p>
|
|
12
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
13
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
14
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
15
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
11
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/caccb994a5f400344c17102e3008ec3abd6dfa98/packages/webigail-url/src/url/url.mts#L44">url/url.mts:44</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="hostname" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>hostname</span><a href="#hostname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hostname</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The host.</p>
|
|
12
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/caccb994a5f400344c17102e3008ec3abd6dfa98/packages/webigail-url/src/url/url.mts#L26">url/url.mts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="params" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>params</span><a href="#params" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">params</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">val</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The key value params.</p>
|
|
13
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/caccb994a5f400344c17102e3008ec3abd6dfa98/packages/webigail-url/src/url/url.mts#L49">url/url.mts:49</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="password" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>password</span><a href="#password" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">password</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The password.</p>
|
|
14
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/caccb994a5f400344c17102e3008ec3abd6dfa98/packages/webigail-url/src/url/url.mts#L21">url/url.mts:21</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="path" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>path</span><a href="#path" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>A list of current paths.</p>
|
|
16
15
|
<p>You can always get the full path using
|
|
17
16
|
path.join('/')</p>
|
|
18
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
19
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
20
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
21
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
17
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/caccb994a5f400344c17102e3008ec3abd6dfa98/packages/webigail-url/src/url/url.mts#L39">url/url.mts:39</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="port" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>port</span><a href="#port" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">port</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The port number.</p>
|
|
18
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/caccb994a5f400344c17102e3008ec3abd6dfa98/packages/webigail-url/src/url/url.mts#L31">url/url.mts:31</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="protocol" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>protocol</span><a href="#protocol" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">protocol</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The protocol for the url.</p>
|
|
19
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/caccb994a5f400344c17102e3008ec3abd6dfa98/packages/webigail-url/src/url/url.mts#L11">url/url.mts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="username" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>username</span><a href="#username" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The username.</p>
|
|
20
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/caccb994a5f400344c17102e3008ec3abd6dfa98/packages/webigail-url/src/url/url.mts#L16">url/url.mts:16</a></li></ul></aside></section></section></details></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"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#hash" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hash</span></a><a href="#hostname" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hostname</span></a><a href="#params" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>params</span></a><a href="#password" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>password</span></a><a href="#path" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>path</span></a><a href="#port" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>port</span></a><a href="#protocol" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>protocol</span></a><a href="#username" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>username</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Webigail</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><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,22 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@zthun/webigail-http | Webigail</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></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"><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-http.html">@zthun/webigail-http</a></li></ul><h1>Module @zthun/webigail-http</h1></div><section class="tsd-panel tsd-typography"><a id="webigail-http" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Webigail Http<a href="#webigail-http" 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>There's many libraries for invoking http requests such as axios, node-fetch, and
|
|
2
|
+
the built in fetch api. These work, but don't make it easy to do dependency
|
|
3
|
+
injection.</p>
|
|
4
|
+
<p>The webigail-http package uses an interface + class based approach to http
|
|
5
|
+
requests which makes dependency injection much easier.</p>
|
|
6
|
+
<a id="build-status" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Build Status<a href="#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>
|
|
7
|
+
<a id="usage" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Usage<a href="#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>
|
|
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-http</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-http</span>
|
|
9
|
+
</code><button type="button">Copy</button></pre>
|
|
10
|
+
|
|
11
|
+
<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">"@zthun/webigail-url"</span><span class="hl-2">;</span><br/><span class="hl-4">import</span><span class="hl-2"> { </span><span class="hl-5">IZHttpService</span><span class="hl-2">, </span><span class="hl-5">ZHttpRequestBuilder</span><span class="hl-2"> } </span><span class="hl-4">from</span><span class="hl-2"> </span><span class="hl-3">"@zthun/webigail-http"</span><span class="hl-2">;</span><br/><span class="hl-4">import</span><span class="hl-2"> { </span><span class="hl-5">Product</span><span class="hl-2"> } </span><span class="hl-4">from</span><span class="hl-2"> </span><span class="hl-3">"../models/product"</span><span class="hl-2">;</span><br/><br/><span class="hl-4">export</span><span class="hl-2"> </span><span class="hl-6">class</span><span class="hl-2"> </span><span class="hl-7">ProductService</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-6">public</span><span class="hl-2"> </span><span class="hl-6">constructor</span><span class="hl-2">(</span><span class="hl-6">private</span><span class="hl-2"> </span><span class="hl-5">_http</span><span class="hl-2">: </span><span class="hl-7">IZHttpService</span><span class="hl-2">) {}</span><br/><br/><span class="hl-2"> </span><span class="hl-6">public</span><span class="hl-2"> </span><span class="hl-6">static</span><span class="hl-2"> </span><span class="hl-1">endpoint</span><span class="hl-2">(): </span><span class="hl-7">string</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><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">api</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">"users"</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-4">return</span><span class="hl-2"> </span><span class="hl-5">url</span><span class="hl-2">;</span><br/><span class="hl-2"> }</span><br/><br/><span class="hl-2"> </span><span class="hl-6">public</span><span class="hl-2"> </span><span class="hl-1">list</span><span class="hl-2">(): </span><span class="hl-7">Promise</span><span class="hl-2"><</span><span class="hl-7">Product</span><span class="hl-2">> {</span><br/><span class="hl-2"> </span><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-8">request</span><span class="hl-2"> = </span><span class="hl-6">new</span><span class="hl-2"> </span><span class="hl-1">ZHttpRequestBuilder</span><span class="hl-2">()</span><br/><span class="hl-2"> .</span><span class="hl-1">url</span><span class="hl-2">(</span><span class="hl-5">ProductService</span><span class="hl-2">.</span><span class="hl-1">endpoint</span><span class="hl-2">())</span><br/><span class="hl-2"> .</span><span class="hl-1">get</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-2"> </span><span class="hl-6">const</span><span class="hl-2"> { </span><span class="hl-8">data</span><span class="hl-2"> } = </span><span class="hl-6">this</span><span class="hl-2">.</span><span class="hl-5">_http</span><span class="hl-2">.</span><span class="hl-1">request</span><span class="hl-2"><</span><span class="hl-7">Product</span><span class="hl-2">>(</span><span class="hl-5">request</span><span class="hl-2">);</span><br/><span class="hl-2"> </span><span class="hl-4">return</span><span class="hl-2"> </span><span class="hl-5">data</span><span class="hl-2">;</span><br/><span class="hl-2"> }</span><br/><br/><span class="hl-2"> </span><span class="hl-6">public</span><span class="hl-2"> </span><span class="hl-1">create</span><span class="hl-2">(</span><span class="hl-5">product</span><span class="hl-2">: </span><span class="hl-7">Product</span><span class="hl-2">): </span><span class="hl-7">Promise</span><span class="hl-2"><</span><span class="hl-7">Product</span><span class="hl-2">> {</span><br/><span class="hl-2"> </span><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-8">request</span><span class="hl-2"> = </span><span class="hl-6">new</span><span class="hl-2"> </span><span class="hl-1">ZHttpRequestBuilder</span><span class="hl-2">()</span><br/><span class="hl-2"> .</span><span class="hl-1">url</span><span class="hl-2">(</span><span class="hl-5">ProductService</span><span class="hl-2">.</span><span class="hl-1">endpoint</span><span class="hl-2">())</span><br/><span class="hl-2"> .</span><span class="hl-1">post</span><span class="hl-2">(</span><span class="hl-5">product</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-2"> </span><span class="hl-6">const</span><span class="hl-2"> { </span><span class="hl-8">data</span><span class="hl-2"> } = </span><span class="hl-6">this</span><span class="hl-2">.</span><span class="hl-5">_http</span><span class="hl-2">.</span><span class="hl-1">request</span><span class="hl-2"><</span><span class="hl-7">Product</span><span class="hl-2">>(</span><span class="hl-5">request</span><span class="hl-2">);</span><br/><span class="hl-2"> </span><span class="hl-4">return</span><span class="hl-2"> </span><span class="hl-5">data</span><span class="hl-2">;</span><br/><span class="hl-2"> }</span><br/><span class="hl-2">}</span><br/><br/><span class="hl-0">// Somewhere at the root of your application.</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">"@zthun/webigail-http"</span><span class="hl-2">;</span><br/><br/><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-8">product</span><span class="hl-2"> = </span><span class="hl-6">new</span><span class="hl-2"> </span><span class="hl-1">ProductService</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>
|
|
12
|
+
</code><button type="button">Copy</button></pre>
|
|
13
|
+
|
|
14
|
+
<a id="testing" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Testing<a href="#testing" 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>One challenge with dealing with http services and functions in tests is mocking
|
|
15
|
+
API calls. You can override functions like get, post, but if you want to respond
|
|
16
|
+
to different URL invocations, then it can become a bit of a pain to do so.
|
|
17
|
+
Instead of having to create a mock and shuffle the http service implementations,
|
|
18
|
+
this package also includes a mock implementation of the http service.</p>
|
|
19
|
+
<pre><code class="ts"><span class="hl-4">import</span><span class="hl-2"> { </span><span class="hl-5">createGuid</span><span class="hl-2"> } </span><span class="hl-4">from</span><span class="hl-2"> </span><span class="hl-3">"@zthun/helpful-fn"</span><span class="hl-2">;</span><br/><span class="hl-4">import</span><span class="hl-2"> { </span><span class="hl-5">ZHttpServiceMock</span><span class="hl-2"> } </span><span class="hl-4">from</span><span class="hl-2"> </span><span class="hl-3">"@zthun/webigail-http"</span><span class="hl-2">;</span><br/><br/><span class="hl-1">describe</span><span class="hl-2">(</span><span class="hl-3">"ProductService"</span><span class="hl-2">, () </span><span class="hl-6">=></span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-6">let</span><span class="hl-2"> </span><span class="hl-5">http</span><span class="hl-2">: </span><span class="hl-7">ZHttpServiceMock</span><span class="hl-2">;</span><br/><br/><span class="hl-2"> </span><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-1">createTestTarget</span><span class="hl-2"> = () </span><span class="hl-6">=></span><span class="hl-2"> </span><span class="hl-6">new</span><span class="hl-2"> </span><span class="hl-1">ProductService</span><span class="hl-2">(</span><span class="hl-5">http</span><span class="hl-2">);</span><br/><br/><span class="hl-2"> </span><span class="hl-1">beforeEach</span><span class="hl-2">(() </span><span class="hl-6">=></span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-5">http</span><span class="hl-2"> = </span><span class="hl-6">new</span><span class="hl-2"> </span><span class="hl-1">ZHttpServiceMock</span><span class="hl-2">();</span><br/><br/><span class="hl-2"> </span><span class="hl-5">http</span><span class="hl-2">.</span><span class="hl-1">set</span><span class="hl-2">(</span><br/><span class="hl-2"> </span><span class="hl-5">ProductService</span><span class="hl-2">.</span><span class="hl-1">endpoint</span><span class="hl-2">(),</span><br/><span class="hl-2"> </span><span class="hl-5">ZHttpMethod</span><span class="hl-2">.</span><span class="hl-5">Get</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">new</span><span class="hl-2"> </span><span class="hl-1">ZHttpResultBuilder</span><span class="hl-2"><</span><span class="hl-7">User</span><span class="hl-2">>()</span><br/><span class="hl-2"> .</span><span class="hl-1">data</span><span class="hl-2">([</span><span class="hl-1">createMockExistingUser</span><span class="hl-2">(), </span><span class="hl-1">createMockExistingUser</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-2"> );</span><br/><br/><span class="hl-2"> </span><span class="hl-5">http</span><span class="hl-2">.</span><span class="hl-1">set</span><span class="hl-2">(</span><span class="hl-5">ProductService</span><span class="hl-2">.</span><span class="hl-1">endpoint</span><span class="hl-2">(), </span><span class="hl-5">ZHttpMethod</span><span class="hl-2">.</span><span class="hl-5">Post</span><span class="hl-2">, (</span><span class="hl-5">r</span><span class="hl-2">) </span><span class="hl-6">=></span><br/><span class="hl-2"> </span><span class="hl-6">new</span><span class="hl-2"> </span><span class="hl-1">ZHttpResultBuilder</span><span class="hl-2"><</span><span class="hl-7">User</span><span class="hl-2">>()</span><br/><span class="hl-2"> .</span><span class="hl-1">data</span><span class="hl-2">(</span><span class="hl-5">Object</span><span class="hl-2">.</span><span class="hl-1">assign</span><span class="hl-2">({}, </span><span class="hl-5">r</span><span class="hl-2">.</span><span class="hl-5">body</span><span class="hl-2">!, { </span><span class="hl-5">id:</span><span class="hl-2"> </span><span class="hl-1">createGuid</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-2"> );</span><br/><span class="hl-2"> });</span><br/><br/><span class="hl-2"> </span><span class="hl-1">it</span><span class="hl-2">(</span><span class="hl-3">"should retrieve the list of users"</span><span class="hl-2">, </span><span class="hl-6">async</span><span class="hl-2"> () </span><span class="hl-6">=></span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-0">// Arrange.</span><br/><span class="hl-2"> </span><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-8">target</span><span class="hl-2"> = </span><span class="hl-1">createTestTarget</span><span class="hl-2">();</span><br/><span class="hl-2"> </span><span class="hl-0">// Act.</span><br/><span class="hl-2"> </span><span class="hl-6">const</span><span class="hl-2"> </span><span class="hl-8">actual</span><span class="hl-2"> = </span><span class="hl-4">await</span><span class="hl-2"> </span><span class="hl-5">target</span><span class="hl-2">.</span><span class="hl-1">list</span><span class="hl-2">();</span><br/><span class="hl-2"> </span><span class="hl-0">// Assert.</span><br/><span class="hl-2"> </span><span class="hl-1">expect</span><span class="hl-2">(</span><span class="hl-5">actual</span><span class="hl-2">.</span><span class="hl-5">length</span><span class="hl-2">).</span><span class="hl-1">toEqual</span><span class="hl-2">(</span><span class="hl-9">2</span><span class="hl-2">);</span><br/><span class="hl-2"> });</span><br/><span class="hl-2">});</span>
|
|
20
|
+
</code><button type="button">Copy</button></pre>
|
|
21
|
+
|
|
22
|
+
</section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Enumerations"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Enumerations</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary"><a id="zhttpcodecategory" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><a href="../enums/_zthun_webigail-http.ZHttpCodeCategory.html">ZHttpCodeCategory</a><a href="#zhttpcodecategory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="zhttpcodeclient" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><a href="../enums/_zthun_webigail-http.ZHttpCodeClient.html">ZHttpCodeClient</a><a href="#zhttpcodeclient" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="zhttpcodeinformationalresponse" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><a href="../enums/_zthun_webigail-http.ZHttpCodeInformationalResponse.html">ZHttpCodeInformationalResponse</a><a href="#zhttpcodeinformationalresponse" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="zhttpcoderedirection" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><a href="../enums/_zthun_webigail-http.ZHttpCodeRedirection.html">ZHttpCodeRedirection</a><a href="#zhttpcoderedirection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="zhttpcodeserver" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><a href="../enums/_zthun_webigail-http.ZHttpCodeServer.html">ZHttpCodeServer</a><a href="#zhttpcodeserver" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="zhttpcodeseverity" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><a href="../enums/_zthun_webigail-http.ZHttpCodeSeverity.html">ZHttpCodeSeverity</a><a href="#zhttpcodeseverity" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="zhttpcodesuccess" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><a href="../enums/_zthun_webigail-http.ZHttpCodeSuccess.html">ZHttpCodeSuccess</a><a href="#zhttpcodesuccess" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="zhttpmethod" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><a href="../enums/_zthun_webigail-http.ZHttpMethod.html">ZHttpMethod</a><a href="#zhttpmethod" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd></dl></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Classes"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Classes</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary"><a id="zhttprequestbuilder" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><a href="../classes/_zthun_webigail-http.ZHttpRequestBuilder.html">ZHttpRequestBuilder</a><a href="#zhttprequestbuilder" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="zhttpresultbuilder" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><a href="../classes/_zthun_webigail-http.ZHttpResultBuilder.html">ZHttpResultBuilder</a><a href="#zhttpresultbuilder" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="zhttpservice" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><a href="../classes/_zthun_webigail-http.ZHttpService.html">ZHttpService</a><a href="#zhttpservice" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="zhttpservicemock" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><a href="../classes/_zthun_webigail-http.ZHttpServiceMock.html">ZHttpServiceMock</a><a href="#zhttpservicemock" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd></dl></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Interfaces"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Interfaces</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary"><a id="izhttprequest" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><a href="../interfaces/_zthun_webigail-http.IZHttpRequest.html">IZHttpRequest</a><a href="#izhttprequest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="izhttpresult" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><a href="../interfaces/_zthun_webigail-http.IZHttpResult.html">IZHttpResult</a><a href="#izhttpresult" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="izhttpservice" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><a href="../interfaces/_zthun_webigail-http.IZHttpService.html">IZHttpService</a><a href="#izhttpservice" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd></dl></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Type Aliases"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Type Aliases</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary"><a id="zhttpcode" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><a href="../types/_zthun_webigail-http.ZHttpCode.html">ZHttpCode</a><a href="#zhttpcode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd></dl></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Variables"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Variables</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary"><a id="zhttpcodeclientdescriptions" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><a href="../variables/_zthun_webigail-http.ZHttpCodeClientDescriptions.html">ZHttpCodeClientDescriptions</a><a href="#zhttpcodeclientdescriptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="zhttpcodeclientnames" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><a href="../variables/_zthun_webigail-http.ZHttpCodeClientNames.html">ZHttpCodeClientNames</a><a href="#zhttpcodeclientnames" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="zhttpcodeinformationalresponsedescriptions" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><a href="../variables/_zthun_webigail-http.ZHttpCodeInformationalResponseDescriptions.html">ZHttpCodeInformationalResponseDescriptions</a><a href="#zhttpcodeinformationalresponsedescriptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="zhttpcodeinformationalresponsenames" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><a href="../variables/_zthun_webigail-http.ZHttpCodeInformationalResponseNames.html">ZHttpCodeInformationalResponseNames</a><a href="#zhttpcodeinformationalresponsenames" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="zhttpcoderedirectiondescriptions" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><a href="../variables/_zthun_webigail-http.ZHttpCodeRedirectionDescriptions.html">ZHttpCodeRedirectionDescriptions</a><a href="#zhttpcoderedirectiondescriptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="zhttpcoderedirectionnames" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><a href="../variables/_zthun_webigail-http.ZHttpCodeRedirectionNames.html">ZHttpCodeRedirectionNames</a><a href="#zhttpcoderedirectionnames" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="zhttpcodeserverdescriptions" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><a href="../variables/_zthun_webigail-http.ZHttpCodeServerDescriptions.html">ZHttpCodeServerDescriptions</a><a href="#zhttpcodeserverdescriptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="zhttpcodeservernames" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><a href="../variables/_zthun_webigail-http.ZHttpCodeServerNames.html">ZHttpCodeServerNames</a><a href="#zhttpcodeservernames" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="zhttpcodesuccessdescriptions" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><a href="../variables/_zthun_webigail-http.ZHttpCodeSuccessDescriptions.html">ZHttpCodeSuccessDescriptions</a><a href="#zhttpcodesuccessdescriptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="zhttpcodesuccessnames" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><a href="../variables/_zthun_webigail-http.ZHttpCodeSuccessNames.html">ZHttpCodeSuccessNames</a><a href="#zhttpcodesuccessnames" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd></dl></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Functions"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Functions</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary"><a id="fromcontenttype" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><a href="../functions/_zthun_webigail-http.fromContentType.html">fromContentType</a><a href="#fromcontenttype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="gethttpcodecategory" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><a href="../functions/_zthun_webigail-http.getHttpCodeCategory.html">getHttpCodeCategory</a><a href="#gethttpcodecategory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="gethttpcodedescription" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><a href="../functions/_zthun_webigail-http.getHttpCodeDescription.html">getHttpCodeDescription</a><a href="#gethttpcodedescription" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="gethttpcodename" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><a href="../functions/_zthun_webigail-http.getHttpCodeName.html">getHttpCodeName</a><a href="#gethttpcodename" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="gethttpcodeseverity" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><a href="../functions/_zthun_webigail-http.getHttpCodeSeverity.html">getHttpCodeSeverity</a><a href="#gethttpcodeseverity" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="isbodyinit" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><a href="../functions/_zthun_webigail-http.isBodyInit.html">isBodyInit</a><a href="#isbodyinit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="tobodyinit" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><a href="../functions/_zthun_webigail-http.toBodyInit.html">toBodyInit</a><a href="#tobodyinit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd></dl></details></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="#webigail-http"><span>Webigail <wbr/>Http</span></a><ul><li><a href="#build-status"><span>Build <wbr/>Status</span></a></li><li><a href="#usage"><span>Usage</span></a></li><li><a href="#testing"><span>Testing</span></a></li></ul><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Enumerations"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Enumerations</summary><div><a href="#zhttpcodecategory" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>ZHttp<wbr/>Code<wbr/>Category</span></a><a href="#zhttpcodeclient" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>ZHttp<wbr/>Code<wbr/>Client</span></a><a href="#zhttpcodeinformationalresponse" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>ZHttp<wbr/>Code<wbr/>Informational<wbr/>Response</span></a><a href="#zhttpcoderedirection" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>ZHttp<wbr/>Code<wbr/>Redirection</span></a><a href="#zhttpcodeserver" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>ZHttp<wbr/>Code<wbr/>Server</span></a><a href="#zhttpcodeseverity" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>ZHttp<wbr/>Code<wbr/>Severity</span></a><a href="#zhttpcodesuccess" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>ZHttp<wbr/>Code<wbr/>Success</span></a><a href="#zhttpmethod" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>ZHttp<wbr/>Method</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Classes"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Classes</summary><div><a href="#zhttprequestbuilder" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZHttp<wbr/>Request<wbr/>Builder</span></a><a href="#zhttpresultbuilder" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZHttp<wbr/>Result<wbr/>Builder</span></a><a href="#zhttpservice" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZHttp<wbr/>Service</span></a><a href="#zhttpservicemock" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZHttp<wbr/>Service<wbr/>Mock</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Interfaces"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Interfaces</summary><div><a href="#izhttprequest" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZHttp<wbr/>Request</span></a><a href="#izhttpresult" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZHttp<wbr/>Result</span></a><a href="#izhttpservice" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZHttp<wbr/>Service</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Type Aliases"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Type Aliases</summary><div><a href="#zhttpcode" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>ZHttp<wbr/>Code</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Variables"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Variables</summary><div><a href="#zhttpcodeclientdescriptions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>ZHttp<wbr/>Code<wbr/>Client<wbr/>Descriptions</span></a><a href="#zhttpcodeclientnames" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>ZHttp<wbr/>Code<wbr/>Client<wbr/>Names</span></a><a href="#zhttpcodeinformationalresponsedescriptions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>ZHttp<wbr/>Code<wbr/>Informational<wbr/>Response<wbr/>Descriptions</span></a><a href="#zhttpcodeinformationalresponsenames" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>ZHttp<wbr/>Code<wbr/>Informational<wbr/>Response<wbr/>Names</span></a><a href="#zhttpcoderedirectiondescriptions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>ZHttp<wbr/>Code<wbr/>Redirection<wbr/>Descriptions</span></a><a href="#zhttpcoderedirectionnames" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>ZHttp<wbr/>Code<wbr/>Redirection<wbr/>Names</span></a><a href="#zhttpcodeserverdescriptions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>ZHttp<wbr/>Code<wbr/>Server<wbr/>Descriptions</span></a><a href="#zhttpcodeservernames" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>ZHttp<wbr/>Code<wbr/>Server<wbr/>Names</span></a><a href="#zhttpcodesuccessdescriptions" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>ZHttp<wbr/>Code<wbr/>Success<wbr/>Descriptions</span></a><a href="#zhttpcodesuccessnames" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>ZHttp<wbr/>Code<wbr/>Success<wbr/>Names</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Functions"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Functions</summary><div><a href="#fromcontenttype" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>from<wbr/>Content<wbr/>Type</span></a><a href="#gethttpcodecategory" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>get<wbr/>Http<wbr/>Code<wbr/>Category</span></a><a href="#gethttpcodedescription" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>get<wbr/>Http<wbr/>Code<wbr/>Description</span></a><a href="#gethttpcodename" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>get<wbr/>Http<wbr/>Code<wbr/>Name</span></a><a href="#gethttpcodeseverity" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>get<wbr/>Http<wbr/>Code<wbr/>Severity</span></a><a href="#isbodyinit" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>is<wbr/>Body<wbr/>Init</span></a><a href="#tobodyinit" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>to<wbr/>Body<wbr/>Init</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Webigail</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><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,13 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@zthun/webigail-nest | Webigail</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></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"><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="webigail-nest" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Webigail Nest<a href="#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
|
|
2
|
+
use that one. If you are using webigail-http and you want to inject that service
|
|
3
|
+
into your nest project, then this package comes with the module that will do
|
|
4
|
+
that for you.</p>
|
|
5
|
+
<a id="build-status" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Build Status<a href="#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>
|
|
6
|
+
<a id="usage" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Usage<a href="#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
|
+
<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
|
+
</code><button type="button">Copy</button></pre>
|
|
9
|
+
|
|
10
|
+
<pre><code class="ts"><span class="hl-0">// product-module.ts</span><br/><span class="hl-4">import</span><span class="hl-2"> { </span><span class="hl-5">ZHttpModule</span><span class="hl-2"> } </span><span class="hl-4">from</span><span class="hl-2"> </span><span class="hl-3">'@zthun/webigail-nest'</span><span class="hl-2">;</span><br/><br/><span class="hl-2">@</span><span class="hl-1">Module</span><span class="hl-2">(</span><br/><span class="hl-2"> </span><span class="hl-5">imports</span><span class="hl-2">: [</span><span class="hl-5">ZHttpModule</span><span class="hl-2">],</span><br/><span class="hl-2"> </span><span class="hl-5">providers</span><span class="hl-2">: [</span><span class="hl-5">ProductService</span><span class="hl-2">],</span><br/><span class="hl-2"> </span><span class="hl-7">exports</span><span class="hl-2">: [</span><span class="hl-5">ProductService</span><span class="hl-2">]</span><br/><span class="hl-2">)</span><br/><span class="hl-4">export</span><span class="hl-2"> </span><span class="hl-6">class</span><span class="hl-2"> </span><span class="hl-7">ProductModule</span><span class="hl-2"> {}</span><br/><br/><span class="hl-0">// product-service.ts</span><br/><span class="hl-4">import</span><span class="hl-2"> { </span><span class="hl-5">IZHttpService</span><span class="hl-2"> } </span><span class="hl-4">from</span><span class="hl-2"> </span><span class="hl-3">'@zthun/webigail-http'</span><span class="hl-2">;</span><br/><br/><span class="hl-2">@</span><span class="hl-1">Injectable</span><span class="hl-2">()</span><br/><span class="hl-4">export</span><span class="hl-2"> </span><span class="hl-6">class</span><span class="hl-2"> </span><span class="hl-7">ProductService</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-6">public</span><span class="hl-2"> </span><span class="hl-6">constructor</span><span class="hl-2">(@</span><span class="hl-1">Inject</span><span class="hl-2">(</span><span class="hl-5">ZHttpServiceToken</span><span class="hl-2">) </span><span class="hl-6">private</span><span class="hl-2"> </span><span class="hl-5">_http</span><span class="hl-2">: </span><span class="hl-7">IZHttpService</span><span class="hl-2">) {}</span><br/><span class="hl-2">}</span>
|
|
11
|
+
</code><button type="button">Copy</button></pre>
|
|
12
|
+
|
|
13
|
+
</section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Classes"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Classes</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary"><a id="zhttpmodule" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><a href="../classes/_zthun_webigail-nest.ZHttpModule.html">ZHttpModule</a><a href="#zhttpmodule" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd></dl></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Variables"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Variables</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary"><a id="zhttpservicetoken" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><a href="../variables/_zthun_webigail-nest.ZHttpServiceToken.html">ZHttpServiceToken</a><a href="#zhttpservicetoken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd></dl></details></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="#webigail-nest"><span>Webigail <wbr/>Nest</span></a><ul><li><a href="#build-status"><span>Build <wbr/>Status</span></a></li><li><a href="#usage"><span>Usage</span></a></li></ul><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Classes"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Classes</summary><div><a href="#zhttpmodule" class=""><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></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Variables"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Variables</summary><div><a href="#zhttpservicetoken" class=""><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></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Webigail</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><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,11 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@zthun/webigail-rest | Webigail</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></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"><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="webigail-rest" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Webigail REST<a href="#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
|
|
2
|
+
specific standards.</p>
|
|
3
|
+
<a id="build-status" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Build Status<a href="#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>
|
|
4
|
+
<a id="usage" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Usage<a href="#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
|
+
<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
|
+
</code><button type="button">Copy</button></pre>
|
|
7
|
+
|
|
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">"@zthun/helpful-query"</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">"@zthun/webigail-http"</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">"@zthun/webigail-rest"</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">"https://pokeapi.co/api/v2/pokemon-species"</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">"bulbasaur"</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">=></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">=></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">"ditto"</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">=></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</span><br/><span class="hl-0">// endpoint with the given verbs The would just fail with 404s, but</span><br/><span class="hl-0">// these are here to illustrate the usage of a full rest service. There</span><br/><span class="hl-0">// is also an assumption that the return values on the services return</span><br/><span class="hl-0">// the data that was mutated. Delete is assumed to return a</span><br/><span class="hl-0">// 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">"not-really-a-pokemon"</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">=></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">"missing-no"</span><span class="hl-2">, </span><span class="hl-5">name:</span><span class="hl-2"> </span><span class="hl-3">"MissingNo"</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">=></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">"pikachu"</span><span class="hl-2">, { </span><span class="hl-5">name:</span><span class="hl-2"> </span><span class="hl-3">"Pika-who?"</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">=></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">"pikachu"</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">=></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">"Pikachu has fainted from existence"</span><span class="hl-2">));</span>
|
|
9
|
+
</code><button type="button">Copy</button></pre>
|
|
10
|
+
|
|
11
|
+
</section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Classes"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Classes</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary"><a id="zrestfulservice" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><a href="../classes/_zthun_webigail-rest.ZRestfulService.html">ZRestfulService</a><a href="#zrestfulservice" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="zrestfulurlbuilder" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><a href="../classes/_zthun_webigail-rest.ZRestfulUrlBuilder.html">ZRestfulUrlBuilder</a><a href="#zrestfulurlbuilder" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd></dl></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Interfaces"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Interfaces</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary"><a id="izrestfulcreate" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><a href="../interfaces/_zthun_webigail-rest.IZRestfulCreate.html">IZRestfulCreate</a><a href="#izrestfulcreate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="izrestfuldelete" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><a href="../interfaces/_zthun_webigail-rest.IZRestfulDelete.html">IZRestfulDelete</a><a href="#izrestfuldelete" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="izrestfulget" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><a href="../interfaces/_zthun_webigail-rest.IZRestfulGet.html">IZRestfulGet</a><a href="#izrestfulget" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="izrestfulservice" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html">IZRestfulService</a><a href="#izrestfulservice" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="izrestfulupdate" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><a href="../interfaces/_zthun_webigail-rest.IZRestfulUpdate.html">IZRestfulUpdate</a><a href="#izrestfulupdate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary"><a id="izrestfulupsert" class="tsd-anchor"></a><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><a href="../interfaces/_zthun_webigail-rest.IZRestfulUpsert.html">IZRestfulUpsert</a><a href="#izrestfulupsert" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></span></dt><dd class="tsd-member-summary"></dd></dl></details></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="#webigail-rest"><span>Webigail REST</span></a><ul><li><a href="#build-status"><span>Build <wbr/>Status</span></a></li><li><a href="#usage"><span>Usage</span></a></li></ul><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Classes"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Classes</summary><div><a href="#zrestfulservice" class=""><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><a href="#zrestfulurlbuilder" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZRestful<wbr/>Url<wbr/>Builder</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Interfaces"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Interfaces</summary><div><a href="#izrestfulcreate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZRestful<wbr/>Create</span></a><a href="#izrestfuldelete" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZRestful<wbr/>Delete</span></a><a href="#izrestfulget" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZRestful<wbr/>Get</span></a><a href="#izrestfulservice" class=""><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><a href="#izrestfulupdate" class=""><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><a href="#izrestfulupsert" class=""><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></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Webigail</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><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>
|