https://github.com/131/node-tld
Nodejs TLD extract
https://github.com/131/node-tld
Last synced: about 1 year ago
JSON representation
Nodejs TLD extract
- Host: GitHub
- URL: https://github.com/131/node-tld
- Owner: 131
- License: mit
- Created: 2016-04-01T12:32:15.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-07-17T21:10:19.000Z (almost 2 years ago)
- Last Synced: 2025-03-24T10:56:34.718Z (about 1 year ago)
- Language: JavaScript
- Size: 461 KB
- Stars: 44
- Watchers: 2
- Forks: 15
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/131/node-tld/actions/workflows/test.yml)
[](https://coveralls.io/github/131/node-tld?branch=master)
[](https://www.npmjs.com/package/tld-extract)
[](http://opensource.org/licenses/MIT)
[](https://www.npmjs.com/package/eslint-plugin-ivs)
# Motivation
Extract the TLD/domain/subdomain parts of an URL/hostname against [mozilla TLDs official listing](https://publicsuffix.org/).
# API
```
var parser = require('tld-extract');
console.log( parser("http://www.google.com") );
console.log( parser("http://google.co.uk") );
/**
* >> { tld: 'com', domain: 'google.com', sub: 'www' }
* >> { tld: 'co.uk', domain: 'google.co.uk', sub: '' }
*/
```
## Private TLDs
Private TLDs are supported, see [chromium source code for specs](https://chromium.googlesource.com/chromium/src/+/master/net/tools/tld_cleanup/tld_cleanup.cc)
```
console.log( parser("http://jeanlebon.cloudfront.net"));
/**
* >> { tld : 'net', domain : 'cloudfront.net', sub : 'jeanlebon' };
*/
console.log( parser("http://jeanlebon.cloudfront.net", {allowPrivateTLD : true}));
/**
* >> { tld : 'cloudfront.net', domain : 'jeanlebon.cloudfront.net', sub : '' };
*/
```
## Unknown TLDs (level0)
By default, unknown TLD throw an exception, you can allow them and use tld-extract as a parser using the `allowUnknownTLD` option
```
parse("http://nowhere.local")
>> throws /Invalid TLD/
parse("http://nowhere.local", {allowUnknownTLD : true}))
>> { tld : 'local', domain : 'nowhere.local', sub : '' }
```
## DotLess domain
Using a tld as a direct domain name, or [dotless domain](https://en.wikipedia.org/wiki/Top-level_domain#Dotless_domains) is highly not recommended (ICANN and IAB have spoken out against the practice, classifying it as a security risk among other concerns.[34] ICANN's Security and Stability Advisory Committee (SSAC) additionally claims that SMTP "requires at least two labels in the FQDN of a mail address" and, as such, mail servers would reject emails to addresses with dotless domains), and will throw an error in `tld-extract`. You can override this behavior using the `allowDotlessTLD` option.
```
parse("http://notaires.fr")
>> throws /Invalid TLD/
parse("http://notaires.fr", {allowDotlessTLD : true}))
>> { tld : 'notaires.fr', domain : 'notaires.fr', sub : '' }
```
# Why
* no dependencies
* really fast
* full code coverage
* easy to read (10 lines)
* easily updatable vs mozilla TLDs source list
* TypeScript support
# Maintenance
You can update the remote hash table using `npm run update`
# Not Invented Here
* A port of a [yks/PHP library](https://github.com/131/yks/blob/master/class/exts/http/urls.php)
* [tldextract](https://github.com/masylum/tldextract) => bad API, (no need for async, "domain" property is wrong), no need for dependencies
* [tld](https://github.com/donpark/node-tld/blob/master/lib/tld.js) => (nothing bad, a bit outdated )
* [tld.js](https://github.com/ramitos/tld.js) => no sane way to prove/trust/update TLD listing
# Credits
* [131](https://github.com/131)