npm 包 tldtools 使用教程

前言

tldtools 是一款用于解析和处理 URL 中的 Top Level Domain（顶级域名）的 npm 包。在前端开发中，经常需要从 URL 中提取出顶级域名，以便进行数据统计、广告跟踪等工作，因此该包在实际开发中非常实用。

本篇文章将介绍 tldtools 的使用方法，包括包的安装、导入、API 操作等。

安装

使用 npm 安装 tldtools：

npm install tldtools

导入

在代码文件中导入 tldtools：

const tldtools = require('tldtools')

API 操作

tldtools 提供了以下几个 API：

tldtools.getDomain(inputURL)

getDomain 用于获取 URL 对应的顶级域名。示例代码：

const domain = tldtools.getDomain('https://www.google.com/search?q=tldtools')
console.log(domain) // 输出: google.com

tldtools.getHostname(inputURL)

getHostname 用于获取 URL 的主机名。示例代码：

const hostname = tldtools.getHostname('https://www.google.com/search?q=tldtools')
console.log(hostname) // 输出: www.google.com

tldtools.getSubdomain(inputURL)

getSubdomain 用于获取 URL 的子域名（除顶级域名和二级域名之外的部分）。示例代码：

const subdomain = tldtools.getSubdomain('https://www.google.com/search?q=tldtools')
console.log(subdomain) // 输出: www

tldtools.getPublicSuffix(inputURL)

getPublicSuffix 用于获取 URL 对应的公共后缀，即顶级域名之后的部分（如 .com、.co.uk 等）。示例代码：

const public_suffix = tldtools.getPublicSuffix('https://www.google.com/search?q=tldtools')
console.log(public_suffix) // 输出: com

tldtools.isValid(inputURL)

isValid 用于验证 URL 是否合法。示例代码：

const valid = tldtools.isValid('https://www.google.com/search?q=tldtools')
console.log(valid) // 输出: true

总结

通过本篇文章的介绍，我们了解到了 tldtools 这个 npm 包的安装、导入以及常用 API 操作，相信读者可以通过该包更加便捷地处理 URL 中的顶级域名。同时，也需要注意该包只能解析符合规定格式的 URL，若存在特殊情况需要进行特殊处理。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedb648b5cbfe1ea06114f2