npm 包 sequelize-sluggify 使用教程

阅读时长 5 分钟读完

什么是 sequelize-sluggify

sequelize-sluggify 是通过 Node.js 中的 Sequelize 操作数据库,生成独特 URL 的 npm 包。

它可以把数据库中的标题,自动转化为独特而有意义的 URL。这让你的网站更加易于阅读,并提高了 SEO 排名。

安装

如何使用

首先,让我们来看看 sequelize-sluggify 的 options 和 defaults。

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

-------------- - -------- - --- -- -
  ----- -
    ------ - ----------------
    ---- - --------------
    ------ - ----------------
    --------- - -------------------
    -------- - ------------------
    --------- - -------------------
    ----------- - ---------------------
    ----------- - ---------------------
  - - --------
--
  • source:必填项,将自动创建 slug 的属性。
  • slug:可选项,默认值 'slug',将创建的 slug 存储到数据库中的属性。
  • unique:可选项,默认值 true,如果为 true,将在 slug 字段上添加唯一索引。
  • maxLength:可选项,默认值 255,slug 属性的最大长度。
  • readOnly:可选项,默认值 false,如果为 true,slug 属性将保持 readOnly
  • overwrite:可选项,默认值 true,如果为 true,将在每次保存操作中重新生成 slug。如果为 false,则不会更改创建的 slug。
  • passThrough:可选项,默认值 false,如果为 true,则源字段将被保留并添加到 slug 中。
  • slugOptions:可选项,可用于定制 slug 的选项,例如 {lower: true} 将在创建 slug 时强制使用小写字母。

让我们在 Sequelize 模型上使用 sequelize-sluggify。

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

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

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

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

在上面的例子中,我们定义了一个名为 Blog 的模型,包含了三个属性 titleauthorslug。我们将 titleauthor 设置为 source,这意味着这两个属性中的文本将被合并为一个 slug,并存储到 slug 字段中。overwrite 属性被设置为 false,这意味着当保存模型时,如果 slug 已经存在,则不会更改它。

如果你要创建一个新的 slug,你需要将 overwrite 属性设置为 truereadOnly 属性设置为 false。这将生成一个新的 slug 并将其保存到 slug 字段中。

使用示例

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

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

如你所见,在创建一个新的 Blog 时,我们不需要手动创建一个独特的 slug,它将自动创建。

总结

sequelize-sluggify 让生成独特 URL 变得简单,它非常易于使用,只需使用 Sequelize 模型即可实现。它还提供了许多选项,如 uniquereadOnly 等,可以使你的代码更加灵活和易于处理各种场景。

当你需要为你的网站生成独特简短的 URL 时,你可以使用 sequelize-sluggify。

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

纠错
反馈