gossamer/url

WHATWG URL parsing.

gleam/uri.parse parses per RFC 3986: it accepts relative references (/path, foo) and normalizes nothing beyond lowercasing the scheme. gossamer/url exposes the WHATWG URL parser, which requires an absolute URL (or a relative one given a base) and returns it in canonical form: the host lowercased, default ports dropped, . and .. path segments resolved, components percent-encoded, and internationalized hostnames converted to punycode. Results are returned as gleam/uri.Uri.

Reach for gleam/uri to parse an input faithfully; reach for gossamer/url for a validated, canonical URL, useful for comparison, deduplication, or use as a request endpoint.

Values

is_valid

</>

pub fn is_valid(
  url: String,
  relative_to base: option.Option(String),
) -> Bool

Returns True if url is a valid URL per the WHATWG URL spec. Pass Some(base) to check a relative url against a base. Equivalent to JavaScript’s URL.canParse.

parse

</>

pub fn parse(
  url: String,
  relative_to base: option.Option(String),
) -> Result(uri.Uri, Nil)

Parses url as an absolute URL per the WHATWG URL spec and returns it in canonical form. Pass Some(base) to resolve a relative url against a base URL. Returns an error if url is not a valid URL, or is relative with no base.

Examples

let assert Ok(uri) =
  url.parse("HTTPS://Example.COM/a/../b", relative_to: None)
// uri is the canonical https://example.com/b