npm 包 @types/tldjs 使用教程-JavaScript中文网-JavaScript教程资源分享门户

简介

在 Web 开发中，处理域名及其 Top Level Domain（TLD）是很常见的操作。但是，处理 TLD 的过程中可能会遇到复杂的情况，比如 Unicode TLD、非 ASCII TLD 等。为了让开发变得简单和高效，有些开发者使用了 npm 包 @types/tldjs。该包提供了一个解析和操作 TLD 的工具函数集合。本文将向您介绍如何使用 @types/tldjs 包。

安装

首先，您需要确保您已经安装了 npm。通过以下指令可以安装 @types/tldjs 包：

npm install --save-dev @types/tldjs

使用

安装完成后，就可以在代码中使用 @types/tldjs 包了。

import * as tld from 'tldjs';

const parsedDomain = tld.parse('www.example.co.uk');
console.log(parsedDomain.tld); // co.uk
console.log(parsedDomain.domain); // example.co.uk

在上面的代码中，我们使用了 @types/tldjs 包中的 parse() 方法来解析指定的 URL。解析后，可以通过 tld 和 domain 属性分别获取 TLD 和域名。

提供的方法和属性

@types/tldjs 包提供了多个方法和属性，让您能够轻松地解析和操作 TLD。

parse(url: string): ParsedResult

解析 URL，并返回一个包含 TLD 和域名的解析结果对象。其中，ParsedResult 的接口定义如下：

-- -------------------- ---- -------
--------- ------------ -
  ------ --------
  ---- ------ - -----
  --------- ------ - -----
  ------- ------ - -----
  ---------- ------ - -----
  ------- --------
  ------- -------
  ---- --------
-展开代码

getDomain(url: string): string|null

从 URL 中获取域名。如果获取失败，返回 null。

getSubdomain(url: string): string|null

从 URL 中获取子域名（如果有）。如果获取失败，返回 null。

getPublicSuffix(url: string): string|null

从 URL 中获取公共 Suffix。如果获取失败，返回 null。

getTLD(url: string, allowPrivateTLD?: boolean): string|null

如果设置了 allowPrivateTLD 参数为 true，从 URL 中获取 TLD 值。否则，返回 null。

extractHostname(url: string): string|null

从 URL 中提取出主机名。如果获取失败，返回 null。

isValidHostname(hostname: string): boolean

检查提供的主机名是否有效。

isValid(url: string, options?: TLDJSOptions): boolean

检查 URL 是否有效。其中，TLDJSOptions 的接口定义如下：

interface TLDJSOptions {
  allowPrivateTLD?: boolean;
  allowUnknownTLD?: boolean;
  allowMultiSubTLD?: boolean;
  // ...
}

总结

@types/tldjs 包是一个方便的 TLD 处理工具，可以帮助开发者轻松地解析和操作域名及其 Top Level Domain。通过上面的使用教程，您现在应该知道如何使用 @types/tldjs 包了。如果您在使用过程中遇到任何问题，请查阅文档并查看 GitHub 上的仓库。就让我们的 Web 开发更加简单、快速和高效吧！

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

npm 包 @types/tldjs 使用教程

简介

安装

使用