sp-dev-fx-webparts/samples/react-async-await-sp-pnp-js/README.md

4.3 KiB

Using @pnp/js with Async / Await

Summary

This web part demonstrates how to use PnPJS with Async functions into the SharePoint Framework.

React-sp-pnp-js-async-await

Compatibility

⚠️ Important
Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.
Refer to https://aka.ms/spfx-matrix for more information on SPFx compatibility.

SPFx 1.4.1 Node.js v8 | v6 Compatible with SharePoint Online Incompatible with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Local Workbench Incompatible Hosted Workbench Compatible Compatible with Remote Containers

For more information about SPFx compatibility, please refer to https://aka.ms/spfx-matrix

Applies to

Solution

Solution Author(s)
react-async-await-sp-pnp-js Jose Quinto (@jquintozamora , blog.josequinto.com)
Version 2 refactored as purely a PnPjs sample by Julie Turner (@jfj1997)

Version history

Version Date Comments
2.0 Jan 13, 2022 Updated to SPFx 1.14 & PnPjs version 3 & removed logging sample.
1.2 Jul 20, 2018 Replaced deprecated sp-pnp-js with @pnp/js
1.1 Mar 6, 2018 Update to 1.4.1
1.0 May 1, 2017 Initial release

Minimal Path to Awesome

  1. clone this repo
  2. $ npm i
  3. Update online workbench url in the initialPage property of the config/serve.json file.
  4. $ gulp serve

This sample can also be opened with VS Code Remote Development. Visit https://aka.ms/spfx-devcontainer for further instructions.

Local Mode

A browser in local mode (localhost) will be opened. https://localhost:4321/temp/workbench.html

SharePoint Mode

If you want to try on a real environment, open: https://your-domain.sharepoint.com/_layouts/15/workbench.aspx

Usage

React-sp-pnp-js-async-await-code

Features

Disclaimer

THIS CODE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.