ts-url/reference-docs/index.html at develop · SafelyTyped/ts-url · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
<!doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>@safelytyped/url</title>
	<meta name="description" content="Documentation for @safelytyped/url">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="assets/css/main.css">
</head>
<body>
<header>
	<div class="tsd-page-toolbar">
		<div class="container">
			<div class="table-wrap">
				<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
					<div class="field">
						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
						<input id="tsd-search-field" type="text" />
					</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">@safelytyped/url</a>
				</div>
				<div class="table-cell" id="tsd-widgets">
					<div id="tsd-filter">
						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
						<div class="tsd-filter-group">
							<div class="tsd-select" id="tsd-filter-visibility">
								<span class="tsd-select-label">All</span>
								<ul class="tsd-select-list">
									<li data-value="public">Public</li>
									<li data-value="protected">Public/Protected</li>
									<li data-value="private" class="selected">All</li>
								</ul>
							</div>
							<input type="checkbox" id="tsd-filter-inherited" checked />
							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
							<input type="checkbox" id="tsd-filter-externals" checked />
							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
							<input type="checkbox" id="tsd-filter-only-exported" />
							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
						</div>
					</div>
					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
				</div>
			</div>
		</div>
	</div>
	<div class="tsd-page-title">
		<div class="container">
			<ul class="tsd-breadcrumb">
				<li>
					<a href="globals.html">Globals</a>
				</li>
			</ul>
			<h1>@safelytyped/url</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<div class="tsd-panel tsd-typography">
				<a href="#welcome-to-safelytypedurl" id="welcome-to-safelytypedurl" style="color: inherit; text-decoration: none;">
					<h1>Welcome To @safelytyped/url!</h1>
				</a>
				<a href="#introduction" id="introduction" style="color: inherit; text-decoration: none;">
					<h2>Introduction</h2>
				</a>
				<p>This is the README for <code>@safelytyped/url</code>. Rather than put all the docs in one, impossible-to-navigate file, this README is here to point you at where you can find all the documentation we&#39;ve written.</p>
				<a href="#quick-start" id="quick-start" style="color: inherit; text-decoration: none;">
					<h2>Quick Start</h2>
				</a>
				<pre><code><span class="hljs-comment"># run this from your Terminal</span>
<span class="hljs-built_in">npm</span> install @safelytyped/url</code></pre><pre><code class="language-typescript"><span class="hljs-comment">// add this import to your Typescript code</span>
<span class="hljs-keyword">import</span> { URL } <span class="hljs-keyword">from</span> <span class="hljs-string">&quot;@safelytyped/url&quot;</span></code></pre>
				<p><strong>VS Code users:</strong> once you&#39;ve added a single import anywhere in your project, you&#39;ll then be able to auto-import anything else that this library exports.</p>
				<a href="#documentation" id="documentation" style="color: inherit; text-decoration: none;">
					<h2>Documentation</h2>
				</a>
				<p>Looking for more detailed documentation? You&#39;ll find it under the <a href="./docs">docs</a> folder.</p>
				<ul>
					<li><a href="./docs/api/">Our public API</a></li>
					<li><a href="CHANGELOG.md">Our CHANGELOG</a></li>
					<li><a href="LICENSE.md">Our software license</a></li>
					<li><a href="AUTHORS.md">All contributors to date</a></li>
				</ul>
			</div>
		</div>
		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
			<nav class="tsd-navigation primary">
				<ul>
					<li class="globals  ">
						<a href="globals.html"><em>Globals</em></a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
					<li class=" tsd-kind-class">
						<a href="classes/invalidurldataerror.html" class="tsd-kind-icon">InvalidURLData<wbr>Error</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/url.html" class="tsd-kind-icon">URL</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/hrefpartswithhash.html" class="tsd-kind-icon">HRef<wbr>Parts<wbr>With<wbr>Hash</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/hrefpartswithhostname.html" class="tsd-kind-icon">HRef<wbr>Parts<wbr>With<wbr>Hostname</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/hrefpartswithpathname.html" class="tsd-kind-icon">HRef<wbr>Parts<wbr>With<wbr>Pathname</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/hrefpartswithsearch.html" class="tsd-kind-icon">HRef<wbr>Parts<wbr>With<wbr>Search</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/invalidurldata.html" class="tsd-kind-icon">InvalidURLData</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/prhrefparts.html" class="tsd-kind-icon">PRHRef<wbr>Parts</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/parsedurl.html" class="tsd-kind-icon">ParsedURL</a>
					</li>
					<li class=" tsd-kind-type-alias">
						<a href="globals.html#hrefparts" class="tsd-kind-icon">HRef<wbr>Parts</a>
					</li>
					<li class=" tsd-kind-variable">
						<a href="globals.html#absolutehrefregex" class="tsd-kind-icon">AbsoluteHRef<wbr>Regex</a>
					</li>
					<li class=" tsd-kind-variable">
						<a href="globals.html#module_name" class="tsd-kind-icon">MODULE_<wbr>NAME</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#getabsolutehrefelements" class="tsd-kind-icon">get<wbr>AbsoluteHRef<wbr>Elements</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#gethrefauthorityseparator" class="tsd-kind-icon">getHRef<wbr>Authority<wbr>Separator</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#gethrefcommonelements" class="tsd-kind-icon">getHRef<wbr>Common<wbr>Elements</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#gethrefhash" class="tsd-kind-icon">getHRef<wbr>Hash</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#gethrefhostnameandport" class="tsd-kind-icon">getHRef<wbr>Hostname<wbr>And<wbr>Port</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#gethrefsearch" class="tsd-kind-icon">getHRef<wbr>Search</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#isabsolutehrefdata" class="tsd-kind-icon">is<wbr>AbsoluteHRef<wbr>Data</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#ishrefhashdata" class="tsd-kind-icon">isHRef<wbr>Hash<wbr>Data</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#ishrefpartswithhash" class="tsd-kind-icon">isHRef<wbr>Parts<wbr>With<wbr>Hash</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#ishrefpartswithhostname" class="tsd-kind-icon">isHRef<wbr>Parts<wbr>With<wbr>Hostname</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#ishrefpartswithpathname" class="tsd-kind-icon">isHRef<wbr>Parts<wbr>With<wbr>Pathname</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#ishrefsearchdata" class="tsd-kind-icon">isHRef<wbr>Search<wbr>Data</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#isprhrefdata" class="tsd-kind-icon">isPRHRef<wbr>Data</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#isprhrefparts" class="tsd-kind-icon">isPRHRef<wbr>Parts</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#isurldata" class="tsd-kind-icon">isURLData</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#makehref" class="tsd-kind-icon">makeHRef</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#makehrefwithhostname" class="tsd-kind-icon">makeHRef<wbr>With<wbr>Hostname</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#makeprhref" class="tsd-kind-icon">makePRHRef</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#makeurl" class="tsd-kind-icon">makeURL</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#mustbeurldata" class="tsd-kind-icon">must<wbr>BeURLData</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#validatestringisurl" class="tsd-kind-icon">validate<wbr>String<wbr>IsURL</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#validateurldata" class="tsd-kind-icon">validateURLData</a>
					</li>
				</ul>
			</nav>
		</div>
	</div>
</div>
<footer class="with-border-bottom">
	<div class="container">
		<h2>Legend</h2>
		<div class="tsd-legend-group">
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
			</ul>
		</div>
	</div>
</footer>
<div class="container tsd-generator">
	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
</body>
</html>