npm 包 kentico-cloud-delivery-typescript-sdk 使用教程

AI 编程助手,豆包旗下的编程助手,提供智能补全、智能预测、智能问答等能力,节省开发时间,释放脑海中的创造力,支持 VSCode,点击体验 AI

在现代 Web 开发中,前端技术的重要性越来越受到重视。如果你使用过 Kentico Cloud 平台来管理您网站的内容,kentico-cloud-delivery-typescript-sdk 是一个非常有用的 npm 包,可以帮助您简化开发过程,提高开发效率。

什么是 kentico-cloud-delivery-typescript-sdk?

kentico-cloud-delivery-typescript-sdk 是一个为 Kentico Cloud 开发的 JavaScript 包,它使开发者可以使用 TypeScript 快速构建具有强类型的客户端代码。

该库提供了一组强类型框架,能够获取、查询、过滤和排序 Kentico Cloud 中的内容。

如何使用 kentico-cloud-delivery-typescript-sdk?

kentico-cloud-delivery-typescript-sdk 可以使用 npm 安装和管理,安装命令如下:

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

一旦安装成功,您就可以在您的项目中引用它:

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


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

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

projectId 参数是必需的,这是您 Kentico Cloud 项目的唯一标识符。 typeResolvers 参数指定了哪些类型将映射到哪个 TypeScript 类型。

然后,您可以使用 deliveryClient 对象从 Kentico Cloud 中获取数据。

kentico-cloud-delivery-typescript-sdk 的主要特点

  • 提供了一个强类型 API,使用 TypeScript 构建。
  • 可以在客户端代码中使用 LINQ 类似的语法快速过滤和排序数据。
  • 可以注入自定义属性选择器,以从 Kentico Cloud 获取您感兴趣的属性。
  • 缓存常用部分以提高性能。

构建请求

您可以使用 deliveryClient.items() 函数来构建请求,该函数接受一个泛型类型参数,该参数指定将返回的结果映射到哪个 TypeScript 类型。

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

您还可以过滤查询结果,例如按类型、排序、过滤等。

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

在上例中,我们将仅检索类型为“文章”的内容项,限制结果为 10 条,按最近更新时间降序排序。

使用查询语法过滤/排序

kentico-cloud-delivery-typescript-sdk 提供了方便的查询语法,使您可以使用类似 LINQ 的语法进行过滤和排序。

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

上面的示例使用 filterEquals 方法过滤了 system.typeelements.title.value 属性,保留了 articleMy Article 的内容项。

您还可以使用其他方法进行更复杂的过滤和排序:

  • filterContains(): 字符串内容中的任意部分包含给定文本
  • filterGreaterThan(): 数字值大于给定值
  • filterGreaterThanOrEqual(): 数字值大于或等于给定值
  • filterIn(): 字段等于值列表中的任意一个值
  • filterLessThan(): 数字值小于给定值
  • filterLessThanOrEqual(): 数字值小于或等于给定值
  • filterNotEquals(): 字段不等于给定值
  • filterRange(): 数字值在给定区间内
  • orderByCodename(): 按给定代码名称的字段排序
  • orderBySystemAttribute(): 按给定系统属性排序(例如,last_modified 等)

缓存

kentico-cloud-delivery-typescript-sdk 具有内置的缓存优化,以减少对服务器的请求次数。它可以缓存响应,请求以获得所有内容项、特定页或指定筛选器后,再次使用相同参数的请求将返回缓存的结果。

您可以通过传递 usePreviewMode 缓存错误的响应,该参数指示使用预览模式,从而使它们不受缓存的影响。

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

总结

kentico-cloud-delivery-typescript-sdk 是一个强大的 npm 包, 可以帮助前端开发人员更快地搭建内容管理的网站。本文演示了该 npm 包的安装和使用,并提供了详细的示例代码,希望读者可以充分利用它,提高开发效率。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/60066efc4c49986ca68d89c5


