April 22, 2012

URI.js

URI.js


I always want to shoot myself in the head when looking at code like the following:

```javascript var url = "http://example.org/foo?bar=baz", separator = url.indexOf('?') > -1 ? '&' : '?';

url += separator + encodeURIComponent("foo") + "=" + encodeURIComponent("bar"); ```

I still can't believe javascript - the f**ing backbone-language of the web - doesn't offer an API for mutating URLs. Browsers (Firefox) don't expose the Location object (the structure behind window.location). Yes, one could think of decomposed IDL attributes as a native URL management library. But it relies on the DOM element <a>, it's slow and doesn't offer any convenienve at all.

How about a nice, clean and simple API for mutating URIs:

javascript var url = new URL("http://example.org/foo?bar=baz"); url.addQuery("foo", "bar");

URI.js is here to help with that.

API Example

```javascript // mutating URLs URI("http://example.org/foo.html?hello=world") .username("rodneyrehm") // -> http://rodneyrehm@example.org/foo.html?hello=world .username("") // -> http://example.org/foo.html?hello=world .directory("bar") // -> http://example.org/bar/foo.html?hello=world .suffix("xml")
// -> http://example.org/bar/foo.xml?hello=world .query("")
// -> http://example.org/bar/foo.xml .tld("com")
// -> http://example.com/bar/foo.xml .query({ foo: "bar", hello: ["world", "mars"] }); // -> http://example.com/bar/foo.xml?foo=bar&hello=world&hello=mars

// cleaning things up URI("?&foo=bar&&foo=bar&foo=baz&") .normalizeQuery(); // -> ?foo=bar&foo=baz

// working with relative paths URI("/foo/bar/baz.html") .relativeTo("/foo/bar/world.html"); // -> ./baz.html

URI("/foo/bar/baz.html") .relativeTo("/foo/bar/sub/world.html") // -> ../baz.html .absoluteTo("/foo/bar/sub/world.html"); // -> /foo/bar/baz.html ```

See the About Page and API Docs for more stuff.

Minify

use Google Closure Compiler:

// ==ClosureCompiler== // @compilation_level SIMPLE_OPTIMIZATIONS // @output_file_name URI.min.js // @code_url http://medialize.github.com/URI.js/src/IPv6.js // @code_url http://medialize.github.com/URI.js/src/punycode.js // @code_url http://medialize.github.com/URI.js/src/URI.js // ==/ClosureCompiler==

Resources

Docs where you get more info on parsing and working with URLs

MozURLProperty

  • https://www.w3.org/Bugs/Public/show_bug.cgi?id=14148
  • http://www.whatwg.org/specs/web-apps/current-work/multipage/workers.html#workerlocation
  • MozURLProperty (not documented yet?!) https://developer.mozilla.org/User:trevorh/Interface_documentation_status

Alternatives

If you don't like URI.js, you may like one of these:

HTML5 URL Draft

Discussion on Hacker News

TODO

if you want to get involved, these are things you could help out with…

  • AMD stuff
  • modifiers for domain, tld, directory, file, suffix are hardly the most performant solutions
  • accept all IPv6 notations
  • accept URNs (so URI.js truly is URI, not only URL)

Authors

Contains Code From

Useless Information

I built this sucker during Christmas 2011. It was a nice excuse to get away from the annual family terror. You should try it some time…

Naming Libraries sucks

Quote from java doc: A URI is a uniform resource identifier while a URL is a uniform resource locator. Hence every URL is a URI, abstractly speaking, but not every URI is a URL. This is because there is another subcategory of URIs, uniform resource names (URNs), which name resources but do not specify how to locate them. The mailto, news, and isbn URIs shown above are examples of URNs.

URI.js only handles URLs - but since Firefox already used window.URL for some (yet undocumented) MozURLProperty, I named it URI anyways.

License

URI.js is published under the MIT license and GPL v3.

Changelog

1.3.1

  • Updated Punycode.js to version 0.3.0
  • added edge-case tests ("jim")
  • fixed edge-cases in .protocol(), .port(), .subdomain(), .domain(), .tld(), .filename()
  • fixed parsing of hostname in .hostname()

1.3.0

  • added .subdomain() convenience accessor
  • improved internal deferred build handling
  • fixed thrown Error for URI("http://example.org").query(true) (Issue #6)
  • added examples for extending URI.js for fragment abuse, see src/URI.fragmentQuery.js and src/URI.fragmentURI.js (Issue #2)

1.2.0

  • added .equals() for URL comparison
  • proper encoding/decoding for .pathname(), .directory(), .filename() and .suffix() according to RFC 3986 3.3
  • escape spaces in query strings with + according to application/x-www-form-urlencoded
  • allow URI.buildQuery() to build duplicate key=value combinations
  • added URI(string, string) constructor to conform with the specification
  • added .readable() for humanly readable representation of encoded URIs
  • fixed bug where @ in pathname would be parsed as part of the authority

1.1.0

1.0.0

  • Initial URI.js