@zthun/webigail-web 4.0.9 → 5.0.1
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/dist/classes/_zthun_webigail-http.ZHttpRequestBuilder.html +18 -18
- package/dist/classes/_zthun_webigail-http.ZHttpResultBuilder.html +6 -6
- package/dist/classes/_zthun_webigail-http.ZHttpService.html +2 -2
- package/dist/classes/_zthun_webigail-http.ZHttpServiceMock.html +3 -3
- package/dist/classes/_zthun_webigail-nest.ZHttpModule.html +1 -1
- package/dist/classes/_zthun_webigail-rest.ZRestfulService.html +10 -10
- package/dist/classes/_zthun_webigail-rest.ZRestfulUrlBuilder.html +5 -5
- package/dist/classes/_zthun_webigail-url.ZDataUrlBuilder.html +8 -8
- package/dist/classes/_zthun_webigail-url.ZUrlBuilder.html +31 -31
- package/dist/enums/_zthun_webigail-http.ZHttpCodeCategory.html +6 -6
- package/dist/enums/_zthun_webigail-http.ZHttpCodeClient.html +29 -29
- package/dist/enums/_zthun_webigail-http.ZHttpCodeInformationalResponse.html +5 -5
- package/dist/enums/_zthun_webigail-http.ZHttpCodeRedirection.html +10 -10
- package/dist/enums/_zthun_webigail-http.ZHttpCodeServer.html +12 -12
- package/dist/enums/_zthun_webigail-http.ZHttpCodeSeverity.html +5 -5
- package/dist/enums/_zthun_webigail-http.ZHttpCodeSuccess.html +11 -11
- package/dist/enums/_zthun_webigail-http.ZHttpMethod.html +8 -8
- package/dist/enums/_zthun_webigail-url.ZMimeTypeApplication.html +4 -4
- package/dist/enums/_zthun_webigail-url.ZMimeTypeImage.html +8 -8
- package/dist/enums/_zthun_webigail-url.ZMimeTypeText.html +8 -8
- package/dist/enums/_zthun_webigail-url.ZYouTubeApi.html +3 -3
- package/dist/functions/_zthun_webigail-http.fromContentType.html +1 -1
- package/dist/functions/_zthun_webigail-http.getHttpCodeCategory.html +1 -1
- package/dist/functions/_zthun_webigail-http.getHttpCodeDescription.html +1 -1
- package/dist/functions/_zthun_webigail-http.getHttpCodeName.html +1 -1
- package/dist/functions/_zthun_webigail-http.getHttpCodeSeverity.html +1 -1
- package/dist/functions/_zthun_webigail-http.isBodyInit.html +1 -1
- package/dist/functions/_zthun_webigail-http.toBodyInit.html +1 -1
- package/dist/interfaces/_zthun_webigail-http.IZHttpRequest.html +6 -6
- package/dist/interfaces/_zthun_webigail-http.IZHttpResult.html +4 -4
- package/dist/interfaces/_zthun_webigail-http.IZHttpService.html +2 -2
- package/dist/interfaces/_zthun_webigail-rest.IZRestfulCreate.html +2 -2
- package/dist/interfaces/_zthun_webigail-rest.IZRestfulDelete.html +2 -2
- package/dist/interfaces/_zthun_webigail-rest.IZRestfulGet.html +2 -2
- package/dist/interfaces/_zthun_webigail-rest.IZRestfulService.html +6 -6
- package/dist/interfaces/_zthun_webigail-rest.IZRestfulUpdate.html +2 -2
- package/dist/interfaces/_zthun_webigail-rest.IZRestfulUpsert.html +2 -2
- package/dist/interfaces/_zthun_webigail-url.IZDataUrlInfo.html +4 -4
- package/dist/interfaces/_zthun_webigail-url.IZUrlInfo.html +9 -9
- package/dist/types/_zthun_webigail-http.ZHttpCode.html +1 -1
- package/dist/types/_zthun_webigail-url.ZMimeType.html +1 -1
- package/dist/variables/_zthun_webigail-http.ZHttpCodeClientDescriptions.html +1 -1
- package/dist/variables/_zthun_webigail-http.ZHttpCodeClientNames.html +1 -1
- package/dist/variables/_zthun_webigail-http.ZHttpCodeInformationalResponseDescriptions.html +1 -1
- package/dist/variables/_zthun_webigail-http.ZHttpCodeInformationalResponseNames.html +1 -1
- package/dist/variables/_zthun_webigail-http.ZHttpCodeRedirectionDescriptions.html +1 -1
- package/dist/variables/_zthun_webigail-http.ZHttpCodeRedirectionNames.html +1 -1
- package/dist/variables/_zthun_webigail-http.ZHttpCodeServerDescriptions.html +1 -1
- package/dist/variables/_zthun_webigail-http.ZHttpCodeServerNames.html +1 -1
- package/dist/variables/_zthun_webigail-http.ZHttpCodeSuccessDescriptions.html +1 -1
- package/dist/variables/_zthun_webigail-http.ZHttpCodeSuccessNames.html +1 -1
- package/dist/variables/_zthun_webigail-nest.ZHttpServiceToken.html +1 -1
- package/dist/variables/_zthun_webigail-url.ZSupportedMimeTypes.html +1 -1
- package/package.json +6 -6
|
@@ -1,14 +1,14 @@
|
|
|
1
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>ZHttpServiceMock | 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(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Webigail</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_zthun_webigail-http.html">@zthun/webigail-http</a></li><li><a href="" aria-current="page">ZHttpServiceMock</a></li></ul><h1>Class ZHttpServiceMock</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a mock http service that can be useful for demos,
|
|
2
2
|
testing, and pre-api implementations.</p>
|
|
3
|
-
</div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/_zthun_webigail-http.IZHttpService.html" class="tsd-signature-type tsd-kind-interface">IZHttpService</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
3
|
+
</div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/_zthun_webigail-http.IZHttpService.html" class="tsd-signature-type tsd-kind-interface">IZHttpService</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/d7eda97ac081a0b73d890b02d514564a103b1bd4/packages/webigail-http/src/service/http-service-mock.mts#L11">packages/webigail-http/src/service/http-service-mock.mts:11</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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
4
4
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#request" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request</span></a>
|
|
5
5
|
<a href="#set" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set</span></a>
|
|
6
6
|
</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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorzhttpservicemock"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ZHttpServiceMock</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">ZHttpServiceMock</a><a href="#constructorzhttpservicemock" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">ZHttpServiceMock</a></h4></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="request"><span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="request-1"><span class="tsd-kind-call-signature">request</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#requesttresult">TResult</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#requesttbody">TBody</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">req</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/_zthun_webigail-http.IZHttpRequest.html" class="tsd-signature-type tsd-kind-interface">IZHttpRequest</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#requesttbody">TBody</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_zthun_webigail-http.IZHttpResult.html" class="tsd-signature-type tsd-kind-interface">IZHttpResult</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#requesttresult">TResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#request-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Invokes the request given the allowed api implementations.</p>
|
|
7
7
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="requesttresult"><span class="tsd-kind-type-parameter">TResult</span> = <span class="tsd-signature-type">any</span></span></li><li><span id="requesttbody"><span class="tsd-kind-type-parameter">TBody</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">req</span>: <a href="../interfaces/_zthun_webigail-http.IZHttpRequest.html" class="tsd-signature-type tsd-kind-interface">IZHttpRequest</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#requesttbody">TBody</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The request that has been made.</p>
|
|
8
8
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_zthun_webigail-http.IZHttpResult.html" class="tsd-signature-type tsd-kind-interface">IZHttpResult</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#requesttresult">TResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><p>A promise that resolves with the given result if the status code is less than 400.
|
|
9
9
|
Any status code above 400 will result in a rejected promise.</p>
|
|
10
|
-
<aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_webigail-http.IZHttpService.html">IZHttpService</a>.<a href="../interfaces/_zthun_webigail-http.IZHttpService.html#request">request</a></p><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
10
|
+
<aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_webigail-http.IZHttpService.html">IZHttpService</a>.<a href="../interfaces/_zthun_webigail-http.IZHttpService.html#request">request</a></p><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/d7eda97ac081a0b73d890b02d514564a103b1bd4/packages/webigail-http/src/service/http-service-mock.mts#L54">packages/webigail-http/src/service/http-service-mock.mts:54</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="set"><span>set</span><a href="#set" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="set-1"><span class="tsd-kind-call-signature">set</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#settresult">TResult</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">endpoint</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">verb</span><span class="tsd-signature-symbol">:</span> <a href="../enums/_zthun_webigail-http.ZHttpMethod.html" class="tsd-signature-type tsd-kind-enum">ZHttpMethod</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">invoke</span><span class="tsd-signature-symbol">:</span><br/> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/_zthun_webigail-http.IZHttpResult.html" class="tsd-signature-type tsd-kind-interface">IZHttpResult</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#settresult">TResult</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> (<br/> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">req</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/_zthun_webigail-http.IZHttpRequest.html" class="tsd-signature-type tsd-kind-interface">IZHttpRequest</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a href="../interfaces/_zthun_webigail-http.IZHttpResult.html" class="tsd-signature-type tsd-kind-interface">IZHttpResult</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#settresult">TResult</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_zthun_webigail-http.IZHttpResult.html" class="tsd-signature-type tsd-kind-interface">IZHttpResult</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#settresult">TResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><br/> )<span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#set-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the result of a given endpoint.</p>
|
|
11
11
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="settresult"><span class="tsd-kind-type-parameter">TResult</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">endpoint</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The endpoint to set.</p>
|
|
12
12
|
</div></li><li><span><span class="tsd-kind-parameter">verb</span>: <a href="../enums/_zthun_webigail-http.ZHttpMethod.html" class="tsd-signature-type tsd-kind-enum">ZHttpMethod</a></span><div class="tsd-comment tsd-typography"><p>The endpoint verb to respond to.</p>
|
|
13
13
|
</div></li><li><span><span class="tsd-kind-parameter">invoke</span>: <br/> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/_zthun_webigail-http.IZHttpResult.html" class="tsd-signature-type tsd-kind-interface">IZHttpResult</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#settresult">TResult</a><span class="tsd-signature-symbol">></span><br/> <span class="tsd-signature-symbol">|</span> (<br/> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">req</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/_zthun_webigail-http.IZHttpRequest.html" class="tsd-signature-type tsd-kind-interface">IZHttpRequest</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a href="../interfaces/_zthun_webigail-http.IZHttpResult.html" class="tsd-signature-type tsd-kind-interface">IZHttpResult</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#settresult">TResult</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_zthun_webigail-http.IZHttpResult.html" class="tsd-signature-type tsd-kind-interface">IZHttpResult</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#settresult">TResult</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><br/> )</span><div class="tsd-comment tsd-typography"><p>The result method. If this is falsy, then the endpoint is removed.</p>
|
|
14
|
-
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
14
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/d7eda97ac081a0b73d890b02d514564a103b1bd4/packages/webigail-http/src/service/http-service-mock.mts#L30">packages/webigail-http/src/service/http-service-mock.mts:30</a></li></ul></aside></div></li></ul></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#request"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>request</span></a><a href="#set"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set</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>
|
|
@@ -1,3 +1,3 @@
|
|
|
1
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>ZHttpModule | 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(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Webigail</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_zthun_webigail-nest.html">@zthun/webigail-nest</a></li><li><a href="" aria-current="page">ZHttpModule</a></li></ul><h1>Class ZHttpModule</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A module that provides http services.</p>
|
|
2
|
-
</div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
2
|
+
</div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/d7eda97ac081a0b73d890b02d514564a103b1bd4/packages/webigail-nest/src/http/http-module.mts#L17">http-module.mts:17</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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
3
3
|
</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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorzhttpmodule"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ZHttpModule</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">ZHttpModule</a><a href="#constructorzhttpmodule" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">ZHttpModule</a></h4></div></li></ul></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</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>
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
for example, is read only, then create, upsert, update, and delete should all return
|
|
4
4
|
not found or forbidden errors.</p>
|
|
5
5
|
</div></section><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="t"><span class="tsd-kind-type-parameter">T</span></span><div class="tsd-comment tsd-typography"><p>The type of resource being retrieved or mutated.</p>
|
|
6
|
-
</div></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html" class="tsd-signature-type tsd-kind-interface">IZRestfulService</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorzrestfulservicet">T</a><span class="tsd-signature-symbol">></span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
6
|
+
</div></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html" class="tsd-signature-type tsd-kind-interface">IZRestfulService</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorzrestfulservicet">T</a><span class="tsd-signature-symbol">></span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/d7eda97ac081a0b73d890b02d514564a103b1bd4/packages/webigail-rest/src/service/restful-service.mts#L37">packages/webigail-rest/src/service/restful-service.mts:37</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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
7
7
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#count" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>count</span></a>
|
|
8
8
|
<a href="#create" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create</span></a>
|
|
9
9
|
<a href="#delete" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete</span></a>
|
|
@@ -20,40 +20,40 @@ size, search, filter, and sort will be overridden depending on
|
|
|
20
20
|
which method is being invoked.</p>
|
|
21
21
|
</div></li><li><span><span class="tsd-kind-parameter">_request</span>: <a href="../interfaces/_zthun_webigail-http.IZHttpRequest.html" class="tsd-signature-type tsd-kind-interface">IZHttpRequest</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></span><div class="tsd-comment tsd-typography"><p>The base request to use when constructing requests in the http
|
|
22
22
|
service.</p>
|
|
23
|
-
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">ZRestfulService</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorzrestfulservicet">T</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
23
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">ZRestfulService</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorzrestfulservicet">T</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/d7eda97ac081a0b73d890b02d514564a103b1bd4/packages/webigail-rest/src/service/restful-service.mts#L52">packages/webigail-rest/src/service/restful-service.mts:52</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="count"><span>count</span><a href="#count" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="count-1"><span class="tsd-kind-call-signature">count</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">req</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IZDataRequest</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><a href="#count-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the total count of data items before pagination.</p>
|
|
24
24
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">req</span>: <span class="tsd-signature-type">IZDataRequest</span></span><div class="tsd-comment tsd-typography"><p>The data request being made. The page and size fields
|
|
25
25
|
are ignored in this instance.</p>
|
|
26
26
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><p>The total number of items across pages that the request
|
|
27
27
|
data set will represent.</p>
|
|
28
|
-
<aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html">IZRestfulService</a>.<a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html#count">count</a></p><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
28
|
+
<aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html">IZRestfulService</a>.<a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html#count">count</a></p><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/d7eda97ac081a0b73d890b02d514564a103b1bd4/packages/webigail-rest/src/service/restful-service.mts#L73">packages/webigail-rest/src/service/restful-service.mts:73</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="create"><span>create</span><a href="#create" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="create-1"><span class="tsd-kind-call-signature">create</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorzrestfulservicet">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorzrestfulservicet">T</a><span class="tsd-signature-symbol">></span><a href="#create-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a new entity.</p>
|
|
29
29
|
<p>This uses a POST verb.</p>
|
|
30
30
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">body</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorzrestfulservicet">T</a></span><div class="tsd-comment tsd-typography"><p>The post body that represents the resource to create.</p>
|
|
31
31
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorzrestfulservicet">T</a><span class="tsd-signature-symbol">></span></h4><p>The resource that was created.</p>
|
|
32
|
-
<aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html">IZRestfulService</a>.<a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html#create">create</a></p><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
32
|
+
<aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html">IZRestfulService</a>.<a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html#create">create</a></p><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/d7eda97ac081a0b73d890b02d514564a103b1bd4/packages/webigail-rest/src/service/restful-service.mts#L109">packages/webigail-rest/src/service/restful-service.mts:109</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="delete"><span>delete</span><a href="#delete" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="delete-1"><span class="tsd-kind-call-signature">delete</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">identification</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#delete-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deletes a resource entity.</p>
|
|
33
33
|
<p>This uses the DELETE verb.</p>
|
|
34
34
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">identification</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The identification of the resource to delete.</p>
|
|
35
|
-
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html">IZRestfulService</a>.<a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html#delete">delete</a></p><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
35
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html">IZRestfulService</a>.<a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html#delete">delete</a></p><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/d7eda97ac081a0b73d890b02d514564a103b1bd4/packages/webigail-rest/src/service/restful-service.mts#L145">packages/webigail-rest/src/service/restful-service.mts:145</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="endpoint"><span>endpoint</span><a href="#endpoint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="endpoint-1"><span class="tsd-kind-call-signature">endpoint</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">identification</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_zthun_webigail-url.ZUrlBuilder.html" class="tsd-signature-type tsd-kind-class">ZUrlBuilder</a><a href="#endpoint-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the final endpoint for a resource.</p>
|
|
36
36
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">identification</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The identification of a single resource. If this is falsy, then
|
|
37
37
|
the entire data scope is used.</p>
|
|
38
38
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_zthun_webigail-url.ZUrlBuilder.html" class="tsd-signature-type tsd-kind-class">ZUrlBuilder</a></h4><p>A url builder that points to the target resource endpoint.</p>
|
|
39
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
39
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/d7eda97ac081a0b73d890b02d514564a103b1bd4/packages/webigail-rest/src/service/restful-service.mts#L68">packages/webigail-rest/src/service/restful-service.mts:68</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="get"><span>get</span><a href="#get" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="get-1"><span class="tsd-kind-call-signature">get</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">identification</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorzrestfulservicet">T</a><span class="tsd-signature-symbol">></span><a href="#get-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves a single item by it's identification.</p>
|
|
40
40
|
<p>This uses a GET verb.</p>
|
|
41
41
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">identification</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The identification of the resource to retrieve.</p>
|
|
42
42
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorzrestfulservicet">T</a><span class="tsd-signature-symbol">></span></h4><p>The json representation of the entity.</p>
|
|
43
|
-
<aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html">IZRestfulService</a>.<a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html#get">get</a></p><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
43
|
+
<aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html">IZRestfulService</a>.<a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html#get">get</a></p><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/d7eda97ac081a0b73d890b02d514564a103b1bd4/packages/webigail-rest/src/service/restful-service.mts#L98">packages/webigail-rest/src/service/restful-service.mts:98</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="retrieve"><span>retrieve</span><a href="#retrieve" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="retrieve-1"><span class="tsd-kind-call-signature">retrieve</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">req</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IZDataRequest</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorzrestfulservicet">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#retrieve-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves a single page of data.</p>
|
|
44
44
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">req</span>: <span class="tsd-signature-type">IZDataRequest</span></span><div class="tsd-comment tsd-typography"><p>The data request that contains the sorting, filtering,
|
|
45
45
|
search, and pagination info to construct a data view.</p>
|
|
46
46
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorzrestfulservicet">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>A single page of data elements.</p>
|
|
47
|
-
<aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html">IZRestfulService</a>.<a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html#retrieve">retrieve</a></p><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
47
|
+
<aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html">IZRestfulService</a>.<a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html#retrieve">retrieve</a></p><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/d7eda97ac081a0b73d890b02d514564a103b1bd4/packages/webigail-rest/src/service/restful-service.mts#L88">packages/webigail-rest/src/service/restful-service.mts:88</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="update"><span>update</span><a href="#update" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="update-1"><span class="tsd-kind-call-signature">update</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">identification</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">fields</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorzrestfulservicet">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorzrestfulservicet">T</a><span class="tsd-signature-symbol">></span><a href="#update-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Partially updates an existing resource entity.</p>
|
|
48
48
|
<p>This uses the PATCH verb.</p>
|
|
49
49
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">identification</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The identification of the resource to update.</p>
|
|
50
50
|
</div></li><li><span><span class="tsd-kind-parameter">fields</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorzrestfulservicet">T</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The partial fields to update.</p>
|
|
51
51
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorzrestfulservicet">T</a><span class="tsd-signature-symbol">></span></h4><p>The resource that was updated.</p>
|
|
52
|
-
<aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html">IZRestfulService</a>.<a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html#update">update</a></p><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
52
|
+
<aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html">IZRestfulService</a>.<a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html#update">update</a></p><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/d7eda97ac081a0b73d890b02d514564a103b1bd4/packages/webigail-rest/src/service/restful-service.mts#L131">packages/webigail-rest/src/service/restful-service.mts:131</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="upsert"><span>upsert</span><a href="#upsert" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="upsert-1"><span class="tsd-kind-call-signature">upsert</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorzrestfulservicet">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorzrestfulservicet">T</a><span class="tsd-signature-symbol">></span><a href="#upsert-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a new entity or updates an existing entity.</p>
|
|
53
53
|
<p>This is determined by the body parameters on whether
|
|
54
54
|
or not an entity already exists.</p>
|
|
55
55
|
<p>This uses the PUT verb.</p>
|
|
56
56
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">body</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorzrestfulservicet">T</a></span><div class="tsd-comment tsd-typography"><p>The post body that represents the resource to create
|
|
57
57
|
or update.</p>
|
|
58
58
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#constructorzrestfulservicet">T</a><span class="tsd-signature-symbol">></span></h4><p>The resource that was created or updated.</p>
|
|
59
|
-
<aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html">IZRestfulService</a>.<a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html#upsert">upsert</a></p><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
59
|
+
<aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html">IZRestfulService</a>.<a href="../interfaces/_zthun_webigail-rest.IZRestfulService.html#upsert">upsert</a></p><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/d7eda97ac081a0b73d890b02d514564a103b1bd4/packages/webigail-rest/src/service/restful-service.mts#L120">packages/webigail-rest/src/service/restful-service.mts:120</a></li></ul></aside></div></li></ul></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#count"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>count</span></a><a href="#create"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create</span></a><a href="#delete"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete</span></a><a href="#endpoint"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>endpoint</span></a><a href="#get"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get</span></a><a href="#retrieve"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>retrieve</span></a><a href="#update"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update</span></a><a href="#upsert"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>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>
|
|
@@ -1,17 +1,17 @@
|
|
|
1
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>ZRestfulUrlBuilder | 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(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Webigail</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_zthun_webigail-rest.html">@zthun/webigail-rest</a></li><li><a href="" aria-current="page">ZRestfulUrlBuilder</a></li></ul><h1>Class ZRestfulUrlBuilder</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a decorator that can build a url for a restful endpoint
|
|
2
2
|
given an existing base url.</p>
|
|
3
|
-
</div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
3
|
+
</div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/d7eda97ac081a0b73d890b02d514564a103b1bd4/packages/webigail-rest/src/url/restful-url.mts#L9">packages/webigail-rest/src/url/restful-url.mts:9</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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
4
4
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#build" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build</span></a>
|
|
5
5
|
<a href="#count" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>count</span></a>
|
|
6
6
|
<a href="#from" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a>
|
|
7
7
|
</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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorzrestfulurlbuilder"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ZRestfulUrlBuilder</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">baseUrl</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> <a href="" class="tsd-signature-type tsd-kind-class">ZRestfulUrlBuilder</a><a href="#constructorzrestfulurlbuilder" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new instance of this object.</p>
|
|
8
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">baseUrl</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">ZRestfulUrlBuilder</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
8
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">baseUrl</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">ZRestfulUrlBuilder</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/d7eda97ac081a0b73d890b02d514564a103b1bd4/packages/webigail-rest/src/url/restful-url.mts#L15">packages/webigail-rest/src/url/restful-url.mts:15</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="build"><span>build</span><a href="#build" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="build-1"><span class="tsd-kind-call-signature">build</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#build-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the built url.</p>
|
|
9
9
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The built url.</p>
|
|
10
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
10
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/d7eda97ac081a0b73d890b02d514564a103b1bd4/packages/webigail-rest/src/url/restful-url.mts#L58">packages/webigail-rest/src/url/restful-url.mts:58</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="count"><span>count</span><a href="#count" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="count-1"><span class="tsd-kind-call-signature">count</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#count-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates the url to optimize to retrieve a count.</p>
|
|
11
11
|
<p>This will add the size and page parameters to the url and remove the sort parameter.</p>
|
|
12
12
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
13
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
13
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/d7eda97ac081a0b73d890b02d514564a103b1bd4/packages/webigail-rest/src/url/restful-url.mts#L47">packages/webigail-rest/src/url/restful-url.mts:47</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="from"><span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="from-1"><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">IZDataRequest</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#from-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds the request parameters to the url.</p>
|
|
14
14
|
<p>This will add the page, size, search, filter, and sort parameters to the url if they are defined.</p>
|
|
15
15
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">request</span>: <span class="tsd-signature-type">IZDataRequest</span></span><div class="tsd-comment tsd-typography"><p>The request to add to the url.</p>
|
|
16
16
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
17
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
17
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/d7eda97ac081a0b73d890b02d514564a103b1bd4/packages/webigail-rest/src/url/restful-url.mts#L29">packages/webigail-rest/src/url/restful-url.mts:29</a></li></ul></aside></div></li></ul></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#build"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build</span></a><a href="#count"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>count</span></a><a href="#from"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</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>
|