在前端开发中,我们经常会使用各种开源的 npm 包来快速完成一些功能。而其中一个比较常用的包就是 author.php。它是一个用于获取网站作者信息的 npm 包,可以方便地让我们在网站上展示作者以及文章相关信息。
安装
我们可以通过 npm 命令安装该包,命令如下:
npm install author.php
使用
安装完成后,我们可以通过以下代码使用该包:
const author = require('author.php');
接下来,我们就可以使用该包提供的功能了。
API
author.get(authorPageUrl, options)
该方法用于获取指定作者的信息。需要传入作者的个人网站地址以及一些可选项参数,例如:
-- -------------------- ---- ------- ------------------------------------ - ------------- --------------- -------------- ---------------- ------------ -------------- --------------- ----------------- ------- ------------------------------ -------------- -- - -------------------- ---
其中,必填参数 authorPageUrl
表示作者的个人网站地址。
该方法返回的是一个 Promise,resolve 后返回一个对象,包含以下属性:
name
: 作者姓名email
: 作者邮箱bio
: 作者介绍avatarUrl
: 作者头像地址rssUrl
: 作者 RSS 订阅地址
options
nameSelector
:作者姓名所在的 DOM 元素选择器,默认为"#author-name"
。emailSelector
:作者邮箱所在的 DOM 元素选择器,默认为"#author-email"
。bioSelector
:作者介绍所在的 DOM 元素选择器,默认为"#author-bio"
。avatarSelector
:作者头像所在的 DOM 元素选择器,默认为"#author-avatar"
。rssUrl
:作者 RSS 订阅地址,默认为''
。
示例
假如我们要获取 张大妈的个人网站 上的作者信息,可以使用以下代码:
-- -------------------- ---- ------- ----- ------ - ---------------------- ----------------------------------------- - ------------- -------------- -------------- --------------------- ------------ -------------------- --------------- ---------- ----- -------------- -- - -------------------- ---
运行后,控制台输出结果如下:
{ name: '张大妈', email: 'hi@zhangdadama.com', bio: '码畜一枚。', avatarUrl: 'https://secure.gravatar.com/avatar/4e8ca4e1097c662162cca39920e1f8ae?s=96&d=mm&r=g', rssUrl: 'http://www.zhangdadama.com/feed/' }
总结
使用 author.php 这个 npm 包,可以方便地获取作者信息并在网站上展示。在实际应用中,还可以根据需求自己调整选择器,获取更为精准的信息。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066b5651ab1864dac66c12