forked from mmistakes/minimal-mistakes
/
_uirouter_core_common_coreservices.locationconfig.html
400 lines (400 loc) · 20.4 KB
/
_uirouter_core_common_coreservices.locationconfig.html
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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
---
---
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>LocationConfig | @uirouter/angular</title>
<meta name="description" content="Documentation for @uirouter/angular">
<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">@uirouter/angular</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>
</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="../index.html">@uirouter/angular</a>
</li>
<li>
<a href="../modules/_uirouter_core_common_coreservices.html">@uirouter/core/common/coreservices</a>
</li>
<li>
<a href="_uirouter_core_common_coreservices.locationconfig.html">LocationConfig</a>
</li>
</ul>
<h1>Interface LocationConfig</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns low level URL configuration and metadata</p>
</div>
<p>This service returns information about the location configuration.
This service is primarily used when building URLs (e.g., for <code>hrefs</code>)</p>
<p>Implementors should pass these through to the underlying URL APIs.
The underlying URL mechanism might be browser APIs, framework APIs, or some 3rd party URL management library.</p>
<p>UI-Router Core includes two basic implementations:</p>
<ul>
<li><a href="../classes/_uirouter_core_vanilla_browserlocationconfig.browserlocationconfig.html">BrowserLocationConfig</a></li>
<li><a href="../classes/_uirouter_core_vanilla_memorylocationconfig.memorylocationconfig.html">MemoryLocationConfig</a></li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="_uirouter_core_interface.disposable.html" class="tsd-signature-type">Disposable</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">LocationConfig</span>
<ul class="tsd-hierarchy">
<li>
<a href="_uirouter_core_url_interface.urlconfigapi.html" class="tsd-signature-type">UrlConfigApi</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implemented by</h3>
<ul class="tsd-hierarchy">
<li><a href="../classes/_uirouter_core_vanilla_browserlocationconfig.browserlocationconfig.html" class="tsd-signature-type">BrowserLocationConfig</a></li>
<li><a href="../classes/_uirouter_core_vanilla_memorylocationconfig.memorylocationconfig.html" class="tsd-signature-type">MemoryLocationConfig</a></li>
<li><a href="../classes/_location_locationconfig_.ng2locationconfig.html" class="tsd-signature-type">Ng2LocationConfig</a></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-external">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_uirouter_core_common_coreservices.locationconfig.html#basehref" class="tsd-kind-icon">base<wbr>Href</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_uirouter_core_common_coreservices.locationconfig.html#hashprefix" class="tsd-kind-icon">hash<wbr>Prefix</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_uirouter_core_common_coreservices.locationconfig.html#host" class="tsd-kind-icon">host</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_uirouter_core_common_coreservices.locationconfig.html#html5mode" class="tsd-kind-icon">html5<wbr>Mode</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_uirouter_core_common_coreservices.locationconfig.html#port" class="tsd-kind-icon">port</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_uirouter_core_common_coreservices.locationconfig.html#protocol" class="tsd-kind-icon">protocol</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited tsd-is-external">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="_uirouter_core_common_coreservices.locationconfig.html#dispose" class="tsd-kind-icon">dispose</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="basehref" class="tsd-anchor"></a>
<h3>base<wbr>Href</h3>
<div class="tsd-signature tsd-kind-icon">base<wbr>Href<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">UrlConfig</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"baseHref"</span><span class="tsd-signature-symbol">]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/3d8c4a8/src/common/coreservices.ts#L90">@uirouter/core/src/common/coreservices.ts:90</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>See: <a href="../classes/_uirouter_core_url_urlconfig.urlconfig.html#basehref">UrlConfig.baseHref</a></p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="hashprefix" class="tsd-anchor"></a>
<h3>hash<wbr>Prefix</h3>
<div class="tsd-signature tsd-kind-icon">hash<wbr>Prefix<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">UrlConfig</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"hashPrefix"</span><span class="tsd-signature-symbol">]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/3d8c4a8/src/common/coreservices.ts#L92">@uirouter/core/src/common/coreservices.ts:92</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>See: <a href="../classes/_uirouter_core_url_urlconfig.urlconfig.html#hashprefix">UrlConfig.hashPrefix</a></p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="host" class="tsd-anchor"></a>
<h3>host</h3>
<div class="tsd-signature tsd-kind-icon">host<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">UrlConfig</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"host"</span><span class="tsd-signature-symbol">]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/3d8c4a8/src/common/coreservices.ts#L89">@uirouter/core/src/common/coreservices.ts:89</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>See: <a href="../classes/_uirouter_core_url_urlconfig.urlconfig.html#host">UrlConfig.host</a></p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="html5mode" class="tsd-anchor"></a>
<h3>html5<wbr>Mode</h3>
<div class="tsd-signature tsd-kind-icon">html5<wbr>Mode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">UrlConfig</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"html5Mode"</span><span class="tsd-signature-symbol">]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/3d8c4a8/src/common/coreservices.ts#L91">@uirouter/core/src/common/coreservices.ts:91</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>See: <a href="../classes/_uirouter_core_url_urlconfig.urlconfig.html#html5mode">UrlConfig.html5Mode</a></p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="port" class="tsd-anchor"></a>
<h3>port</h3>
<div class="tsd-signature tsd-kind-icon">port<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">UrlConfig</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"port"</span><span class="tsd-signature-symbol">]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/3d8c4a8/src/common/coreservices.ts#L87">@uirouter/core/src/common/coreservices.ts:87</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>See: <a href="../classes/_uirouter_core_url_urlconfig.urlconfig.html#port">UrlConfig.port</a></p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="protocol" class="tsd-anchor"></a>
<h3>protocol</h3>
<div class="tsd-signature tsd-kind-icon">protocol<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">UrlConfig</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"protocol"</span><span class="tsd-signature-symbol">]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/3d8c4a8/src/common/coreservices.ts#L88">@uirouter/core/src/common/coreservices.ts:88</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>See: <a href="../classes/_uirouter_core_url_urlconfig.urlconfig.html#protocol">UrlConfig.protocol</a></p>
</div>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-external">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="dispose" class="tsd-anchor"></a>
<h3>dispose</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<li class="tsd-signature tsd-kind-icon">dispose<span class="tsd-signature-symbol">(</span>router<span class="tsd-signature-symbol">?: </span><a href="../classes/_uirouter_core_router.uirouter.html" class="tsd-signature-type">UIRouter</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_uirouter_core_url_interface.urlconfigapi.html">UrlConfigApi</a>.<a href="_uirouter_core_url_interface.urlconfigapi.html#dispose">dispose</a></p>
<ul>
<li>Defined in <a href="https://github.com/ui-router/core/blob/3d8c4a8/src/interface.ts#L117">@uirouter/core/src/interface.ts:117</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Instructs the Disposable to clean up any resources</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> router: <a href="../classes/_uirouter_core_router.uirouter.html" class="tsd-signature-type">UIRouter</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="label ">
<span></span>
</li>
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="../classes/_uirouter_core_router.uirouter.html">UIRouter</a>
</li>
<li class="label ">
<span>Services</span>
</li>
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="../classes/_uirouter_core_state_stateservice.stateservice.html">State<wbr>Service</a>
</li>
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="../classes/_uirouter_core_state_stateregistry.stateregistry.html">State<wbr>Registry</a>
</li>
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="../classes/_uirouter_core_transition_transitionservice.transitionservice.html">Transition<wbr>Service</a>
</li>
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="../classes/_uirouter_core_url_urlservice.urlservice.html">Url<wbr>Service</a>
</li>
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="../classes/_uirouter_core_url_urlconfig.urlconfig.html">Url<wbr>Config</a>
</li>
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="../classes/_uirouter_core_url_urlrules.urlrules.html">Url<wbr>Rules</a>
</li>
<li class="label ">
<span>Interfaces</span>
</li>
<li class="current tsd-kind-interface tsd-parent-kind-module tsd-is-external">
<a href="_interface_.ng2statedeclaration.html">Ng2<wbr>State<wbr>Declaration</a>
</li>
<li class="current tsd-kind-interface tsd-parent-kind-module tsd-is-external">
<a href="_interface_.uionparamschanged.html">Ui<wbr>OnParams<wbr>Changed</a>
</li>
<li class="current tsd-kind-interface tsd-parent-kind-module tsd-is-external">
<a href="_interface_.uionexit.html">Ui<wbr>OnExit</a>
</li>
<li class="label ">
<span>Components</span>
</li>
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="../classes/_directives_uiview_.uiview.html">UIView</a>
</li>
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="../classes/_directives_uisref_.uisref.html">UISref</a>
</li>
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="../classes/_directives_uisrefactive_.uisrefactive.html">UISref<wbr>Active</a>
</li>
<li class="label ">
<span>Other</span>
</li>
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="../classes/_uirouter_core_transition_transition.transition.html">Transition</a>
</li>
<li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
<a href="../classes/_uirouter_core_common_trace.trace.html">Trace</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-is-external">
<a href="_uirouter_core_common_coreservices._injectorlike.html" class="tsd-kind-icon">$<wbr>Injector<wbr>Like</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-is-external">
<a href="_uirouter_core_common_coreservices._qlike.html" class="tsd-kind-icon">$QLike</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-is-external">
<a href="_uirouter_core_common_coreservices._qlikedeferred.html" class="tsd-kind-icon">$QLike<wbr>Deferred</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-is-external">
<a href="_uirouter_core_common_coreservices.coreservices.html" class="tsd-kind-icon">Core<wbr>Services</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module tsd-is-external">
<a href="_uirouter_core_common_coreservices.locationconfig.html" class="tsd-kind-icon">Location<wbr>Config</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_uirouter_core_common_coreservices.locationconfig.html#basehref" class="tsd-kind-icon">base<wbr>Href</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_uirouter_core_common_coreservices.locationconfig.html#hashprefix" class="tsd-kind-icon">hash<wbr>Prefix</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_uirouter_core_common_coreservices.locationconfig.html#host" class="tsd-kind-icon">host</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_uirouter_core_common_coreservices.locationconfig.html#html5mode" class="tsd-kind-icon">html5<wbr>Mode</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_uirouter_core_common_coreservices.locationconfig.html#port" class="tsd-kind-icon">port</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="_uirouter_core_common_coreservices.locationconfig.html#protocol" class="tsd-kind-icon">protocol</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="_uirouter_core_common_coreservices.locationconfig.html#dispose" class="tsd-kind-icon">dispose</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-is-external">
<a href="_uirouter_core_common_coreservices.locationservices.html" class="tsd-kind-icon">Location<wbr>Services</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter tsd-is-external">
<a href="../modules/_uirouter_core_common_coreservices.html#makestub" class="tsd-kind-icon">make<wbr>Stub</a>
</li>
<li class=" tsd-kind-object-literal tsd-parent-kind-module tsd-is-external">
<a href="../modules/_uirouter_core_common_coreservices.html#services" class="tsd-kind-icon">services</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
</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>