IRI: A utility for converting and parsing URIs and IRIs

Utilities for using RFC 3987 and
RFC 3986

IRIs are unicode URIs, URIs by definition being 7-bit characters.

Construction of the URI

From RFC 3986:

foo://example.com:8042/over/there?name=ferret#nose
\_/ \______________/\_________/ \_________/ \__/
| | | | |
scheme authority path query fragment
| _____________________|__
/ \ / \
urn:example:animal:ferret:nose

The authority exists in a URI/IRI and is marked by a leading //. It can be broken down into a number of other components:

root:hunter2@[::1]:8080
\__________/ \___/ \__/
| | |
userinfo host port

Usage of IRI

The constructor takes a single argument, a URI or IRI string:

var iri = require('iri');
var path = new iri.IRI(str).resolveReference('/');

$3

Returns UTF-16 IRI

$3

Returns the IRI without the fragment component. Useful for dereferencing URLs on a network.

new IRI().defrag() === 'http://example.com/resource'

$3

IRIs with a fragment are not absolute.

$3

Resolves the IRI against itself, having the effect of stripping the fragment and checking that the supplied IRI is valid (absolute).

$3

Returns the authority component of the IRI, such as "user:password@example.com:8080"

$3

Returns the fragment component of the IRI.

$3

Returns the hier-part of the IRI, the hierarchial component: Everything between the scheme and query, including leading // for the host, if it exists.

$3

Returns the host component of the URI, either a domain name or string-formatted IP address. Excludes port number and username/password.

$3

Returns the path component of the hier-part. Does not include the authority/host, query, or fragment.

$3

Returns the port component of the authority as a string, or null if there is no port.

$3

Returns the query component of the IRI including leading "?", or null if there is no query component.

$3

Resolve the provided URI/IRI reference against this IRI.

$3

Returns the scheme of the IRI, e.g. "https", "file", or "urn".

$3

Returns the username/password component of the IRI.

$3

Returns a URI formatted string with only 7-bit characters.

$3

Decodes URI-encoded UTF-8 characters and returns a unicode string (Strings in ECMAScript/JavaScript are UTF-16).

$3

Returns a new IRI object with URI-encoded UTF-8 characters decoded.

Function Usage

$3

Returns an iri.IRI object with UTF-8 escaped characterd decoded.

$3

Returns an IRI string decoded from the given URI.

Tests

Tests are available as a Vows test suite. Run vows in the package directory to execute.