spacer
Skip to content

Home

SharePoint Patterns and Practices Logo

PnPjs is a collection of fluent libraries for consuming SharePoint, Graph, and Office 365 REST APIs in a type-safe way. You can use it within SharePoint Framework, Nodejs, or any JavaScript project. This an open source initiative and we encourage contributions and constructive feedback from the community.

Fluent API in action

Animation of the library in use, note intellisense help in building your queries

General Guidance

These articles provide general guidance for working with the libraries. If you are migrating from v1 please review the transition guide.

Packages

Patterns and Practices client side libraries (PnPjs) are comprised of the packages listed below. All of the packages are published as a set and depend on their peers within the @pnp scope.

The latest published version is npm version.

@pnp/
adaljsclient Provides an adaljs wrapper suitable for use with PnPjs
common Provides shared functionality across all pnp libraries
config-store Provides a way to manage configuration within your application
graph Provides a fluent api for working with Microsoft Graph
logging Light-weight, subscribable logging framework
msaljsclient Provides an msal wrapper suitable for use with PnPjs
nodejs Provides functionality enabling the @pnp libraries within nodejs
odata Provides shared odata functionality and base classes
sp Provides a fluent api for working with SharePoint REST
sp-addinhelpers Provides functionality for working within SharePoint add-ins

Authentication

We have a new section dedicated to helping you figure out the best way to handle authentication in your application, check it out!

Issues, Questions, Ideas

Please log an issue using our template as a guide. This will let us track your request and ensure we respond. We appreciate any constructive feedback, questions, ideas, or bug reports with our thanks for giving back to the project.

Changelog

Please review the CHANGELOG for release details on all library changes.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

"Sharing is Caring"

Please use http://aka.ms/sppnp for the latest updates around the whole SharePoint Patterns and Practices (PnP) program.

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.