forked from medialize/URI.js
/
docs.html
851 lines (712 loc) · 36.7 KB
/
docs.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
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="de" lang="de">
<head>
<meta charset="utf-8" />
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>URI.js - API Documentation</title>
<meta name="description" content="URI.js is a Javascript library for working with URLs." />
<script src="jquery-1.7.1.min.js" type="text/javascript"></script>
<script src="prettify/prettify.js" type="text/javascript"></script>
<script src="screen.js" type="text/javascript"></script>
<link href="screen.css" rel="stylesheet" type="text/css" />
<link href="prettify/prettify.sunburst.css" rel="stylesheet" type="text/css" />
<script src="src/IPv6.js" type="text/javascript"></script>
<script src="src/punycode.js" type="text/javascript"></script>
<script src="src/SecondLevelDomains.js" type="text/javascript"></script>
<script src="src/URI.js" type="text/javascript"></script>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-8922143-3']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<a id="github-forkme" href="https://github.com/medialize/URI.js"><img src="http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" /></a>
<div id="container">
<h1><a href="https://github.com/medialize/URI.js">URI.js</a></h1>
<ul class="menu">
<li><a href="/URI.js/">About</a></li>
<li class="active"><a href="docs.html">Documentation</a></li>
<li><a href="http://rodneyrehm.de/en/">Author</a></li>
</ul>
<ul class="toc">
<li><a href="#constructor">Constructing an URI</a></li>
<li>
Working with URI parts
<ul>
<li><a href="#accessors-protocol">protocol()</a></li>
<li><a href="#accessors-username">username()</a></li>
<li><a href="#accessors-password">password()</a></li>
<li><a href="#accessors-hostname">hostname()</a></li>
<li><a href="#accessors-port">port()</a></li>
<li><a href="#accessors-host">host()</a></li>
<li><a href="#accessors-authority">authority()</a></li>
<li><a href="#accessors-subdomain">subdomain()</a></li>
<li><a href="#accessors-domain">domain()</a></li>
<li><a href="#accessors-tld">tld()</a></li>
<li><a href="#accessors-pathname">pathname(), path()</a></li>
<li><a href="#accessors-directory">directory()</a></li>
<li><a href="#accessors-filename">filename()</a></li>
<li><a href="#accessors-suffix">suffix()</a></li>
<li><a href="#accessors-search">search(), query()</a></li>
<li><a href="#accessors-hash">hash(), fragment()</a></li>
<li><a href="#is">determine URL types</a></li>
</ul>
</li>
<li>
Working with the query string
<ul>
<li><a href="#accessors-search">search(), query()</a></li>
<li><a href="#search-add">addSearch(), addQuery()</a></li>
<li><a href="#search-remove">removeSearch(), removeQuery()</a></li>
</ul>
</li>
<li>
<a href="#fragment-abuse">Working with the Fragment (Hash)</a>
<ul>
<li><a href="#fragment-abuse-query">Data in Fragments (Hash)</a></li>
<li><a href="#fragment-abuse-uri">URLs in Fragments (Hash)</a></li>
</ul>
</li>
<li>
Normalizing an URL
<ul>
<li><a href="#normalize">normalize()</a></li>
<li><a href="#normalize-protocol">normalizeProtocol()</a></li>
<li><a href="#normalize-host">normalizeHostname()</a></li>
<li><a href="#normalize-port">normalizePort()</a></li>
<li><a href="#normalize-path">normalizePathname(), normalizePath()</a></li>
<li><a href="#normalize-search">normalizeSearch(), normalizeQuery()</a></li>
<li><a href="#normalize-hash">normalizeHash(), normalizeFragment()</a></li>
</ul>
</li>
<li>
Charsets / Encodings
<ul>
<li><a href="#iso8859">iso8859()</a></li>
<li><a href="#unicode">unicode()</a></li>
</ul>
</li>
<li><a href="#readable">readable()</a></li>
<li>
Relative and Absolute URLs
<ul>
<li><a href="#relativeto">relativeTo()</a></li>
<li><a href="#absoluteto">absoluteTo()</a></li>
</ul>
</li>
<li>
Comparing URLs
<ul>
<li><a href="#equals">equals()</a></li>
</ul>
</li>
<li>
Static Functions
<ul>
<li><a href="#static-parse">URI.parse()</a></li>
<li><a href="#static-parseAuthority">URI.parseAuthority()</a></li>
<li><a href="#static-parseHost">URI.parseHost()</a></li>
<li><a href="#static-parseQuery">URI.parseQuery()</a></li>
<li><a href="#static-build">URI.build()</a></li>
<li><a href="#static-buildAuthority">URI.buildAuthority()</a></li>
<li><a href="#static-buildHost">URI.buildHost()</a></li>
<li><a href="#static-buildQuery">URI.buildQuery()</a></li>
<li><a href="#static-addQuery">URI.addQuery()</a></li>
<li><a href="#static-removeQuery">URI.removeQuery()</a></li>
<li><a href="#static-commonPath">URI.commonPath()</a></li>
<li><a href="#static-withinString">URI.withinString()</a></li>
<li><a href="#static-iso8859">URI.iso8859()</a></li>
<li><a href="#static-unicode">URI.unicode()</a></li>
</ul>
</li>
</ul>
<h2 id="api-methods">URI.js API</h2>
<h3 id="constructor">URI Constructor</h3>
<pre class="prettyprint lang-js">var uri = new URI(); // same as new URI(location.href)
// string
var uri = new URI("http://example.org");
// URI object for cloning
var uri = new URI(new URI("http://example.org"));
// URI parts object
var uri = new URI({
protocol: 'http',
host: 'example.org'
});
// without new keyword
var uri = URI("http://example.org");
// resolving right in the constructor
var uri = URI("../foobar.html", "http://example.org/hello/world.html");
// which is exactly the same as
URI("../foobar.html").absoluteTo("http://example.org/hello/world.html");
// but specified in <a href="http://dvcs.w3.org/hg/url/raw-file/tip/Overview.html#constructor">URL constructor</a></pre>
<p>The following parts can be specified in an object:</p>
<pre class="prettyprint lang-js">var uri = new URI({
protocol: 'http', // no trailing :
username: 'user',
password: 'pass',
hostname: 'example.org',
port: '80', // string, please
// "path", not "pathname", sorry
path: '/foo/bar.html',
// "query", not "search", sorry
query: 'foo=bar&bar=baz', // no leading ?
// "fragment", not "hash", sorry
fragment: 'frag' // no leading #
});</pre>
<p>using only components of URIs:</p>
<pre class="prettyprint lang-js">// Look ma! I'm only working the pathname
var uri = new URI("some/directory/file.html");
// Look ma! I'm only working the query string
var uri = new URI("?foo=bar");
// Look ma! I'm only working the fragment / hash
var uri = new URI("#call-me-hash");
// and any combination of the above…</pre>
<h3 id="accessors-protocol">protocol()</h3>
<pre class="prettyprint lang-js">var uri = new URI("http://example.org/foo/hello.html");
// get protocol
uri.protocol(); // returns string "http"
// set protocol
uri.protocol("ftp"); // returns the URI instance for chaining</pre>
<p>NOTE: Throws a <code>TypeError</code> on illegal input</p>
<h3 id="accessors-username">username()</h3>
<pre class="prettyprint lang-js">var uri = new URI("http://user:pass@example.org/foo/hello.html");
// get username
uri.username(); // returns string "user"
// set username
uri.username("user"); // returns the URI instance for chaining</pre>
<h3 id="accessors-password">password()</h3>
<pre class="prettyprint lang-js">var uri = new URI("http://user:pass@example.org/foo/hello.html");
// get password
uri.password(); // returns string "pass"
// set password
uri.password("user"); // returns the URI instance for chaining</pre>
<h3 id="accessors-hostname">hostname()</h3>
<pre class="prettyprint lang-js">var uri = new URI("http://example.org/foo/hello.html");
// get protocol
uri.hostname(); // returns string
// set protocol
uri.hostname("example.org"); // returns the URI instance for chaining</pre>
<p>NOTE: <a href="#accessors-hostname">.hostname()</a> returns the actual hostname, whereas <a href="#accessors-host">.host()</a> returns the hostname including the port</p>
<h3 id="accessors-port">port()</h3>
<pre class="prettyprint lang-js">var uri = new URI("http://example.org:8080/foo/hello.html");
// get port
uri.port(); // returns string "8080"
// set port
uri.port("80"); // returns the URI instance for chaining</pre>
<p>NOTE: although the port may be considered an integer, within URI it is a string.</p>
<p>NOTE: Throws a <code>TypeError</code> on illegal input</p>
<h3 id="accessors-host">host()</h3>
<pre class="prettyprint lang-js">var uri = new URI("http://example.org:80/foo/hello.html");
// get host
uri.host(); // returns string "example.org:80"
// set host
uri.host("example.org:80"); // returns the URI instance for chaining</pre>
<p>NOTE: <a href="#accessors-hostname">.hostname()</a> returns the actual hostname, whereas <a href="#accessors-host">.host()</a> returns the hostname including the port</p>
<h3 id="accessors-authority">authority()</h3>
<p>Authority is comprised of username, password, hostname and port</p>
<pre class="prettyprint lang-js">var uri = new URI("http://user:pass@example.org:88/foo/hello.html");
// get authority
uri.authority(); // returns string "user:pass@example.org:88"
// set authority
uri.authority("user:pass@example.org:80"); // returns the URI instance for chaining</pre>
<p>NOTE: .authority() will reset any of username, password and port if they're not specified.</p>
<h3 id="accessors-domain">domain()</h3>
<p>.domain() is a convenience method that returns <code>example.org</code> from the hostname <code>www.example.org</code>.</p>
<pre class="prettyprint lang-js">var uri = new URI("http://example.org/foo/hello.html");
// get domain
uri.domain(); // returns string "example.org"
// set domain
uri.domain("otherdomain.com"); // returns the URI instance for chaining
// Second Level Domain (SLD) Support (as of URI.js 1.5.0)
uri = new URI("http://example.co.uk/foo/hello.html");
uri.domain(); // return string "example.co.uk"
uri.domain(true); // return string "co.uk"</pre>
<p>NOTE: .domain() will throw an error if you pass it an empty string.</p>
<p>NOTE: Throws a <code>TypeError</code> on illegal input</p>
<h3 id="accessors-subdomain">subdomain()</h3>
<p>.subdomain() is a convenience method that returns <code>www</code> from the hostname <code>www.example.org</code>.</p>
<pre class="prettyprint lang-js">var uri = new URI("http://www.example.org/foo/hello.html");
// get subdomain
uri.subdomain(); // returns string "www"
// set subdomain
uri.subdomain("other.subdomain"); // returns the URI instance for chaining</pre>
<p>NOTE: Throws a <code>TypeError</code> on illegal input</p>
<h3 id="accessors-tld">tld()</h3>
<p>.tld() is a convenience method that returns <code>org</code> from the hostname <code>www.example.org</code>.</p>
<pre class="prettyprint lang-js">var uri = new URI("http://example.org/foo/hello.html");
// get tld
uri.tld(); // returns string "org"
// set tld
uri.tld("com"); // returns the URI instance for chaining
// Second Level Domain (SLD) Support (as of URI.js 1.5.0)
uri = new URI("http://example.co.uk/foo/hello.html");
uri.tld(); // return string "co.uk"
uri.tld(true); // return string "uk"</pre>
<p>NOTE: Throws an <code>Error</code> if you pass it an empty string or use it on an IP-host.</p>
<h3 id="accessors-pathname">pathname(), path()</h3>
<p>.path() is an alias of .pathname()</p>
<pre class="prettyprint lang-js">var uri = new URI("http://example.org/foo/hello.html");
// get pathname
uri.pathname(); // returns string "/foo/hello.html"
// set pathname
uri.pathname("/foo/hello.html"); // returns the URI instance for chaining
// will encode for you
uri.pathname('/hello world/');
uri.pathname() === '/hello%20world/';
// will decode for you
uri.pathname(true) === '/hello world/';</pre>
<h3 id="accessors-directory">directory()</h3>
<p>.directory() is an convenience method for mutating the directory part of a path</p>
<pre class="prettyprint lang-js">var uri = new URI("http://example.org/foo/hello.html");
// get directory
uri.directory(); // returns string "/foo" (no trailing slash)
// set directory
uri.directory("/bar"); // returns the URI instance for chaining
// uri == "http://example.org/bar/hello.html"
// will encode for you
uri.directory('/hello world/');
uri.directory() === '/hello%20world';
// will decode for you
uri.directory(true) === '/hello world';</pre>
<h3 id="accessors-filename">filename()</h3>
<p>.filename() is an convenience method for mutating the filename part of a path</p>
<pre class="prettyprint lang-js">var uri = new URI("http://example.org/foo/hello.html");
// get filename
uri.filename(); // returns string "hello.html" (no leading slash)
// set filename
uri.filename("world.xml"); // returns the URI instance for chaining
// uri == "http://example.org/bar/world.xml"
// will encode for you
uri.filename('hello world.html');
uri.filename() === 'hello%20world.html';
// will decode for you
uri.filename(true) === 'hello world.html';</pre>
<p>NOTE: If you pass <code>../file.html</code>, the directory will be changed accordingly</p>
<h3 id="accessors-suffix">suffix()</h3>
<p>.suffix() is an convenience method for mutating the filename part of a path</p>
<pre class="prettyprint lang-js">var uri = new URI("http://example.org/foo/hello.html");
// get suffix
uri.suffix(); // returns string "html" (no leading dot)
// set suffix
uri.suffix("xml"); // returns the URI instance for chaining
// uri == "http://example.org/bar/world.xml"
// will encode for you
uri.suffix('würgh');
uri.suffix() === 'w%C3%BCrgh';
// will decode for you
uri.suffix(true) === 'würgh';</pre>
<h3 id="accessors-search">search(), query()</h3>
<pre class="prettyprint lang-js">var uri = new URI("http://example.org/foo/hello.html?foo=bar&bar=baz");
// get search
uri.search(); // returns string "?foo=bar&bar=baz" (leading ?)
// get query
uri.query(); // returns string "foo=bar&bar=baz" (no leading ?)
// .query() and .search() behave the same for the following:
// set search
uri.search("?foo=bar&bar=baz"); // returns the URI instance for chaining
uri.search("foo=bar&bar=baz"); // returns the URI instance for chaining
// uri == "http://example.org/bar/world.html?foo=bar&bar=baz"
uri.search(""); // returns the URI instance for chaining
// uri == "http://example.org/bar/world.html"
// get data map:
uri.search(true); // returns { foo: "bar", hello : ["world", "mars"] }
// set data map:
uri.search({ foo: "bar", hello : ["world", "mars"] });
// uri == "http://example.org/bar/world.html?foo=bar&hello=world&hello=mars"
// CAUTION: beware of arrays, the following are not quite the same
// If you're dealing with PHP, you probably want the latter…
uri.search("?foo=bar&bar=baz");
uri.search("?foo=bar[]&bar[]=baz");</pre>
<p>Note that names and values passed in an object are encoded automatically.
The object, resulting from parsing the query string, contains decoded values</p>
<p>Hint: If you're using jQuery, have a look at their <a href="http://api.jquery.com/serialize/">.serialize()</a> function.</p>
<h3 id="accessors-hash">hash(), fragment()</h3>
<pre class="prettyprint lang-js">var uri = new URI("http://example.org/foo/hello.html#world");
// get hash
uri.hash(); // returns string "#world" (leading #)
// get fragment
uri.fragment(); // returns string "world" (no leading #)
// .hash() and .fragment() behave the same for the following:
// set hash
uri.hash("#mars"); // returns the URI instance for chaining
uri.hash("mars"); // returns the URI instance for chaining
// uri == "http://example.org/bar/world.xml#mars"</pre>
<h3 id="is">is()</h3>
<p>.is() tells what a URL is. It responds with a boolean and can be asked the following questions:</p>
<dl>
<dt><code>relative<code></dt><dd><code>true</code> if URL doesn't have a hostname</dd>
<dt><code>domain</code>, <code>name</code></dt><dd><code>true</code> if hostname is not an IP</dd>
<dt><code>sld</code></dt><dd><code>true</code> if hostname is a second level domain (i.e. "example.co.uk")</dd>
<dt><code>idn</code></dt><dd><code>true</code> if hostname contains non-alphanumeric characters and is not an IP</dd>
<dt><code>punycode</code></dt><dd><code>true</code> if hostname contains <code>xn--</code></dd>
<dt><code>ip</code></dt><dd><code>true</code> if hostname is IPv4 or IPv6</dd>
<dt><code>ip4</code>, <code>ipv4</code>, <code>inet4</code></dt><dd><code>true</code> if hostname is IPv4</dd>
<dt><code>ip6</code>, <code>ipv6</code>, <code>inet6</code></dt><dd><code>true</code> if hostname is IPv6</dd>
</dl>
<pre class="prettyprint lang-js">var uri = new URI("http://example.org/");
uri.is('relative') === false;
uri.is('name') === true;
uri.is('sld') === false;
uri.is('punycode') === false;
uri.is('IDN') === false; // case doesn't matter
uri.is('idn') === false; // case doesn't matter
uri.is('ip') === false;
var uri = new URI("http://123.123.123.123/");
uri.is('relative') === false;
uri.is('name') === false;
uri.is('sld') === false;
uri.is('IP') === true;
uri.is('IPv4') === true;
uri.is('IPv6') === false;
var uri = new URI("http://fe80:0000:0000:0000:0204:61ff:fe9d:f156/");
uri.is('IP') === true;
uri.is('IPv4') === false;
uri.is('IPv6') === true;
var uri = new URI("/hello/world.html");
uri.is('relative') === true;
uri.is('name') === false;
uri.is('IP') === false;
var uri = new URI("http://example.co.uk/");
uri.is('name') === true;
uri.is('sld') === true;</pre>
<h2 id="querystrings">Working with the query string</h2>
<h3 id="search-add">addSearch(), addQuery()</h3>
<p>.addQuery() is an alias of .addSearch()</p>
<pre class="prettyprint lang-js">var uri = new URI("?hello=world");
uri.addSearch("hello", "mars"); // returns the URI instance for chaining
// uri == "?hello=world&hello=mars"
uri.addSearch({ foo: "bar", goodbye : ["world", "mars"] });
// uri == "?hello=world&hello=mars&foo=bar&goodbye=world&goodbye=mars"
// CAUTION: beware of arrays, the following are not quite the same
// If you're dealing with PHP, you probably want the latter…
uri.addSearch("foo", ["bar", "baz"]);
uri.addSearch("foo[]", ["bar", "baz"]);</pre>
<p>Note that names and values passed in are encoded automatically.</p>
<h3 id="search-remove">removeSearch(), removeQuery()</h3>
<p>.removeQuery() is an alias of .removeSearch()</p>
<pre class="prettyprint lang-js">var uri = new URI("?hello=world&hello=mars&foo=bar");
// remove an attribute
uri.removeSearch("hello"); // returns the URI instance for chaining
// uri == "?foo=bar"
// remove an attribute with value filter
uri.search("?hello=world&hello=mars&foo=bar");
uri.removeSearch("hello", "world"); // returns the URI instance for chaining
// uri == "?hello=mars&foo=bar"
// remove multiple values
uri.search("?hello=world&hello=mars&foo=bar&mine=true");
uri.removeSearch(["hello", "foo"]);
// uri == "?mine=true"
// remove multiple values with value filter
uri.search("?hello=world&hello=mars&foo=bar&mine=true&a=1&a=2&a=3");
uri.removeSearch({hello: "world", foo: undefined, a: ["1", "3"]});
// uri == "?hello=mars&mine=true&a=2"</pre>
<h2 id="fragment-abuse">Working with the Fragment (Hash)</h2>
<p>
There are virtually no limits to what you might do with fragments (hash).
Every system has their own bag of tricks.
As a result URI.js cannot offer any of the following tools right out of the box.
The most common <em>abuse of fragments</em> are storing URLs or query string like data.
</p>
<h3 id="fragment-abuse-query">Query String Fragments</h3>
<p>The file <a href="https://github.com/medialize/URI.js/blob/gh-pages/src/URI.fragmentQuery.js">src/URI.fragmentQuery.js</a> is a "plugin" that allows you to store data in hashes in the same manner the .query() functions provide.</p>
<pre class="prettyprint lang-js">var uri = new URI("#?hello=world");
uri.addFragment("hello", "mars"); // returns the URI instance for chaining
// uri == "#?hello=world&hello=mars"</pre>
<h3 id="fragment-abuse-uri">URL Fragments</h3>
<p>The file <a href="https://github.com/medialize/URI.js/blob/gh-pages/src/URI.fragmentURI.js">src/URI.fragmentURI.js</a> is a "plugin" that allows you to store URLs in hashes.</p>
<pre class="prettyprint lang-js">var uri = URI("http://example.org/#!/foo/bar/baz.html"),
furi = uri.fragment(true);
// manipulating the fragment URI
furi.pathname() === '/foo/bar/baz.html';
furi.pathname('/hello.html');
// has direct effect on the actual URI
uri.toString() === "http://example.org/#!/hello.html"</pre>
<h2 id="normalizing">Normalizing URLs</h2>
<h3 id="normalize">normalize()</h3>
<p>executes normalizeProtocol(), normalizeHostname(), normalizePort(), normalizePath(), normalizeSearch(), normalizeHash()</p>
<h3 id="normalize-protocol">normalizeProtocol()</h3>
<pre class="prettyprint lang-js">var uri = new URI("hTTp://www.example.org/");
// normalize protocol
uri.normalizeProtocol(); // returns the URI instance for chaining
// uri == "http://www.example.org/"</pre>
<h3 id="normalize-host">normalizeHostname()</h3>
<p>For IDN conversion <a href="https://github.com/bestiejs/punycode.js">punycode.js</a> must be available (bundled in URI.js).
For IPv6-best-notation conversion IPv6.js must be available (bundled in URI.js). Also lower-cases hostnames.</p>
<pre class="prettyprint lang-js">var uri = new URI("http://www.exämple.org/");
// normalize IDN host
uri.normalizeHostname(); // returns the URI instance for chaining
// uri == "http://www.xn--exmple-cua.org/"
// normalize IPv6 host
uri.hostname('fe80:0000:0000:0000:0204:61ff:fe9d:f156');
uri.normalizeHostname(); // returns the URI instance for chaining
// uri == "http://fe80::204:61ff:fe9d:f156/"
// normalize hostname to lower case
uri.hostname('wWw.eXample.Org');
uri.normalizeHostname(); // returns the URI instance for chaining
// uri == "http://www.example.org/"</pre>
<p>There is no .normalizeHost(), as <a href="#accessors-host">.host()</a> is a property comprised of <a href="#accessors-hostname">.hostname()</a> and <a href="#accessors-port">.port()</a></p>
<h3 id="normalize-port">normalizePort()</h3>
<p>Removes the port, if it's the default for the given protocol (http: 80, https: 443, ftp: 21).</p>
<p>The list of default ports can be modified at <code>URI.defaultPorts</code></p>
<pre class="prettyprint lang-js">var uri = new URI("http://example.org:80/foo.html");
// normalize port
uri.normalizePort(); // returns the URI instance for chaining
// uri == "http://example.org/foo.html"</pre>
<h3 id="normalize-path">normalizePathname(), normalizePath()</h3>
<p>.normalizePath() is an alias of .normalizePathname(), they resolve relative hierarchies</p>
<pre class="prettyprint lang-js">var uri = new URI("/hello/foo/woo/.././../world.html");
// normalize path
uri.normalizePathname(); // returns the URI instance for chaining
// uri == "/hello/world.html"</pre>
<h3 id="normalize-search">normalizeSearch(), normalizeQuery()</h3>
<p>Turns <code>?&foo=bar&&foo=bar&foo=baz&</code> into <code>?foo=bar&foo=baz</code> and removes ? if there is no query string.</p>
<pre class="prettyprint lang-js">var uri = new URI("?&foo=bar&&foo=bar&foo=baz&");
// normalize search
uri.normalizeSearch(); // returns the URI instance for chaining
// uri == "?foo=bar&foo=baz"</pre>
<h3 id="normalize-hash">normalizeHash(), normalizeFragment()</h3>
<p>removes # if there is no hash</p>
<pre class="prettyprint lang-js">var uri = new URI("http://example.org/foo/hello.html#");
// normalize hash
uri.normalizeHash(); // returns the URI instance for chaining
// uri == "http://example.org/bar/world.xml"</pre>
<h2 id="charsets">Charsets / Encodings</h2>
<h3 id="#iso8859">iso8859()</h3>
<p>.iso8859() converts unicode-encoded escape sequences to ISO8859-encoded escape sequences. It does this by calling <a href="#normalize">.normalize()</a> internally.</p>
<pre class="prettyprint lang-js">var uri = new URI("/%C3%A4.html");
uri.iso8859(); // returns the URI instance for chaining
// uri == "/%E4.html"</pre>
<p>NOTE: You can make URI work with ISO8859 encoding by default by calling <a href="#static-iso8859">URI.iso8859()</a>.
<h3 id="#unicode">unicode()</h3>
<p>.unicode() converts ISO8859-encoded escape sequences to unicode-encoded escape sequences. It does this by calling <a href="#normalize">.normalize()</a> internally.</p>
<pre class="prettyprint lang-js">var uri = new URI("/%E4.html");
uri.unicode(); // returns the URI instance for chaining
// uri == "/%C3%A4.html"</pre>
<h2 id="formatting">Formatting URLs</h2>
<h3 id="readable">readable()</h3>
<p>Formats URLs to be human readable (much like your browser does nowadays).</p>
<pre class="prettyprint lang-js">var uri = new URI("http://foo:bar@www.xn--exmple-cua.org/"
+ "hello%20world/ä.html?foo%5B%5D=b+är#fragment");
u.readable() === "http://www.exämple.org/"
+ "hello world/ä.html?foo[]=b är#fragment";</pre>
<h2 id="relative-and-absolute">Relative and Absolute URLs</h2>
<h3 id="relativeto">relativeTo()</h3>
<p>.relativeTo() compares to paths an makes one relative to the other</p>
<pre class="prettyprint lang-js">var uri = new URI("/relative/path");
// make path relative
var relUri = uri.relativeTo("/relative/sub/foo/sub/file"); // returns a new URI instance
// relUri == "../../../path"</pre>
<p>.relativeTo() and .absoluteTo() reverse each other.</p>
<h3 id="absoluteto">absoluteTo()</h3>
<p>.absoluteTo() makes a relative path absolute based on another path</p>
<pre class="prettyprint lang-js">var uri = new URI("../../../path");
// make path absolute
var relUri = uri.absoluteTo("/relative/sub/foo/sub/file"); // returns a new URI instance
// relUri == "/relative/path"</pre>
<p>.relativeTo() and .absoluteTo() reverse each other.</p>
<h2 id="comparison">Comparing URLs</h2>
<h3 id="equals">equals()</h3>
<p>.equals() determines if the given URLs are the same - disregarding default ports, capitalization, dot-pathnames, query-parameter order, etc.</p>
<pre class="prettyprint lang-js">var a = "http://example.org/foo/bar.html"
+ "?foo=bar&hello=world&hello=mars#fragment",
b;
// normalizing URI before comparison:
b = "http://exAMPle.org:80/foo/../foo/bar.html"
+ "?foo=bar&hello=world&hello=mars#fragment";
a !== b;
URI(a).equals(b) === true;
// comparing query string parameters:
b = "http://example.org/foo/bar.html"
+ "?hello=mars&foo=bar&hello=world&#fragment";
a !== b;
URI(a).equals(b) === true;
// shorthand for comparing to window.location.href:
URI(a).equals();</pre>
<h2 id="static-functions">Static Functions</h2>
<h3 id="static-parse">URI.parse(<em>string</em> url)</h3>
<p>parses a string into its URI components. returns an object containing the found components</p>
<pre class="prettyprint lang-js">var result = URI.parse("http://example.org/foo.html");
result === {
protocol: "http",
username: null,
password: null,
hostname: "example.org",
port: null,
path: "/foo.html",
query: null,
fragment: null
};</pre>
<h3 id="static-parseAuthority">URI.parseAuthority(<em>string</em> url, <em>object</em> parts)</h3>
<p>parses a string's beginning into its URI components username, password, hostname, port.
Found components are appended to the <code>parts</code> parameter.
Remaining string is returned</p>
<pre class="prettyprint lang-js">var parts = {},
result = URI.parseAuthority("user:pass@example.org:8080/foo.html", parts);
result === "/foo.html";
parts === {
username: "user",
password: "pass",
hostname: "example.org",
port: "8080"
};</pre>
<h3 id="static-parseHost">URI.parseHost(<em>string</em> url, <em>object</em> parts)</h3>
<p>parses a string's beginning into its URI components hostname, port.
Found components are appended to the <code>parts</code> parameter.
Remaining string is returned</p>
<pre class="prettyprint lang-js">var parts = {},
result = URI.parseAuthority("example.org:8080/foo.html", parts);
result === "/foo.html";
parts === {
hostname: "example.org",
port: "8080"
};</pre>
<h3 id="static-parseQuery">URI.parseQuery(<em>string</em> querystring)</h3>
<p>Parses the passed query string into an object. Returns object <code>{propertyName: propertyValue}</code></p>
<pre class="prettyprint lang-js">var result = URI.parseQuery("?foo=bar&hello=world&hello=mars&bam=&yup");
result === {
foo: "bar",
hello: ["world", "mars"],
bam: "",
yup: null
};</pre>
<h3 id="static-build">URI.build(<em>object</em> parts)</h3>
<p>serializes the URI components passed in <code>parts</code> into a URI string</p>
<pre class="prettyprint lang-js">var parts = {
protocol: "http",
username: null,
password: null,
hostname: "example.org",
port: null,
path: "/foo.html",
query: null,
fragment: null
};
URI.build(parts) === "http://example.org/foo.html";</pre>
<h3 id="static-buildAuthority">URI.buildAuthority(<em>object</em> parts)</h3>
<p>serializes the URI components username, password, hostname, port passed in <code>parts</code> into a URI string</p>
<pre class="prettyprint lang-js">var parts = {
username: "user",
password: "pass",
hostname: "example.org",
port: "8080"
};
URI.buildAuthority(parts) === "user:pass@example.org:8080";</pre>
<h3 id="static-buildHost">URI.buildHost(<em>object</em> parts)</h3>
<p>serializes the URI components hostname, port passed in <code>parts</code> into a URI string</p>
<pre class="prettyprint lang-js">var parts = {
hostname: "example.org",
port: "8080"
};
URI.buildHost(parts) === "example.org:8080";</pre>
<h3 id="static-buildQuery">URI.buildQuery(<em>object</em> data, [<em>boolean</em> duplicates])</h3>
<p>serializes the query string parameters</p>
<pre class="prettyprint lang-js">var data = {
foo: "bar",
hello: ["world", "mars", "mars"],
bam: "",
yup: null,
removed: undefined
}
// Note: duplicate hello=mars is dropped (default behavior!)
URI.buildQuery(data) === "foo=bar&hello=world&hello=mars&bam=&yup";
// Note: duplicate hello=mars is preserved
URI.buildQuery(data, true) === "foo=bar&hello=world&hello=mars&hello=mars&bam=&yup";</pre>
<p>To preserve duplicate values, use URI.buildQuery() directly:</p>
<pre class="prettyprint lang-js">var uri = new URI("http://example.org/foo.html?bar=baz"),
data = uri.query(true);
data.some = "new data";
uri.query(URI.buildQuery(data, true));
// you can also use the static <a href="#static-addQuery">URI.addQuery()</a> and <a href="#static-removeQuery">URI.removeQuery()</a>
URI.addQuery(data, "hello", "world");
uri.query(URI.buildQuery(data, true));</pre>
<h3 id="static-addQuery">URI.addQuery()</h3>
<p>adds data to a map</p>
<pre class="prettyprint lang-js">var data = {};
URI.addQuery(data, "hello", "mars");
data === {hello: 'mars'};
URI.addQuery(data, "hello", "world");
data === {hello: ['mars', 'world']};
URI.addQuery(data, {foo: "bar", goodbye : ["world", "mars"]});
data === {hello: ['mars', 'world'], foo: "bar", goodbye : ["world", "mars"]};</pre>
<h3 id="static-removeQuery">URI.removeQuery()</h3>
<p>removes data from a map</p>
<pre class="prettyprint lang-js">var data === {hello: ['mars', 'world'], foo: "bar", goodbye : ["world", "mars"]};
URI.removeQuery(data, "hello");
data === {foo: "bar", goodbye : ["world", "mars"]};
// remove an attribute with value filter
data = {hello: ["world", "mars"], foo: "bar"};
URI.removeQuery(data, "hello", "world");
data === {hello: ["mars"], foo: "bar"} // yes, still an array
// remove multiple values
data = {hello: ["world", "mars"], foo: "bar", mine: "true"}
URI.removeQuery(["hello", "foo"]);
data === {mine: "true"};
// remove multiple values with value filter
data = {hello: ["world", "mars"], foo: "bar", mine: "true", a: ["1", "2", "3"]}
URI.removeQuery({hello: "world", foo: undefined, a: ["1", "3"]});
data === {hello: ["mars"], mine: "true", a: ["2"]}</pre>
<h3 id="static-commonPath">URI.commonPath()</h3>
<p>URI.commonPath() determines the common base directory of two paths.</p>
<pre class="prettyprint lang-js">URI.commonPath('/foo/bar/baz.html', '/foo/bar/world.html');
// returns "/foo/bar/"
URI.commonPath('/foo/bar/baz.html', '/foo/bazz/world.html');
// returns "/foo/"
URI.commonPath('/foo/bar/baz.html', '/other/world.html');
// returns "/"
URI.commonPath('/foo', 'bar');
// returns ""</pre>
<h3 id="static-withinString">URI.withinString()</h3>
<p>URI.withinString() identifies URIs within text, e.g. to translate them to <a>-Tags. (Obviously you'd want to put the urls inside the href-Attribute and escape them properly…)</p>
<pre class="prettyprint lang-js">var source = "Hello www.example.com,\n"
+ "http://google.com is a search engine, like http://www.bing.com\n"
+ "http://exämple.org/foo.html?baz=la#bumm is an IDN URL,\n"
+ "http://123.123.123.123/foo.html is IPv4 and "
+ "http://fe80:0000:0000:0000:0204:61ff:fe9d:f156/foobar.html is IPv6.\n"
+ "links can also be in parens (http://example.org) "
+ "or quotes »http://example.org«.";
var result = URI.withinString(source, function(url) {
// callback needs to return a string
// feel free to URI(url).normalize().toString() or something
return '<a>' + url + '</a>';
});
/* result is:
Hello <strong><a>www.example.com</a></strong>,
<strong><a>http://google.com</a></strong> is a search engine, like <strong><a>http://www.bing.com</a></strong>
<strong><a>http://exämple.org/foo.html?baz=la#bumm</a></strong> is an IDN URL,
<strong><a>http://123.123.123.123/foo.html</a></strong> is IPv4 and <strong><a>http://fe80:0000:0000:0000:0204:61ff:fe9d:f156/foobar.html</a></strong> is IPv6.
links can also be in parens (<strong><a>http://example.org</a></strong>) or quotes »<strong><a>http://example.org</a></strong>«.
*/
// a proper replacement could look like the following:
var escapeHtml = function(string) {
return string
.replace(/&/g, '&amp;')
.replace(/</g, '&lt;')
.replace(/>/g, '&gt;')
.replace(/"/g, '&quot;');
}
result = URI.withinString(source, function(url) {
var uri = new URI(url);
uri.normalize();
return '<a href="' + escapeHtml(uri) + '">'
+ escapeHtml(url.<a href="#readable">readable</a>()) + '</a>';
});
</pre>
<h3 id="static-iso8859">URI.iso8859()</h3>
<p>URI.iso8859() tells URI.js to use the older escape/unescape methods, for backwards compatibility with non-unicode platforms.</p>
<pre class="prettyprint lang-js">URI.iso8859();
var uri = new URI("http://example.org/foo/æ.html");
// http://example.org/foo/%E6.html</pre>
<h3 id="static-unicode">URI.unicode()</h3>
<p>URI.unicode() restores the default unicode-encoded URLs.</p>
<pre class="prettyprint lang-js">URI.unicode();
var uri = new URI("http://example.org/foo/æ.html");
// http://example.org/foo/%C3%A6.html</pre>
</div>
</body>
</html>