tldts-icann 7.3.1 → 7.4.0

package/README.md

@@ -50,6 +50,7 @@ Alternatively, you can try it _directly in your browser_ here: https://npm.runki
 - `tldts.parse(url | hostname, options)`
 - `tldts.getHostname(url | hostname, options)`
 - `tldts.getDomain(url | hostname, options)`
+- `tldts.getFullDomain(url | hostname, options)`
 - `tldts.getPublicSuffix(url | hostname, options)`
 - `tldts.getSubdomain(url, | hostname, options)`
 - `tldts.getDomainWithoutSuffix(url | hostname, options)`
@@ -190,6 +191,27 @@ getDomain('fr.t.co'); // returns `t.co`
 getDomain('https://user:password@example.co.uk:8080/some/path?and&query#hash'); // returns `example.co.uk`
 ```
 
+### getFullDomain(url | hostname, options?)
+
+Returns the full domain — the subdomain together with the registrable domain (as
+returned by `getDomain(...)`), i.e. the whole hostname _including_ any subdomain —
+or `null` when the input has no registrable domain (IP address, single label,
+bare public suffix, …). The result is the normalized hostname (lower-cased,
+trailing dot stripped); it is not a DNS-absolute name (no trailing root dot) and
+no IDNA/punycode conversion is performed.
+
+```javascript
+const { getFullDomain } = require('tldts-icann');
+
+getFullDomain('google.com'); // returns `google.com`
+getFullDomain('fr.google.com'); // returns `fr.google.com`
+getFullDomain('foo.google.co.uk'); // returns `foo.google.co.uk`
+getFullDomain('t.co'); // returns `t.co`
+getFullDomain('fr.t.co'); // returns `fr.t.co`
+getFullDomain('1.2.3.4'); // returns null (no registrable domain)
+getFullDomain('localhost'); // returns null
+```
+
 ### getDomainWithoutSuffix(url | hostname, options?)
 
 Returns the domain (as returned by `getDomain(...)`) without the public suffix part.

package/dist/cjs/index.js

@@ -1134,6 +1134,14 @@ function getDomain(url, options) {
     /*@__INLINE__*/ resetResult(RESULT);
     return parseImpl(url, 3 /* FLAG.DOMAIN */, suffixLookup, options, RESULT).domain;
 }
+function getFullDomain(url, options) {
+    /*@__INLINE__*/ resetResult(RESULT);
+    const result = parseImpl(url, 3 /* FLAG.DOMAIN */, suffixLookup, options, RESULT);
+    // The hostname *is* the full domain (subdomain + domain) whenever a
+    // registrable domain exists; gate on `domain` so non-registrable inputs
+    // (IPs, suffix-less or invalid hostnames) return `null` like `getDomain`.
+    return result.domain === null ? null : result.hostname;
+}
 function getSubdomain(url, options) {
     /*@__INLINE__*/ resetResult(RESULT);
     return parseImpl(url, 4 /* FLAG.SUB_DOMAIN */, suffixLookup, options, RESULT)
@@ -1147,6 +1155,7 @@ function getDomainWithoutSuffix(url, options) {
 
 exports.getDomain = getDomain;
 exports.getDomainWithoutSuffix = getDomainWithoutSuffix;
+exports.getFullDomain = getFullDomain;
 exports.getHostname = getHostname;
 exports.getPublicSuffix = getPublicSuffix;
 exports.getSubdomain = getSubdomain;