diff --git a/README.md b/README.md index 2097d2c..56faeb3 100644 --- a/README.md +++ b/README.md @@ -110,7 +110,7 @@ See [`bench/baseline.md`](bench/baseline.md) for performance numbers vs native ` ### Types
-ParsedURI +ParsedURI
@@ -138,7 +138,7 @@ Fields default to `null` when the corresponding URI part is missing. `port` is a
-URIComponents +URIComponents
@@ -159,7 +159,7 @@ interface URIComponents {
-CheckedURI +CheckedURI
@@ -176,7 +176,7 @@ interface CheckedURI extends ParsedURI { ### Punycode
-punycode(domain) +punycode(domain)
@@ -210,7 +210,7 @@ punycode('127.0.0.1'); // '127.0.0.1'
-punydecode(domain) +punydecode(domain)
@@ -244,7 +244,7 @@ punydecode('127.0.0.1'); // '127.0.0.1' ### Parsing
-parseURI(uri) +parseURI(uri)
@@ -294,7 +294,7 @@ parseURI('http://user:pass@[fe80::7:8%eth0]:8080');
-recomposeURI(components) +recomposeURI(components)
@@ -352,7 +352,7 @@ recomposeURI({ ### Reference resolution
-resolveURI(base, reference) +resolveURI(base, reference)
@@ -383,7 +383,7 @@ resolveURI('/not-absolute', 'g'); // '' — base is not absolute
-removeDotSegments(path) +removeDotSegments(path)
@@ -409,7 +409,7 @@ removeDotSegments('mid/content=5/../6'); // 'mid/6' ### Validators
-isDomainLabel(label) +isDomainLabel(label)
@@ -445,7 +445,7 @@ isDomainLabel('la--bel'); // false
-isDomain(name) +isDomain(name)
@@ -487,7 +487,7 @@ isDomain('xn--\'-6xd.com'); // false — valid Punycode for ॐ, but ॐ is
-isIP(ip) +isIP(ip)
@@ -513,7 +513,7 @@ isIP('3ffe:b00::1::a'); // false
-isIPv4(ip) +isIPv4(ip)
@@ -527,7 +527,7 @@ isIPv4('1:2::8'); // false
-isIPv6(ip) +isIPv6(ip)
@@ -543,7 +543,7 @@ isIPv6('212.58.241.131'); // false ### Checkers
-checkURI(uri) +checkURI(uri)
@@ -590,7 +590,7 @@ checkURI('http://www.bar.baz/foo%2'); // throws URIError — URI_
-checkHttpURL(uri) +checkHttpURL(uri)
@@ -612,7 +612,7 @@ checkHttpURL('http://user:pass@xn--fiq228c.com:8042/over/there?name=ferret#nose'
-checkHttpsURL(uri) +checkHttpsURL(uri)
@@ -621,7 +621,7 @@ Same as [`checkHttpURL`](#checkers) but `scheme` must be `https` or `HTTPS`.
-checkWebURL(uri) +checkWebURL(uri)
@@ -630,7 +630,7 @@ Same as [`checkHttpURL`](#checkers) but `scheme` can be `http` / `HTTP` or `http
-checkHttpSitemapURL(uri) +checkHttpSitemapURL(uri)
@@ -665,7 +665,7 @@ checkHttpSitemapURL('http://user:pass@xn--fiq228c.com:8042/over/there?name=ferre
-checkHttpsSitemapURL(uri) +checkHttpsSitemapURL(uri)
@@ -674,7 +674,7 @@ Same as [`checkHttpSitemapURL`](#checkers) but `scheme` must be `https`.
-checkSitemapURL(uri) +checkSitemapURL(uri)
@@ -685,7 +685,7 @@ Same as [`checkHttpSitemapURL`](#checkers) but `scheme` can be `http` or `https` ### Encoders
-encodeURIComponentString(component, options) +encodeURIComponentString(component, options)
@@ -723,7 +723,7 @@ encodeURIComponentString("A#/?@[]&'*", { type: 'fragment', sitemap: true });
-encodeURIString(uri, options) +encodeURIString(uri, options)
@@ -763,7 +763,7 @@ encodeURIString('foo://usër:pâss@bar.baz:8080/Ovër There?ù=B&b=c#Anchôr');
-encodeWebURL(uri, options) +encodeWebURL(uri, options)
@@ -790,7 +790,7 @@ encodeWebURL('http://usër:pâss@bar.baz:8080/Ovër There?ù=B&b=c#Anchôr');
-encodeSitemapURL(uri) +encodeSitemapURL(uri)
@@ -813,7 +813,7 @@ encodeSitemapURL("http://user:p'âss@bar.baz/it's *ver/there?a=b&b=c#anch*r"); ### Decoders
-decodeURIComponentString(component, options) +decodeURIComponentString(component, options)
@@ -841,7 +841,7 @@ decodeURIComponentString('SITE&maP', { sitemap: true, lowercase: true });
-decodeURIString(uri, options) +decodeURIString(uri, options)
@@ -880,7 +880,7 @@ decodeURIString('foo://us%C3%ABr:p%C3%A2ss@bar.baz:8080/Ov%C3%ABr%20There?%C3%B9
-decodeWebURL(uri, options) +decodeWebURL(uri, options)
@@ -902,7 +902,7 @@ decodeWebURL('HTTPS://WWW.xn--fiq228c.COM./Over/There?a=B&b=c#Anchor');
-decodeSitemapURL(uri, options) +decodeSitemapURL(uri, options)
@@ -936,7 +936,7 @@ Errors emitted by `@coroboros/uri` are native `URIError` instances with an addit The `code` field is a stable string discriminant safe for runtime branching.
-Error codes +Error codes