The Patterns and Practices JavaScript Core Library was created to help developers by simplifying common operations within SharePoint and the SharePoint Framework. Currently it contains a fluent API for working with the full SharePoint REST API as well as utility and helper functions. This takes the guess work out of creating REST requests, letting developers focus on the what and less on the how.

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

NPM

Add the npm package to your project

npm install sp-pnp-js --save

Bower

Add the package from bower

bower install sp-pnp-js

Please see the wiki for detailed guides on getting started both using and contributing to the library. The Developer Guide is a great place to get started.

Explore the API documentation.

These pages are generated from the source comments as part of each release. We are always looking for help making these resources better. To make updates, edit the comments in the source and submit a PR against the dev branch. We will merge it there and refresh the pages as part of each release. Updates made directly to the gh-pages branch will be overwritten.

Checkout a SharePoint hosted Add-In containing samples on using the library from both a SharePoint hosted add-in as well as a script editor web part. This will allow you to execute the samples as well as intract with the API.

We have an active Gitter community dedicated to this library, please join the conversation to ask questions. If you find an issue with the library, please report it.

This project's contributors include Microsoft and community contributors. Work is done as as open source community project.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

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.