Extract the TLD from a URL against the [public suffix list](https://publicsuffix.org/).
Extract the TLD from a URL against the public suffix list.
Install the package using your preferred package manager:
``sh`
npm install extract-tld
You can now use the parser:
`ts
import { parseUrl } from 'extract-tld';
parseUrl('https://google.com');
// { domain: 'google.com', sub: 'https://www', tld: 'com' }
`
`ts
import { parseUrl } from 'extract-tld';
parseUrl('test.compute.amazonaws.com', { allowPrivateTLD: true });
// { domain: 'test.compute.amazonaws.com', sub: '', tld: 'compute.amazonaws.com' }
`
You can allow unknown TLDs by specifying the configuration option:
`ts
import { parseUrl } from 'extract-tld';
parseUrl('https://somewhere.local');
// Throws
parseUrl('https://somewhere.local', { allowUnknownTLD: true });
// { domain: 'http://somewhere.local', sub: '', tld: 'local' }
`
Ensure you have pnpm installed
- Clone this repository
- Run pnpm install
All contributions are welcome - feel free to open a PR or issue :)
There is a script that will fetch the latest public suffix list and transform it into a format usable by this library. You can run the script by running pnmpm updateList`.
Ideally, this script would run once a day and update tlds.json accordingly, but the work for that hasn't been done yet.
- tld-extract
- This is the main basis of inspiration for this library. I've basically taken this library and modernised it (and added some nice things like TypeScript support) as the author seems to be unreachable.