npm 包 facebook-re-scrape 使用教程-JavaScript中文网-JavaScript教程资源分享门户

对于前端开发者而言，优化 Facebook 页面的预览效果可能并不是一个常见的问题，但是在某些情况下，它对于您的页面的推广和曝光可以起到重要作用。而 npm 包 facebook-re-scrape 可以帮助您解决这个问题，它允许您手动触发 Facebook 内部爬虫再次解析您的页面，以刷新缓存、更新页面预览效果等。

本文将为大家详细介绍 facebook-re-scrape 包的使用方法，包括：

安装
API 介绍
使用示例
注意事项

1. 安装

您可以通过 npm 安装 facebook-re-scrape 包：

npm install facebook-re-scrape

如果您使用 yarn，可以运行以下命令：

yarn add facebook-re-scrape

2. API 介绍

facebook-re-scrape 包提供了以下 API：

reScrape(url: string, options: OptionsOrCallback, callback?: Callback): Promise<ScrapeResult>;
reScrapeBatch(urls: string[], options: OptionsOrCallback, callback?: Callback): Promise<ScrapeResult[]>;
ScrapeResult 类型

具体介绍如下：

2.1 `reScrape(url: string, options: OptionsOrCallback, callback?: Callback): Promise<ScrapeResult>;`

该函数接受以下参数：

url：要刷新的 URL。
options：可选项对象，其中支持如下配置项：
- appId：您的 Facebook 应用 ID。如果您在 HTML 中已经使用了 Open Graph 标签指定了 fb:app_id，则会自动从中获取 appId，此时您可以跳过此参数。
- pageId：您的 Facebook 页面 ID。如果您要刷新的是某个 Facebook 页面上的链接，建议指定此参数。
- accessToken：您的 Facebook Access Token。如果需要对非公开页面进行刷新操作，您需要为 accessToken 参数提供有效的 Token。注意不要将 Token 泄露给他人。
callback：可选的回调函数，在操作完成后调用。如果留空，该方法会返回一个 Promise 对象。

该函数会返回一个 Promise 对象，调用成功后会返回一个类型为 ScrapeResult 的对象。

2.2 `reScrapeBatch(urls: string[], options: OptionsOrCallback, callback?: Callback): Promise<ScrapeResult[]>;`

该函数与 reScrape 函数不同之处在于，该函数允许您同时刷新多个 URL，并返回一个 Promise 数组。调用时，需要传入以下参数：

urls：要批量刷新的 URL 列表。
options、callback 的含义同 reScrape。

该函数会返回一个 Promise 数组，数组中的每一个元素都是一个类型为 ScrapeResult 的对象。

2.3 `ScrapeResult` 类型

ScrapeResult 代表了每一次刷新操作的结果，其中包含以下属性：

url：刷新的 URL。
success：刷新操作是否成功。
error：如果刷新操作失败，会返回一个错误对象，否则为 null。
response：刷新操作的返回结果对象，它包含了 Facebook 爬虫解析到的信息。

3. 使用示例

接下来，我们将介绍一些具体的使用示例。

3.1 刷新单个页面

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

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

3.2 批量刷新页面

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

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

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

3.3 带有可选项的刷新

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

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

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

4. 注意事项

在使用 facebook-re-scrape 包时，请注意以下事项：

尽量不要轻易暴露您的 Facebook Access Token，以免被他人滥用。
您无法强制让 Facebook 立即更新您的页面预览效果。刷新操作最多在一周后更新，因此请确保您在发布前已经完成了内容、标签等方面的最终调整。
如果您要刷新的 URL 较多，不建议一次性进行大量刷新操作，这样可能会对 Facebook 爬虫造成过大的压力。建议将批量操作分为几个子集进行。
当您的页面被频繁刷新或出现异常行为时，Facebook 有权禁止您的 Access Token 的使用。因此，请您在使用 facebook-re-scrape 包前，务必遵守 Facebook 的开发者规范，并谨慎操作。

总之，使用 facebook-re-scrape 包可以让您更加高效地进行 Facebook 页面的预览效果优化，帮助您更好地推广和宣传您的网站和产品，但也需要您在使用时注意相关事项和规范。

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

npm 包 facebook-re-scrape 使用教程