猜你喜欢

  • npm 包 merp_node_test.js 使用教程

    前言 在前端开发中,我们常常需要使用各种工具和库来辅助我们的开发。npm 是一个非常重要的工具,为我们提供了丰富的第三方包和模块。在本篇文章中,我们将介绍一个 npm 包 merp_node_test...

    4 年前
  • npm 包 meo-controller 使用教程

    介绍 meo-controller 是一个简单易用的前端控制器,可以方便地管理页面中的 DOM 元素、事件绑定、数据操作等。在前端开发中,常常需要对页面进行一些复杂的操作,特别是在大型的单页面应用中,...

    4 年前
  • npm 包 meocloud 使用教程

    前言 如今,网上的各种资源越来越多,而我们在学习和开发的时候,往往需要选择性的下载这些资源。npm,Node.js 的包管理工具,绝对是前端开发必选的利器。而 meocloud 则是 npm 包管理工...

    4 年前
  • npm 包 metalsmith-gzip 使用教程

    简介 Metalsmith 是一个在 Node.js 中的静态网站生成器,它由一系列插件组成,可以简化网站的构建过程。而 metalsmith-gzip 是其中一个非常有用的插件,它可以帮助我们在构建...

    4 年前
  • npm 包 metalsmith-handlebars-within 使用教程

    简介 metalsmith-handlebars-within 是一个 npm 包,它是 metalsmith 和 handlebars 的结合体。它提供了一种简单且有效的方式来处理静态网站的生成。

    4 年前
  • npm 包 metalsmith-hbt-md 使用教程

    在进行前端开发时,我们经常需要使用到构建工具来编译代码并生成静态文件。而 metalsmith-hbt-md 是一个非常实用的 npm 包,它可以将 handlebars 和 markdown 结合起...

    4 年前
  • npm 包 metalsmith-headingsidentifier 使用教程

    在前端开发领域中,我们经常需要处理大量的文章和说明文档,而这些内容的管理和组织也成为了非常重要的一环。 为了更好地组织和管理这些文档,我们可以使用一个叫做 metalsmith-headingside...

    4 年前
  • npm包 metalsmith-highlight使用教程

    在开发Web应用程序的过程中,前端代码成为了最受关注的领域之一。然而,仅仅运用原生的代码撰写有时难以胜任所有的任务。这时候,npm包成为了我们的救星。而其中的metalsmith-highlight更...

    4 年前
  • npm 包 metalsmith-highline 使用教程

    如果你是一名前端开发者,想要通过在命令行中创建和编辑 HTML 文件来进行网站开发和维护,那么 metalsmith-highline 或许是你需要的 npm 包。

    4 年前
  • npm 包 metalsmith-hideshow 使用教程

    在前端开发中,我们经常需要将一份文档转换为一个网站。Metalsmith 是一个可以帮助我们实现这个目标的静态网站生成器。而 metalsmith-hideshow 这个 npm 包则可以方便地在页面...

    4 年前
  • npm 包 metalsmith-hierarchy 使用教程

    简介 metalsmith-hierarchy 是一个基于 metalsmith 构建的 npm 包,它提供了一种建立网页目录结构的方法。它在打包时通过文件名前缀的方式,将文件组织成层级结构。

    4 年前
  • npm 包 metalsmith-hogan 使用教程

    在前端开发中,我们常常需要使用模板来生成网页内容。而 metalsmith-hogan 就是一个 npm 包,它可以让我们方便地使用 Hogan 模板语言来生成静态网页。

    4 年前
  • npm 包 metalsmith-hover 使用教程

    简介 Metalsmith 简单易用的静态网站生成器,它基于插件机制,可以方便的用插件完成不同的任务。其中,metalsmith-hover 是一个非常实用的插件,它可以帮助你快速生成鼠标悬停提示信息...

    4 年前
  • npm 包 metalsmith-html-tidy 使用教程

    在前端开发中,我们经常需要处理 HTML 文件。如果一个 HTML 文件在生成后存在一些格式或语法上的问题,那么它将很难在浏览器中正确地解析和渲染,这将导致 HTML 页面出现错误、页面样式错乱等问题...

    4 年前
  • npm 包 messages-list-component 使用教程

    在前端开发中,我们经常需要构建复杂的用户界面,其中包括展示消息列表的组件。而 npm 上的 messages-list-component 就是一个很好用的消息列表展示组件。

    4 年前
  • npm 包 menus-generator 使用教程

    在前端开发中,我们常常需要使用到菜单栏。如果每次都手写 CSS 样式或者 HTML 结构,那么将是一件非常繁琐的事情。而 menus-generator 这个 npm 包则可以帮助我们快速生成美观的菜...

    4 年前
  • npm 包 menuspy 使用教程

    概述 menuspy 是一个基于原生 JavaScript 的轻量级的导航菜单高亮展示库。它可以在网站滚动时,根据用户所在的当前位置自动高亮该页面上的哪个导航菜单项。

    4 年前
  • npm 包 meow-routeify 使用教程

    在现代 Web 开发中,前端的工作越来越重要,而 npm 成为了前端开发中不可替代的一部分。在 npm 包中,meow-routeify 是一款非常实用的工具,可以管理前端路由,帮助开发人员更便捷地构...

    4 年前
  • npm 包 meow-ui 使用教程

    在前端开发过程中,我们可能会需要使用一些开源的第三方库或框架来简化或加速我们的工作。而 npm 包 meow-ui 就是一个非常好用的库。它提供了一系列的 UI 组件,包括按钮、菜单、表单、标签等等,...

    4 年前
  • npm 包 meow.js 使用教程

    meow.js 是一个 Node.js 模块,它提供了一个简单的方法来解析命令行参数。如果你正在开发一个 Node.js 命令行应用程序,meow.js 可以帮助你轻松地获取命令行参数,从而让你的代码...

    4 年前

相关推荐

    暂无文章