在前端的开发中,开发人员经常需要打开一个外部 URL 或者本地文件,这时我们就会用到一个命令行工具 —— opn。不过,有了更加好用的 npm 包 better-opn,可以让开发者更加方便快捷地打开一个 URL 或者文件,而不需要在命令行敲入很长的 URL 或者文件路径。
如果你想在自己的项目中使用该 npm 包,下面的教程会给你一些帮助。
安装 better-opn
使用 better-opn,我们首先需要正确地安装该 npm 包。你可以使用以下命令:
npm install --save-dev better-opn
这行命令将会安装 better-opn 并保存到我们的项目开发依赖中。
使用 better-opn
better-opn 提供了简单且易用的 API:
const betterOpn = require('better-opn'); betterOpn('https://www.google.com');
代码很简单。require better-opn 后,我们可以通过该 npm 包提供的 betterOpn 方法来打开一个 URL 或者文件(当然也可以通过配置打开自己喜欢的应用)。
betterOpn 函数只要传入一个字符串参数,就可以自动打开字符串所指向的 URL 或者本地文件,如上面的例子中所打开的 Google。
以下的代码演示了如何打开一个本地的 PDF 文件:
const betterOpn = require('better-opn'); betterOpn('./book.pdf', {app: 'Preview'});
上述代码中,better-opn 将会在 Mac 系统上使用 Preview 应用程序打开名为 book.pdf 的文件。
参数与选项
better-opn 支持以下选项:
参数 | 说明 |
---|---|
url | 需要打开的 URL 或者文件路径 |
app | 用于打开 URL 或者文件的应用程序,默认为操作系统的默认浏览器或者文件查看器 |
appArgs | 用于传递给应用程序的参数,默认为空 |
wait | 是否等待应用程序结束后退出 better-opn,默认为 false |
总结
better-opn 是一个非常实用的 npm 包,可以使开发人员更方便快捷地打开一个 URL 或者文件,特别是在开发过程中需要快速调试和查看一些文件时。本文介绍了如何安装和使用 better-opn,同时也介绍了一些该 npm 包的参数和选项。希望这篇文章能够帮助你更好地使用 better-opn。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/5eedb4b6b5cbfe1ea061133a