@zthun/webigail-web 3.0.0 → 3.0.2
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 +16 -16
- 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_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/modules/_zthun_webigail_rest.html +1 -1
- 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,6 +1,6 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ZUrlBuilder | Webigail</title><meta name="description" content="Documentation for Webigail"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../webigail.svg" />
|
|
2
2
|
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Webigail</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Webigail</a></li><li><a href="../modules/_zthun_webigail_url.html">@zthun/webigail-url</a></li><li><a href="_zthun_webigail_url.ZUrlBuilder.html">ZUrlBuilder</a></li></ul><h1>Class ZUrlBuilder</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents an object that is helpful in building a url.</p>
|
|
3
|
-
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
3
|
+
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L69">url/url.mts:69</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">Constructors</h3><div class="tsd-index-list"><a href="_zthun_webigail_url.ZUrlBuilder.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><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">Properties</h3><div class="tsd-index-list"><a href="_zthun_webigail_url.ZUrlBuilder.html#ProtocolPorts" 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<wbr/>Ports</span></a>
|
|
5
5
|
<a href="_zthun_webigail_url.ZUrlBuilder.html#UrlGravatar" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Url<wbr/>Gravatar</span></a>
|
|
6
6
|
<a href="_zthun_webigail_url.ZUrlBuilder.html#UrlYouTube" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Url<wbr/>You<wbr/>Tube</span></a>
|
|
@@ -32,11 +32,11 @@
|
|
|
32
32
|
</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"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_ZUrlBuilder" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new ZUrl<wbr/>Builder</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">protocol</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">hostname</span><span class="tsd-signature-symbol">?</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="#constructor.new_ZUrlBuilder" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new instance of this object.</p>
|
|
33
33
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">protocol</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "http"</span></span><div class="tsd-comment tsd-typography"><p>The protocol to use.</p>
|
|
34
34
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">hostname</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "localhost"</span></span><div class="tsd-comment tsd-typography"><p>The hostname to connect with.</p>
|
|
35
|
-
</div><div class="tsd-comment tsd-typography"></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
36
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
37
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
35
|
+
</div><div class="tsd-comment tsd-typography"></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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L138">url/url.mts:138</a></li></ul></aside></li></ul></section></section></details><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="ProtocolPorts" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>Protocol<wbr/>Ports</span><a href="#ProtocolPorts" 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<wbr/>Ports</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">ftp</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">http</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">https</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">sftp</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">smb</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">smtp</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">ssh</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>A mapping between protocol and default port.</p>
|
|
36
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L85">url/url.mts:85</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="UrlGravatar" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>Url<wbr/>Gravatar</span><a href="#UrlGravatar" 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">Url<wbr/>Gravatar</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "https://s.gravatar.com/avatar"</span></div><div class="tsd-comment tsd-typography"><p>The url to the gravatar api.</p>
|
|
37
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L73">url/url.mts:73</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="UrlYouTube" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>Url<wbr/>You<wbr/>Tube</span><a href="#UrlYouTube" 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">Url<wbr/>You<wbr/>Tube</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "https://www.youtube.com"</span></div><div class="tsd-comment tsd-typography"><p>The url to youtube.</p>
|
|
38
38
|
<p>This is mostly used to embed videos.</p>
|
|
39
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
39
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L80">url/url.mts:80</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="api" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api</span><a href="#api" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="api.api-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">api</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">loc</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#api.api-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Fills the information for an api path call.</p>
|
|
40
40
|
<p>This is a combination of location, hash with an empty string, and an
|
|
41
41
|
append of the basePath.</p>
|
|
42
42
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">loc</span>: <span class="tsd-signature-type">Location</span></span><div class="tsd-comment tsd-typography"><p>The optional location object to populate with.</p>
|
|
@@ -44,47 +44,47 @@ append of the basePath.</p>
|
|
|
44
44
|
just keep this as api and have your server accept
|
|
45
45
|
this path.</p>
|
|
46
46
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
47
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
47
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L193">url/url.mts:193</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="append" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>append</span><a href="#append" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="append.append-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">append</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#append.append-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Appends a path segment.</p>
|
|
48
48
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The segment to append.</p>
|
|
49
49
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
50
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
50
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L433">url/url.mts:433</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="build" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>build</span><a href="#build" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="build.build-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">build</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#build.build-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Builds the url string and returns it.</p>
|
|
51
51
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The url string.</p>
|
|
52
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
52
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L566">url/url.mts:566</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="filter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>filter</span><a href="#filter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="filter.filter-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">filter</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filter</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#filter.filter-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a filter param.</p>
|
|
53
53
|
</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">filter</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The filter param to add. If this is null, undefined,
|
|
54
54
|
or empty, then any filter param is deleted.</p>
|
|
55
55
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
56
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
56
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L542">url/url.mts:542</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="gravatar" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>gravatar</span><a href="#gravatar" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="gravatar.gravatar-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">gravatar</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">hash</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">size</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#gravatar.gravatar-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the url for a user gravatar.</p>
|
|
57
57
|
</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">hash</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The md5 email hash.</p>
|
|
58
58
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">size</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The dimensional size of the gravatar image.</p>
|
|
59
59
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
60
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
60
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L242">url/url.mts:242</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="hash" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="hash.hash-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">hash</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">hash</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#hash.hash-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the hash section.</p>
|
|
61
61
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">hash</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The hash section.</p>
|
|
62
62
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
63
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
63
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L447">url/url.mts:447</a></li></ul></aside></li></ul></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><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="hostname.hostname-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">hostname</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">host</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#hostname.hostname-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the host name.</p>
|
|
64
64
|
<p>This sets the entire hostname as the root domain. This
|
|
65
65
|
will blow away any subdomains added, so it's best to
|
|
66
66
|
call this method first.</p>
|
|
67
67
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">host</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The hostname.</p>
|
|
68
68
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
69
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
69
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L360">url/url.mts:360</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="info" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>info</span><a href="#info" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="info.info-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">info</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_zthun_webigail_url.IZUrlInfo.html" class="tsd-signature-type tsd-kind-interface">IZUrlInfo</a><a href="#info.info-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the current information about the uri being built.</p>
|
|
70
70
|
</div><h4 class="tsd-returns-title">Returns <a href="../interfaces/_zthun_webigail_url.IZUrlInfo.html" class="tsd-signature-type tsd-kind-interface">IZUrlInfo</a></h4><p>The current uri information.</p>
|
|
71
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
71
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L616">url/url.mts:616</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="location" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>location</span><a href="#location" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="location.location-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">location</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">loc</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#location.location-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Fills the information from the current location data.</p>
|
|
72
72
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">loc</span>: <span class="tsd-signature-type">Location</span></span><div class="tsd-comment tsd-typography"><p>The optional location object to populate with.</p>
|
|
73
73
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
74
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
74
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L157">url/url.mts:157</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="onlyParam" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>only<wbr/>Param</span><a href="#onlyParam" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="onlyParam.onlyParam-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">only<wbr/>Param</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span>, <span class="tsd-kind-parameter">val</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#onlyParam.onlyParam-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes all duplicate params and adds one with the key to the value.</p>
|
|
75
75
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The parameter key that can have only one.</p>
|
|
76
76
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">val</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The parameter value. If this is falsy, then
|
|
77
77
|
the key is deleted.</p>
|
|
78
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
78
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L479">url/url.mts:479</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="page" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>page</span><a href="#page" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="page.page-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">page</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">page</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#page.page-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a page param.</p>
|
|
79
79
|
</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">page</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The page param to add. If this null, undefined,
|
|
80
80
|
or less than 1, then any page param is deleted.</p>
|
|
81
81
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
82
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
82
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L494">url/url.mts:494</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="param" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>param</span><a href="#param" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="param.param-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">param</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span>, <span class="tsd-kind-parameter">val</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#param.param-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a search parameter.</p>
|
|
83
83
|
<p>This version assumes that value is not null.</p>
|
|
84
84
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The parameter key.</p>
|
|
85
85
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">val</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The parameter value.</p>
|
|
86
86
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
87
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
87
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L465">url/url.mts:465</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="parse" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>parse</span><a href="#parse" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="parse.parse-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">parse</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">url</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="#parse.parse-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Parses an existing url and sets all properties.</p>
|
|
88
88
|
<p>If you give this a path without the protocol and hostname, then it will
|
|
89
89
|
automatically append the protocol and host of the browser window if it
|
|
90
90
|
exists.</p>
|
|
@@ -92,42 +92,42 @@ exists.</p>
|
|
|
92
92
|
parsing it, it is best to always call this method first.</p>
|
|
93
93
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">url</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The url to parse.</p>
|
|
94
94
|
</div><div class="tsd-comment tsd-typography"></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>This object.</p>
|
|
95
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
95
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L213">url/url.mts:213</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="password" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="password.password-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">password</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pwd</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#password.password-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the password.</p>
|
|
96
96
|
<p>This is only valid if the username is set.</p>
|
|
97
97
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">pwd</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The user password.</p>
|
|
98
98
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
99
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
99
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L342">url/url.mts:342</a></li></ul></aside></li></ul></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><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="path.path-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">path</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#path.path-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes all existing path segments and restarts the path.</p>
|
|
100
100
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The starting path.</p>
|
|
101
101
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
102
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
102
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L419">url/url.mts:419</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="popSubdomain" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>pop<wbr/>Subdomain</span><a href="#popSubdomain" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="popSubdomain.popSubdomain-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">pop<wbr/>Subdomain</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#popSubdomain.popSubdomain-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes a subdomain from the current domain.</p>
|
|
103
103
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
104
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
104
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L389">url/url.mts:389</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="port" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="port.port-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">port</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">port</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#port.port-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the port.</p>
|
|
105
105
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">port</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The port.</p>
|
|
106
106
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
107
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
107
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L405">url/url.mts:405</a></li></ul></aside></li></ul></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><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="protocol.protocol-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">protocol</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">protocol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#protocol.protocol-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the protocol.</p>
|
|
108
108
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">protocol</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The protocol.</p>
|
|
109
109
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
110
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
110
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L310">url/url.mts:310</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="search" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>search</span><a href="#search" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="search.search-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">search</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">search</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#search.search-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a search param.</p>
|
|
111
111
|
</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">search</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The search param to add. If this is null, undefined,
|
|
112
112
|
or empty, then any search param is deleted.</p>
|
|
113
113
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
114
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
114
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L528">url/url.mts:528</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="size" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>size</span><a href="#size" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="size.size-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">size</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">size</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#size.size-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a size param.</p>
|
|
115
115
|
</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">size</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The size param to add. If this is null, undefined,
|
|
116
116
|
or less than 0, then any size param is deleted.</p>
|
|
117
117
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
118
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
118
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L511">url/url.mts:511</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sort" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sort</span><a href="#sort" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="sort.sort-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">sort</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">sort</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#sort.sort-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a sort param.</p>
|
|
119
119
|
</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">sort</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The sort param to add. If this is null, undefined,
|
|
120
120
|
or empty, then any filter param is deleted.</p>
|
|
121
121
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
122
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
122
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L556">url/url.mts:556</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="subdomain" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>subdomain</span><a href="#subdomain" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="subdomain.subdomain-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">subdomain</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">domain</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#subdomain.subdomain-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a subdomain in front of the hostname.</p>
|
|
123
123
|
<p>If a hostname was never set, then domain becomes the hostname.</p>
|
|
124
124
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">domain</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The domain to append.</p>
|
|
125
125
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
126
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
126
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L376">url/url.mts:376</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="username" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><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><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="username.username-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">username</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">user</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#username.username-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the user name.</p>
|
|
127
127
|
<p>Used for things like ssh and ftp.</p>
|
|
128
128
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">user</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The username</p>
|
|
129
129
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
130
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
130
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L326">url/url.mts:326</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="youTube" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>you<wbr/>Tube</span><a href="#youTube" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="youTube.youTube-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">you<wbr/>Tube</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">api</span>, <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#youTube.youTube-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the url for a target video on YouTube.</p>
|
|
131
131
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">api</span>: <a href="../enums/_zthun_webigail_url.ZYouTubeApi.html" class="tsd-signature-type tsd-kind-enum">ZYouTubeApi</a></span><div class="tsd-comment tsd-typography"><p>The target api. If this is watch, then
|
|
132
132
|
it will be a target link to a youTube url.
|
|
133
133
|
If this is embed, then it will be a target
|
|
@@ -135,9 +135,9 @@ link that can be put into an iframe for
|
|
|
135
135
|
embedded youtube videos.</p>
|
|
136
136
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the video to watch.</p>
|
|
137
137
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
138
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
138
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L264">url/url.mts:264</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="youTube.youTube-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">you<wbr/>Tube</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#youTube.youTube-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the url to the base YouTube domain.</p>
|
|
139
139
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
140
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
140
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L272">url/url.mts:272</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="defaults" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>defaults</span><a href="#defaults" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="defaults.defaults-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">defaults</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">protocol</span>, <span class="tsd-kind-parameter">port</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#defaults.defaults-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets whether the given protocols default port is port.</p>
|
|
141
141
|
<p>The main purpose of this method is to determine if a url requires
|
|
142
142
|
a port section. Therefore, there are some special behaviors which may
|
|
143
143
|
not be obvious:</p>
|
|
@@ -150,4 +150,4 @@ not be obvious:</p>
|
|
|
150
150
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">protocol</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The protocol to check.</p>
|
|
151
151
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">port</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 port to compare.</p>
|
|
152
152
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>True if the default port for protocol is port.</p>
|
|
153
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/
|
|
153
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/webigail/blob/370e69487214e76fc5ccf84294c5920bd29c4bb9/packages/webigail-url/src/url/url.mts#L115">url/url.mts:115</a></li></ul></aside></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"><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="tsd-otp-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><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="tsd-otp-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="#ProtocolPorts" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Protocol<wbr/>Ports</span></a><a href="#UrlGravatar" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Url<wbr/>Gravatar</span></a><a href="#UrlYouTube" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Url<wbr/>You<wbr/>Tube</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#api" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>api</span></a><a href="#append" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>append</span></a><a href="#build" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build</span></a><a href="#filter" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>filter</span></a><a href="#gravatar" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>gravatar</span></a><a href="#hash" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></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-2048"></use></svg><span>hostname</span></a><a href="#info" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>info</span></a><a href="#location" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>location</span></a><a href="#onlyParam" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>only<wbr/>Param</span></a><a href="#page" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>page</span></a><a href="#param" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>param</span></a><a href="#parse" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>parse</span></a><a href="#password" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></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-2048"></use></svg><span>path</span></a><a href="#popSubdomain" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>pop<wbr/>Subdomain</span></a><a href="#port" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></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-2048"></use></svg><span>protocol</span></a><a href="#search" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>search</span></a><a href="#size" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>size</span></a><a href="#sort" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sort</span></a><a href="#subdomain" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>subdomain</span></a><a href="#username" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>username</span></a><a href="#youTube" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>you<wbr/>Tube</span></a><a href="#defaults" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>defaults</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Webigail</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|