npm 包 mongoose-type-url 使用教程

在 Web 开发过程中，经常需要将表单中输入的网址进行存储。但是，如果直接使用字符串数据类型存储可能会存在不合规的情况，例如用户没有添加 http 或 https 前缀等。因此，我们需要一种方法来验证输入网址是否符合规范并进行存储。而这种方法就是使用 npm 包 mongoose-type-url。

什么是 mongoose-type-url 包？

mongoose-type-url 是一个 Node.js 的 npm 包，它提供了一种可在 Mongoose 模式上使用的 URL 数据类型。它可以确保要存储到数据库中的 URL 格式正确，并且可以方便地进行验证和转换。该包使用正则表达式校验 URL 是否合规。

如何使用 mongoose-type-url 包？

在项目中安装 mongoose-type-url 包：

npm install --save mongoose-type-url

在 Mongoose 模型中使用 mongoose-type-url 来定义 URL 类型属性：

-- -------------------- ---- -------
----- -------- - --------------------
----- ------- - -----------------------------

----- ------------- - --- -----------------
  ----- -------
  ---- -
    ----- --------
    --------- ----
  --
---

----- ------- - ------------------------- ---------------

这样我们就成功地在 Website 模型中定义了一个 URL 类型的属性 url。url 属性在添加到数据库之前会自动验证 URL 格式是否正确。如果格式不正确，它将触发错误并阻止数据存储。

mongoose-type-url 包还提供其它功能吗？

是的，mongoose-type-url 包还为 URL 类型属性提供了一些有用的方法：

• urlType.validate(value)：验证值是否为有效的 URL
• urlType.format(value)：将 URL 格式化成带有协议的格式，例如 http://example.com
• urlType.parse(value)：将 URL 解析成一个对象，其中包含协议、主机、路径等信息

在上述示例代码中，我们只验证了 URL 是否有效。如果你需要将 URL 格式化成带有协议的格式，可以使用以下代码：

const formattedUrl = urlType.format('example.com');
console.log(formattedUrl);
// output: http://example.com

如果你需要解析 URL 并获取其中的信息，可以使用以下代码：

const parsedUrl = urlType.parse('http://example.com/path/to/file.html?q1=val1&q2=val2');
console.log(parsedUrl);
// output: {protocol: 'http:', host: 'example.com', pathname: '/path/to/file.html', query: { q1: 'val1', q2: 'val2' }, hash: ''}

结论

在 Web 开发中，存储 URL 数据类型是常见的需求。直接使用字符串存储 URL 可能会出现一些问题，例如格式不规范等。使用 mongoose-type-url 包，可以方便地将 URL 类型添加到 Mongoose 模型中，并对其进行验证和转换。我相信在你的下一个 Web 项目中添加 URL 类型时， mongoose-type-url 包一定能够帮到你。

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