uri.js

A URI/URL parser with two functions parse and stringify

Demo

http://www.dave-smith.info/GitHub/uri-js/demo/

parse

Parse a URL string and return an object

// Include uri.js before the following

var uriJS = window['github.com/davesmiths/uri-js'];

var output = uriJS.parse('http://user:pass@www.example.com:8080/path/to/file.html?ice=beam&cheese=toast&ice=cream#hash');

// output is
// {
//    "scheme": "http",
//    "user": "user",
//    "pass": "pass",
//    "host": "www.example.com",
//    "port": "8080",
//    "path": "/path/to/file.html",
//    "params": {
//        "ice": "cream",
//        "cheese": "toast"
//    },
//    "hash": "hash",
//    "readonly": {
//        "source": "http://user:pass@www.example.com:8080/path/to/file.html?ice=beam&cheese=toast&ice=cream#hash",
//         "params": [
//             {
//                 "key": "ice",
//                 "value": "beam"
//             },
//             {
//                 "key": "cheese",
//                 "value": "toast"
//             },
//             {
//                 "key": "ice",
//                 "value": "cream"
//             }
//         ]
//     }
// }

output = uriJS.parse('path/to/file.html?marmite=lemoncurd#yum');

// output is
// {
//     "path": "path/to/file.html",
//     "params": {
//         "marmite": "lemoncurd"
//     },
//     "hash": "yum",
//     "readonly": {
//         "source": "path/to/file.html?marmite=lemoncurd#yum",
//         "params": [
//             {
//                 "key": "marmite",
//                 "value": "lemoncurd"
//             }
//         ]
//     }
// }

// Common use of parse
output = uriJS.parse(window.location.href);

stringify

Take an object and return a URI string

output = uriJS.stringify({
    "path": "path/to/file.html",
    "hash": "yum"
});
// output is "path/to/file.html#yum";

Other schemes

uri.js defaults to using the URI Generic Syntax we're all familiar with: http(s)://, ftp://, .../path/file.html?query#hash. Schemes outside this are handled as follows:

output = uriJS.parse('mailto:frank.drebin@policesquad.com');

// output is
// {
//     "scheme": "mailto",
//     "path": "frank.drebin@policesquad.com",
//     "readonly": {
//         "source": "mailto:frank.drebin@policesquad.com"
//     }
// }

Browser Compatibility

To support IE 8 and less a polyfill for Array.map will be needed. Array.map is otherwise well supported.