在前端领域中,经常会需要与 SharePoint 交互,获取 SharePoint 中的数据。而 @pnp/sp-commonjs 是一个非常实用的 npm 包,可以简化与 SharePoint 的交互操作,提高开发效率。
本文将详细介绍 @pnp/sp-commonjs 的使用方法,包括安装、初始化、操作等细节,并提供丰富的示例代码,帮助读者更好地理解和应用该 npm 包。
安装
使用 @pnp/sp-commonjs 来操作 SharePoint,首先需要在项目中安装该 npm 包。可以通过以下命令来安装它:
--- ------- ---------------- ------
初始化
在操作 SharePoint 之前,需要在项目中进行初始化。以下代码示例展示了如何使用 @pnp/sp-commonjs 进行初始化:
------ - -- - ---- ------------------- ------ ------------------------ ------ ------------------------- ---------- --- - -------- ----------------------------------------- -------- - ------- --------------------------------- -- -- ---
在上面的示例中,我们首先从 @pnp/sp-commonjs 中引入了 sp、webs 和 lists 模块。然后,我们使用 sp.setup
函数进行初始化,其中 baseUrl
参数填写了 SharePoint 网站的链接地址,headers
参数指定了要使用的请求头。
常用操作
完成 @pnp/sp-commonjs 的初始化后,就可以开始对 SharePoint 进行常用操作了。以下是几个常用的操作方法:
获取 SharePoint 列表
----- ---- - ----- ----------------------------- -------
通过 sp.web.lists.getByTitle
方法可以根据列表名获取 SharePoint 中的具体列表。
获取 SharePoint 列表项
----- ---- - ----- ----------------------------- ------------------------------
通过 sp.web.lists.getByTitle(...).items.getById(...).get()
方法可以根据 ID 获取包含详情的 SharePoint 列表项。
创建 SharePoint 列表项
----- ------- - ----- ----------------------------- ------------------ ------ ---- ------ ----- ----- -- - --- ------ ---
通过 sp.web.lists.getByTitle(...).items.add(...)
方法可以在 SharePoint 列表中创建新的列表项,并添加对应的数据。
更新 SharePoint 列表项
----- ----------- - ----- ------------ ----------------- ------ ----------------- --------- ------ -------- ------- ---
通过 sp.web.lists.getByTitle(...).items.getById(...).update(...)
方法可以根据 ID 更新 SharePoint 列表项的数据。
删除 SharePoint 列表项
----- ----------- - ----- ----------------------------- ---------------------------------
通过 sp.web.lists.getByTitle(...).items.getById(...).delete()
方法可以根据 ID 删除 SharePoint 列表项。
总结
本文介绍了如何使用 @pnp/sp-commonjs 进行 SharePoint 的操作,包括安装、初始化、获取列表、获取列表项、创建列表项、更新列表项和删除列表项。同时,我们提供了详细的示例代码,帮助读者更好地理解和应用该 npm 包。
通过使用 @pnp/sp-commonjs,可以使得前端开发者更加便捷地与 SharePoint 进行交互,提升开发效率。
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/5efb34fb403f2923b035baac