npm 包 find-emails-in-string 使用教程

在前端开发中，经常会有需要从一些字符串中提取出 email 地址的需求，比如用户注册时需要验证输入的 email 地址是否符合规范等。而 npm 包 find-emails-in-string 就是一款能够在字符串中快速查找 email 的工具，它可以轻松地提取出字符串中的所有 email 地址，并返回一个包含所有 email 地址的数组，提高了工作效率，下面就来详细介绍一下如何使用这个 npm 包。

安装

首先通过 npm 安装 find-emails-in-string 包：

npm install find-emails-in-string

使用

在安装完成后，我们可以通过 require() 将 find-emails-in-string 包引入到我们的项目中。它只有一个函数，可以直接调用。

const findEmails = require('find-emails-in-string')

该函数接受一个字符串作为参数，返回一个数组，其中包含了该字符串中所有有效的 email 地址。

let string = '我的邮箱是example@email.com'
let result = findEmails(string)
console.log(result) // ['example@email.com']

同时，find-emails-in-string 还支持传入多个字符串或一个字符串的数组。

let string1 = '我的邮箱是example@email.com'
let string2 = '我的邮箱是second@domain.com'
let result = findEmails(string1, string2)
console.log(result) // ['example@email.com', 'second@domain.com']

选项

find-emails-in-string 还有一些可选的选项，可以帮助我们更精准地提取出 email 地址。

包含无效 email 地址

默认情况下，find-emails-in-string 只会返回有效的 email 地址，如果希望它也能返回无效的 email 地址，我们可以在调用函数时传入一个可选的选项对象，将该选项设置为 true：

let string = '我的邮箱是example'
let result = findEmails(string, {includeInvalid: true})
console.log(result) // ['example', '']

包含邮件主题

有时，我们希望能够提取出 email 地址的同时，也能够提取出邮件的主题。这时我们可以将 includeTitle 选项设置为 true。

let string = '我的邮箱是example@email.com 内容：关于某事的邮件'
let result = findEmails(string, {includeTitle: true})
console.log(result) // [{
  title: '关于某事的邮件',
  email: 'example@email.com'
}]

总结

find-emails-in-string 是一个非常方便的 npm 包，可以快速提取出字符串中的 email 地址，提高工作效率。在使用时，我们可以根据实际需求来选择不同的选项，提取出我们需要的信息。通过本文的介绍，相信大家已经掌握了如何使用这个包。如果您还有其他问题或建议，欢迎在评论区留言。

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