npm包 wikipedia-js-media-npm 使用教程

阅读时长 5 分钟读完

前言

在开发前端应用程序时,我们经常需要使用外部数据源。在这些数据源中,维基百科通常是非常有用的资源。wikipedia-js-media-npm是一个为Node.js和浏览器提供维基百科搜索引擎的npm包。

本教程将会教会你如何使用wikipedia-js-media-npm包来进行维基百科搜索。这个教程将通过以下几个步骤来实现:

  1. 安装wikipedia-js-media-npm
  2. 初步调用
  3. 更深入的操作和定制

安装 wikipedia-js-media-npm

在你的项目中可以通过npm进行安装:

初步调用

在我们开始调用wikipedia-js-media-npm之前,让我们先确认一下你是否已经准备好了你的环境。

请确保你已经:

  1. 设置了Node.js环境
  2. 安装了npm包管理器

现在我们来看一下如何在我们的代码中引用wikipedia-js-media-npm并使用它:

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

在这个简单的示例中,我们首先引入了wikipedia-js-media-npm包。我们定义了一个options对象,它包含要搜索的字符串和返回格式(html)。然后我们调用wiki.searchArticle方法,它需要两个参数,一个是我们定义的options对象,另一个是回调函数。这个回调函数用于传递我们搜索到的数据。

更深入的操作和定制

我们已经成功地进行了一次搜索并打印了HTML格式的维基百科文章。但是,wikipedia-js-media-npm还有很多其他的定制选项,让我们来看一下更深入的操作。

在搜索结果中包含图片

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

在这个示例中,我们设置新的options对象,我们添加了一个image选项,这个选项用来在我们的搜索结果中包含图片。我们也把summaryOnly选项设置为true,这样我们只会得到每篇文章的摘要。在回调函数中,我们打印了我们得到的HTML文本。

返回维基百科中的JSON

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

在这个示例中,我们把format选项设置为json,因此返回的文章数据将是JSON格式的。

自定义转换

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

在这个示例中,我们定义了一个名为 transformHTML 的函数,这个函数被用来自定义转换我们得到的HTML内容。我们在回调函数中调用这个函数,并打印我们转换后得到的文本。

总结

在本教程中,我们已经学习了如何使用wikipedia-js-media-npm npm包进行维基百科搜索,在更深入的操作中,我们自定义了转换函数来对我们的结果进行处理,以及使用不同选项来自定义搜索结果。

通过学习使用wikipedia-js-media-npm,我们现在可以轻松地在我们的应用程序中使用维基百科作为外部数据源。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600572f481e8991b448e9185

纠错
反馈