SharePoint 是一个广泛使用的企业级协作平台,用于组织和存储企业数据。在前端开发中,我们经常需要从 SharePoint 列表中查询和获取数据。于是,npm 包 sp-list-query 应运而生。本文将介绍如何使用该 npm 包来轻松查询 SharePoint 列表数据。
简介
sp-list-query 是一个轻量级的 npm 包,可以帮助开发人员从 SharePoint 列表中查询数据。该包提供了基本的查询功能,如筛选、排序、跳过和限制。使用该包,可以在 Node.js 或浏览器中使用 Promise、async/await 等方法方便地查询 SharePoint 列表数据。
安装
要使用 sp-list-query,需要首先安装它。在命令行终端中输入以下命令,即可在项目中安装该 npm 包:
npm i sp-list-query
配置
在使用 sp-list-query 查询 SharePoint 列表数据之前,需要先配置设置。通过设置,可以提供所需列表的 URL、访问令牌、查询选项等信息。以下是示例配置:
-- -------------------- ---- ------- ------ - ----------- - ---- ---------------- ----- ------ - - -------- ------------------------------- --------- ----------------- ------------ -------------------- -- ----- ----------- - --- --------------------
其中,siteUrl
是 SharePoint 站点的 URL,listName
是要查询的列表名称,accessToken
是访问令牌,可以通过 SharePoint 从 Azure Active Directory 中注册应用程序生成。
查询
配置完成后,就可以使用 sp-list-query 进行查询了。以下是一个简单的查询示例,该示例将获取列表中所有项的 ID 和标题:
const options = { select: ['Id', 'Title'], }; spListQuery.getItems(options) .then((items) => console.log(items)) .catch((error) => console.error(error));
通过 getItems
方法可以获取列表中的项。在上述示例中,使用选项 options
来选择要包含在结果中的字段。该选项还可以设置任意的筛选条件、排序方式、跳过项和限制项的数目。例如,以下示例查询 ID 大于 1 的前两个项:
-- -------------------- ---- ------- ----- ------- - - ------- ------ --------- ------- --- -- --- -------- ----- ---- -- -- ----------------------------- ------------- -- ------------------- -------------- -- ----------------------
在查询结果中,每个项都是一个对象,该对象包含了所选字段的值。例如,使用选项 ['Id', 'Title']
查询结果:
-- -------------------- ---- ------- - - ----- -- -------- ----- -- -- - ----- -- -------- ----- -- -- --- -
总结
通过使用 sp-list-query,我们可以轻松地从 SharePoint 列表中获取数据。该 npm 包提供了基本的查询功能,如筛选、排序、跳过和限制,使开发人员可以方便地进行高效、灵活的数据查询。希望本文对您有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6006707e8ccae46eb111eed5