npm 包 url-metatags 使用教程-JavaScript中文网-JavaScript教程资源分享门户

介绍

url-metatags 是一个 NPM 包，可以获取指定 URL 的元数据信息，例如页面标题、描述、关键词等。这个包主要用于前端开发中处理 SEO 相关的数据。

安装

你可以使用 npm 或者 yarn 安装 url-metatags。

使用 npm:

npm install url-metatags

使用 yarn:

yarn add url-metatags

用法

在你的项目中，你可以像下面这样使用 url-metatags：

const urlMetatags = require('url-metatags');

urlMetatags('https://www.example.com').then((metaTags) => {
  console.log(metaTags);
});

这个例子中，我们使用 url-metatags 获取了 https://www.example.com 网站的元数据信息，并将结果输出到控制台。

参数

url-metatags 函数支持以下参数：

url: 要获取元数据的 URL，必填参数。
options: 可选参数，用于更精细的控制 url-metatags 的行为。

其中，options 对象支持以下属性：

timeout: 请求 URL 超时时间（以毫秒为单位），默认为 5000 毫秒。
headers: 需要添加到 HTTP 请求的头信息。
userAgent: HTTP 请求的 user-agent 字符串。如果未提供，url-metatags 将使用默认 user-agent。
skipUrlEncoding: 是否跳过 URL 编码，默认为 false。

返回值

调用 url-metatags 函数后，它会返回一个 Promise，包含如下元数据信息：

title: 页面的标题。
description: 页面的描述。
lang: 页面的语言代码。
author: 页面的作者。
siteName: 页面所在站点的名称。
keywords: 页面的关键字。
image: 一个包含页面主要图片 URL 和宽度高度信息的对象。
url: 页面的 URL。如果通过参数传递了非编码的 URL，则在此处返回编码后的 URL。

示例代码

下面是使用 url-metatags 的几个示例:

打印网站的标题

const urlMetatags = require('url-metatags');

urlMetatags('https://www.example.com').then((metaTags) => {
  console.log(metaTags.title);
});

获取网站的 favicon 图标 URL

const urlMetatags = require('url-metatags');

urlMetatags('https://www.example.com').then((metaTags) => {
  const faviconUrl = `https://www.example.com/${metaTags.favicon}`;
  console.log(faviconUrl);
});

忽略 URL 编码

const urlMetatags = require('url-metatags');

urlMetatags('https://www.example.com?query=test&name=alice', { skipUrlEncoding: true }).then((metaTags) => {
  console.log(metaTags.url);
});

结论

url-metatags 是一个非常方便实用的 NPM 包，可以极大地节省我们在处理网站元数据时的工作量，提高项目开发的效率。希望这篇文章对你有所帮助。

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