@zxncij2390/monorepo3 3.18.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (921) hide show
  1. package/.eslintignore +16 -0
  2. package/.eslintrc.cjs +150 -0
  3. package/.github/ISSUE_TEMPLATE/bug-report.yml +178 -0
  4. package/.github/ISSUE_TEMPLATE/enhancement.yml +99 -0
  5. package/.github/ISSUE_TEMPLATE/question.yml +72 -0
  6. package/.github/ISSUE_TEMPLATE.md +39 -0
  7. package/.github/PULL_REQUEST_TEMPLATE.md +24 -0
  8. package/.github/workflows/lock.yml +18 -0
  9. package/.github/workflows/publish-buildsystem.yml +34 -0
  10. package/.github/workflows/publish-docs.yml +21 -0
  11. package/.github/workflows/publish.yml +40 -0
  12. package/.github/workflows/pull_request.yaml +28 -0
  13. package/.github/workflows/push.yaml +32 -0
  14. package/.github/workflows/v3-nightly.yml +40 -0
  15. package/.mocharc.cjs +68 -0
  16. package/.vscode/launch.json +103 -0
  17. package/.vscode/settings.json +17 -0
  18. package/.vscode/tasks.json +124 -0
  19. package/AUTHORS +13 -0
  20. package/CHANGELOG.md +33 -0
  21. package/CODE_OF_CONDUCT.md +6 -0
  22. package/CONTRIBUTING.md +9 -0
  23. package/LICENSE +25 -0
  24. package/README.md +66 -0
  25. package/buildsystem-config.ts +146 -0
  26. package/debug/launch/graph.ts +20 -0
  27. package/debug/launch/main.ts +38 -0
  28. package/debug/launch/setup.ts +50 -0
  29. package/debug/launch/sp.ts +21 -0
  30. package/debug/launch/tsconfig.json +27 -0
  31. package/debug/serve/main.ts +47 -0
  32. package/debug/serve/plumbing/local-module-resolver-plugin.ts +68 -0
  33. package/debug/serve/plumbing/run.ts +24 -0
  34. package/debug/serve/plumbing/serve.ts +27 -0
  35. package/debug/serve/plumbing/webpack.config.ts +43 -0
  36. package/debug/serve/spa.html +12 -0
  37. package/debug/serve/tsconfig.json +15 -0
  38. package/debug/spfx/.eslintrc.js +352 -0
  39. package/debug/spfx/README.md +73 -0
  40. package/debug/spfx/package-lock.json +57299 -0
  41. package/debug/spfx/package.json +38 -0
  42. package/debug/spfx/pnpjs-local-debug-start.js +19 -0
  43. package/debug/spfx/teams/f4c0e5ff-c402-46b7-8073-8cc506808d06_color.png +0 -0
  44. package/debug/spfx/teams/f4c0e5ff-c402-46b7-8073-8cc506808d06_outline.png +0 -0
  45. package/docs/_theme/main.html +5 -0
  46. package/docs/azidjsclient/index.md +36 -0
  47. package/docs/concepts/adv-clientside-pages.md +169 -0
  48. package/docs/concepts/auth-browser.md +42 -0
  49. package/docs/concepts/auth-nodejs.md +101 -0
  50. package/docs/concepts/auth-spfx.md +76 -0
  51. package/docs/concepts/authentication.md +42 -0
  52. package/docs/concepts/batching-caching.md +77 -0
  53. package/docs/concepts/batching.md +257 -0
  54. package/docs/concepts/calling-other-endpoints.md +213 -0
  55. package/docs/concepts/custom-bundle.md +15 -0
  56. package/docs/concepts/error-handling.md +245 -0
  57. package/docs/concepts/invokable.md +7 -0
  58. package/docs/concepts/nightly-builds.md +19 -0
  59. package/docs/concepts/project-preset.md +123 -0
  60. package/docs/concepts/selective-imports.md +106 -0
  61. package/docs/concepts/typings.md +23 -0
  62. package/docs/contributing/debug-tests.md +76 -0
  63. package/docs/contributing/debugging.md +135 -0
  64. package/docs/contributing/documentation.md +34 -0
  65. package/docs/contributing/extending-the-library.md +223 -0
  66. package/docs/contributing/index.md +22 -0
  67. package/docs/contributing/local-debug-configuration.md +28 -0
  68. package/docs/contributing/npm-scripts.md +148 -0
  69. package/docs/contributing/pull-requests.md +27 -0
  70. package/docs/contributing/settings.md +98 -0
  71. package/docs/contributing/setup-dev-machine.md +36 -0
  72. package/docs/core/behavior-recipes.md +199 -0
  73. package/docs/core/behaviors.md +179 -0
  74. package/docs/core/moments.md +215 -0
  75. package/docs/core/observers.md +100 -0
  76. package/docs/core/storage.md +90 -0
  77. package/docs/core/timeline.md +190 -0
  78. package/docs/core/util.md +191 -0
  79. package/docs/css/extra.css +33 -0
  80. package/docs/getting-started.md +361 -0
  81. package/docs/graph/behaviors.md +267 -0
  82. package/docs/graph/bookings.md +180 -0
  83. package/docs/graph/calendars.md +270 -0
  84. package/docs/graph/cloud-communications.md +40 -0
  85. package/docs/graph/columns.md +125 -0
  86. package/docs/graph/contacts.md +298 -0
  87. package/docs/graph/content-types.md +193 -0
  88. package/docs/graph/directoryobjects.md +106 -0
  89. package/docs/graph/groups.md +164 -0
  90. package/docs/graph/insights.md +151 -0
  91. package/docs/graph/invitations.md +22 -0
  92. package/docs/graph/items.md +38 -0
  93. package/docs/graph/lists.md +87 -0
  94. package/docs/graph/messages.md +20 -0
  95. package/docs/graph/onedrive.md +614 -0
  96. package/docs/graph/outlook.md +82 -0
  97. package/docs/graph/photos.md +71 -0
  98. package/docs/graph/planner.md +249 -0
  99. package/docs/graph/search.md +25 -0
  100. package/docs/graph/shares.md +44 -0
  101. package/docs/graph/sites.md +47 -0
  102. package/docs/graph/subscriptions.md +79 -0
  103. package/docs/graph/teams.md +293 -0
  104. package/docs/graph/users.md +134 -0
  105. package/docs/img/ConsoleListenerColors.png +0 -0
  106. package/docs/img/Logo.png +0 -0
  107. package/docs/img/PnPJS_FluentAPI.gif +0 -0
  108. package/docs/img/SPFx-On-Premesis-2016-1.png +0 -0
  109. package/docs/img/TimelineArchitecture.jpg +0 -0
  110. package/docs/img/csp_copyccvalue.png +0 -0
  111. package/docs/img/csp_networktab.png +0 -0
  112. package/docs/img/office365-header-icon.png +0 -0
  113. package/docs/img/usage-2020-eoy.png +0 -0
  114. package/docs/img/usage-2021-eoy.png +0 -0
  115. package/docs/img/usage-2022-eoy.png +0 -0
  116. package/docs/index.md +56 -0
  117. package/docs/logging/index.md +262 -0
  118. package/docs/msaljsclient/index.md +33 -0
  119. package/docs/news/2020-year-in-review.md +162 -0
  120. package/docs/news/2021-year-in-review.md +148 -0
  121. package/docs/news/2022-year-in-review.md +122 -0
  122. package/docs/nodejs/behaviors.md +164 -0
  123. package/docs/nodejs/sp-extensions.md +99 -0
  124. package/docs/packages.md +53 -0
  125. package/docs/queryable/behaviors.md +496 -0
  126. package/docs/queryable/extensions.md +204 -0
  127. package/docs/queryable/queryable.md +385 -0
  128. package/docs/sp/alias-parameters.md +76 -0
  129. package/docs/sp/alm.md +139 -0
  130. package/docs/sp/attachments.md +157 -0
  131. package/docs/sp/behaviors.md +142 -0
  132. package/docs/sp/clientside-pages.md +1048 -0
  133. package/docs/sp/column-defaults.md +241 -0
  134. package/docs/sp/comments-likes.md +302 -0
  135. package/docs/sp/content-types.md +131 -0
  136. package/docs/sp/context-info.md +67 -0
  137. package/docs/sp/favorites.md +91 -0
  138. package/docs/sp/features.md +83 -0
  139. package/docs/sp/fields.md +668 -0
  140. package/docs/sp/files.md +559 -0
  141. package/docs/sp/folders.md +532 -0
  142. package/docs/sp/forms.md +22 -0
  143. package/docs/sp/groupSiteManager.md +40 -0
  144. package/docs/sp/hubsites.md +140 -0
  145. package/docs/sp/items.md +601 -0
  146. package/docs/sp/lists.md +572 -0
  147. package/docs/sp/navigation.md +171 -0
  148. package/docs/sp/permissions.md +82 -0
  149. package/docs/sp/profiles.md +407 -0
  150. package/docs/sp/publishing-sitepageservice.md +16 -0
  151. package/docs/sp/recycle-bin.md +72 -0
  152. package/docs/sp/regional-settings.md +108 -0
  153. package/docs/sp/related-items.md +136 -0
  154. package/docs/sp/search.md +207 -0
  155. package/docs/sp/security.md +196 -0
  156. package/docs/sp/sharing.md +273 -0
  157. package/docs/sp/site-designs.md +117 -0
  158. package/docs/sp/site-groups.md +144 -0
  159. package/docs/sp/site-scripts.md +123 -0
  160. package/docs/sp/site-users.md +211 -0
  161. package/docs/sp/sites.md +269 -0
  162. package/docs/sp/social.md +182 -0
  163. package/docs/sp/sp-utilities-utility.md +159 -0
  164. package/docs/sp/subscriptions.md +79 -0
  165. package/docs/sp/taxonomy.md +470 -0
  166. package/docs/sp/tenant-properties.md +55 -0
  167. package/docs/sp/user-custom-actions.md +95 -0
  168. package/docs/sp/views.md +226 -0
  169. package/docs/sp/webs.md +947 -0
  170. package/docs/sp-admin/index.md +139 -0
  171. package/docs/transition-guide.md +87 -0
  172. package/docs/v1/404.html +1611 -0
  173. package/docs/v1/assets/fonts/font-awesome.css +4 -0
  174. package/docs/v1/assets/fonts/material-icons.css +13 -0
  175. package/docs/v1/assets/fonts/specimen/FontAwesome.ttf +0 -0
  176. package/docs/v1/assets/fonts/specimen/FontAwesome.woff +0 -0
  177. package/docs/v1/assets/fonts/specimen/FontAwesome.woff2 +0 -0
  178. package/docs/v1/assets/fonts/specimen/MaterialIcons-Regular.ttf +0 -0
  179. package/docs/v1/assets/fonts/specimen/MaterialIcons-Regular.woff +0 -0
  180. package/docs/v1/assets/fonts/specimen/MaterialIcons-Regular.woff2 +0 -0
  181. package/docs/v1/assets/images/favicon.png +0 -0
  182. package/docs/v1/assets/images/icons/bitbucket.1b09e088.svg +20 -0
  183. package/docs/v1/assets/images/icons/github.f0b8504a.svg +18 -0
  184. package/docs/v1/assets/images/icons/gitlab.6dd19c00.svg +38 -0
  185. package/docs/v1/assets/javascripts/application.583bbe55.js +1 -0
  186. package/docs/v1/assets/javascripts/lunr/lunr.da.js +1 -0
  187. package/docs/v1/assets/javascripts/lunr/lunr.de.js +1 -0
  188. package/docs/v1/assets/javascripts/lunr/lunr.du.js +1 -0
  189. package/docs/v1/assets/javascripts/lunr/lunr.es.js +1 -0
  190. package/docs/v1/assets/javascripts/lunr/lunr.fi.js +1 -0
  191. package/docs/v1/assets/javascripts/lunr/lunr.fr.js +1 -0
  192. package/docs/v1/assets/javascripts/lunr/lunr.hu.js +1 -0
  193. package/docs/v1/assets/javascripts/lunr/lunr.it.js +1 -0
  194. package/docs/v1/assets/javascripts/lunr/lunr.jp.js +1 -0
  195. package/docs/v1/assets/javascripts/lunr/lunr.multi.js +1 -0
  196. package/docs/v1/assets/javascripts/lunr/lunr.no.js +1 -0
  197. package/docs/v1/assets/javascripts/lunr/lunr.pt.js +1 -0
  198. package/docs/v1/assets/javascripts/lunr/lunr.ro.js +1 -0
  199. package/docs/v1/assets/javascripts/lunr/lunr.ru.js +1 -0
  200. package/docs/v1/assets/javascripts/lunr/lunr.stemmer.support.js +1 -0
  201. package/docs/v1/assets/javascripts/lunr/lunr.sv.js +1 -0
  202. package/docs/v1/assets/javascripts/lunr/lunr.tr.js +1 -0
  203. package/docs/v1/assets/javascripts/lunr/tinyseg.js +1 -0
  204. package/docs/v1/assets/javascripts/modernizr.1aa3b519.js +1 -0
  205. package/docs/v1/assets/stylesheets/application-palette.22915126.css +1176 -0
  206. package/docs/v1/assets/stylesheets/application.451f80e5.css +2552 -0
  207. package/docs/v1/common/docs/adalclient/index.html +1994 -0
  208. package/docs/v1/common/docs/collections/index.html +1786 -0
  209. package/docs/v1/common/docs/custom-httpclientimpl/index.html +1798 -0
  210. package/docs/v1/common/docs/index.html +1787 -0
  211. package/docs/v1/common/docs/libconfig/index.html +1930 -0
  212. package/docs/v1/common/docs/netutil/index.html +1860 -0
  213. package/docs/v1/common/docs/storage/index.html +1850 -0
  214. package/docs/v1/common/docs/util/index.html +2058 -0
  215. package/docs/v1/config-store/docs/configuration/index.html +1730 -0
  216. package/docs/v1/config-store/docs/index.html +1761 -0
  217. package/docs/v1/config-store/docs/providers/index.html +1782 -0
  218. package/docs/v1/documentation/SPFx-On-Premesis-2016/index.html +1720 -0
  219. package/docs/v1/documentation/beta-versions/index.html +1742 -0
  220. package/docs/v1/documentation/css/extra.css +33 -0
  221. package/docs/v1/documentation/debugging/index.html +2098 -0
  222. package/docs/v1/documentation/deployment/index.html +1972 -0
  223. package/docs/v1/documentation/documentation/index.html +1760 -0
  224. package/docs/v1/documentation/getting-started/index.html +2280 -0
  225. package/docs/v1/documentation/getting-started-dev/index.html +1799 -0
  226. package/docs/v1/documentation/gulp-commands/index.html +2100 -0
  227. package/docs/v1/documentation/img/Logo.png +0 -0
  228. package/docs/v1/documentation/img/PnPJS_FluentAPI.gif +0 -0
  229. package/docs/v1/documentation/img/SPFx-On-Premesis-2016-1.png +0 -0
  230. package/docs/v1/documentation/img/office365-header-icon.png +0 -0
  231. package/docs/v1/documentation/img/pnpjs-common-uml.svg +220 -0
  232. package/docs/v1/documentation/img/pnpjs-config-store-uml.svg +56 -0
  233. package/docs/v1/documentation/img/pnpjs-graph-uml.svg +602 -0
  234. package/docs/v1/documentation/img/pnpjs-logging-uml.svg +59 -0
  235. package/docs/v1/documentation/img/pnpjs-nodejs-uml.svg +85 -0
  236. package/docs/v1/documentation/img/pnpjs-odata-uml.svg +253 -0
  237. package/docs/v1/documentation/img/pnpjs-sp-addinhelpers-uml.svg +48 -0
  238. package/docs/v1/documentation/img/pnpjs-sp-clientsvc-uml.svg +167 -0
  239. package/docs/v1/documentation/img/pnpjs-sp-taxonomy-uml.svg +458 -0
  240. package/docs/v1/documentation/img/pnpjs-sp-uml.svg +2833 -0
  241. package/docs/v1/documentation/package-structure/index.html +1875 -0
  242. package/docs/v1/documentation/packages/index.html +1741 -0
  243. package/docs/v1/documentation/polyfill/index.html +1877 -0
  244. package/docs/v1/documentation/theme/main.html +5 -0
  245. package/docs/v1/documentation/transition-guide/index.html +1977 -0
  246. package/docs/v1/graph/docs/contacts/index.html +2080 -0
  247. package/docs/v1/graph/docs/directoryobjects/index.html +1865 -0
  248. package/docs/v1/graph/docs/index.html +1858 -0
  249. package/docs/v1/graph/docs/insights/index.html +1698 -0
  250. package/docs/v1/graph/docs/invitations/index.html +1742 -0
  251. package/docs/v1/graph/docs/onedrive/index.html +2086 -0
  252. package/docs/v1/graph/docs/people/index.html +1664 -0
  253. package/docs/v1/graph/docs/planner/index.html +2097 -0
  254. package/docs/v1/graph/docs/security/index.html +1692 -0
  255. package/docs/v1/graph/docs/sites/index.html +2043 -0
  256. package/docs/v1/graph/docs/subscriptions/index.html +1835 -0
  257. package/docs/v1/graph/docs/teams/index.html +2097 -0
  258. package/docs/v1/index.html +1889 -0
  259. package/docs/v1/logging/docs/index.html +2045 -0
  260. package/docs/v1/nodejs/docs/adal-certificate-fetch-client/index.html +1676 -0
  261. package/docs/v1/nodejs/docs/adal-fetch-client/index.html +1713 -0
  262. package/docs/v1/nodejs/docs/bearer-token-fetch-client/index.html +1712 -0
  263. package/docs/v1/nodejs/docs/index.html +1764 -0
  264. package/docs/v1/nodejs/docs/provider-hosted-app/index.html +1725 -0
  265. package/docs/v1/nodejs/docs/proxy/index.html +1699 -0
  266. package/docs/v1/nodejs/docs/sp-fetch-client/index.html +1895 -0
  267. package/docs/v1/odata/docs/caching/index.html +1988 -0
  268. package/docs/v1/odata/docs/core/index.html +1829 -0
  269. package/docs/v1/odata/docs/index.html +1781 -0
  270. package/docs/v1/odata/docs/odata-batch/index.html +1755 -0
  271. package/docs/v1/odata/docs/parsers/index.html +1862 -0
  272. package/docs/v1/odata/docs/pipeline/index.html +1811 -0
  273. package/docs/v1/odata/docs/queryable/index.html +1967 -0
  274. package/docs/v1/pnpjs/docs/index.html +1814 -0
  275. package/docs/v1/search/search_index.json +1 -0
  276. package/docs/v1/sitemap.xml +428 -0
  277. package/docs/v1/sitemap.xml.gz +0 -0
  278. package/docs/v1/sp/docs/alias-parameters/index.html +1830 -0
  279. package/docs/v1/sp/docs/alm/index.html +1920 -0
  280. package/docs/v1/sp/docs/attachments/index.html +1998 -0
  281. package/docs/v1/sp/docs/client-side-pages/index.html +2031 -0
  282. package/docs/v1/sp/docs/comments-likes/index.html +1958 -0
  283. package/docs/v1/sp/docs/content-types/index.html +1758 -0
  284. package/docs/v1/sp/docs/entity-merging/index.html +1838 -0
  285. package/docs/v1/sp/docs/features/index.html +1824 -0
  286. package/docs/v1/sp/docs/fields/index.html +2031 -0
  287. package/docs/v1/sp/docs/files/index.html +2178 -0
  288. package/docs/v1/sp/docs/index.html +1894 -0
  289. package/docs/v1/sp/docs/items/index.html +2362 -0
  290. package/docs/v1/sp/docs/navigation-service/index.html +1791 -0
  291. package/docs/v1/sp/docs/permissions/index.html +1860 -0
  292. package/docs/v1/sp/docs/profiles/index.html +1794 -0
  293. package/docs/v1/sp/docs/related-items/index.html +1886 -0
  294. package/docs/v1/sp/docs/search/index.html +1830 -0
  295. package/docs/v1/sp/docs/sharing/index.html +2058 -0
  296. package/docs/v1/sp/docs/sitedesigns/index.html +1851 -0
  297. package/docs/v1/sp/docs/sites/index.html +2186 -0
  298. package/docs/v1/sp/docs/social/index.html +2011 -0
  299. package/docs/v1/sp/docs/sp-utilities-utility/index.html +2061 -0
  300. package/docs/v1/sp/docs/tenant-properties/index.html +1795 -0
  301. package/docs/v1/sp/docs/views/index.html +1869 -0
  302. package/docs/v1/sp/docs/webs/index.html +1972 -0
  303. package/docs/v1/sp-addinhelpers/docs/index.html +1771 -0
  304. package/docs/v1/sp-addinhelpers/docs/sp-request-executor-client/index.html +1760 -0
  305. package/docs/v1/sp-addinhelpers/docs/sp-rest-addin/index.html +1711 -0
  306. package/docs/v1/sp-clientsvc/docs/index.html +1736 -0
  307. package/docs/v1/sp-taxonomy/docs/index.html +1887 -0
  308. package/docs/v1/sp-taxonomy/docs/labels/index.html +1827 -0
  309. package/docs/v1/sp-taxonomy/docs/term-groups/index.html +1875 -0
  310. package/docs/v1/sp-taxonomy/docs/term-sets/index.html +1946 -0
  311. package/docs/v1/sp-taxonomy/docs/term-stores/index.html +2111 -0
  312. package/docs/v1/sp-taxonomy/docs/terms/index.html +2036 -0
  313. package/docs/v1/sp-taxonomy/docs/utilities/index.html +1783 -0
  314. package/docs/v2/404.html +2108 -0
  315. package/docs/v2/SPFx-on-premises/index.html +2278 -0
  316. package/docs/v2/_theme/main.html +5 -0
  317. package/docs/v2/adaljsclient/adalclient/index.html +15 -0
  318. package/docs/v2/adaljsclient/index.html +15 -0
  319. package/docs/v2/assets/images/favicon.png +0 -0
  320. package/docs/v2/assets/javascripts/bundle.9554a270.min.js +2 -0
  321. package/docs/v2/assets/javascripts/bundle.9554a270.min.js.map +1 -0
  322. package/docs/v2/assets/javascripts/lunr/min/lunr.ar.min.js +1 -0
  323. package/docs/v2/assets/javascripts/lunr/min/lunr.da.min.js +18 -0
  324. package/docs/v2/assets/javascripts/lunr/min/lunr.de.min.js +18 -0
  325. package/docs/v2/assets/javascripts/lunr/min/lunr.du.min.js +18 -0
  326. package/docs/v2/assets/javascripts/lunr/min/lunr.es.min.js +18 -0
  327. package/docs/v2/assets/javascripts/lunr/min/lunr.fi.min.js +18 -0
  328. package/docs/v2/assets/javascripts/lunr/min/lunr.fr.min.js +18 -0
  329. package/docs/v2/assets/javascripts/lunr/min/lunr.hu.min.js +18 -0
  330. package/docs/v2/assets/javascripts/lunr/min/lunr.it.min.js +18 -0
  331. package/docs/v2/assets/javascripts/lunr/min/lunr.ja.min.js +1 -0
  332. package/docs/v2/assets/javascripts/lunr/min/lunr.jp.min.js +1 -0
  333. package/docs/v2/assets/javascripts/lunr/min/lunr.multi.min.js +1 -0
  334. package/docs/v2/assets/javascripts/lunr/min/lunr.nl.min.js +18 -0
  335. package/docs/v2/assets/javascripts/lunr/min/lunr.no.min.js +18 -0
  336. package/docs/v2/assets/javascripts/lunr/min/lunr.pt.min.js +18 -0
  337. package/docs/v2/assets/javascripts/lunr/min/lunr.ro.min.js +18 -0
  338. package/docs/v2/assets/javascripts/lunr/min/lunr.ru.min.js +18 -0
  339. package/docs/v2/assets/javascripts/lunr/min/lunr.stemmer.support.min.js +1 -0
  340. package/docs/v2/assets/javascripts/lunr/min/lunr.sv.min.js +18 -0
  341. package/docs/v2/assets/javascripts/lunr/min/lunr.tr.min.js +18 -0
  342. package/docs/v2/assets/javascripts/lunr/min/lunr.vi.min.js +1 -0
  343. package/docs/v2/assets/javascripts/lunr/tinyseg.min.js +1 -0
  344. package/docs/v2/assets/javascripts/vendor.77e55a48.min.js +30 -0
  345. package/docs/v2/assets/javascripts/vendor.77e55a48.min.js.map +1 -0
  346. package/docs/v2/assets/javascripts/worker/search.4ac00218.min.js +59 -0
  347. package/docs/v2/assets/javascripts/worker/search.4ac00218.min.js.map +1 -0
  348. package/docs/v2/assets/stylesheets/main.38780c08.min.css +3 -0
  349. package/docs/v2/assets/stylesheets/main.38780c08.min.css.map +1 -0
  350. package/docs/v2/assets/stylesheets/palette.3f72e892.min.css +3 -0
  351. package/docs/v2/assets/stylesheets/palette.3f72e892.min.css.map +1 -0
  352. package/docs/v2/authentication/adaljsclient/index.html +2510 -0
  353. package/docs/v2/authentication/bearertokenclient/index.html +2251 -0
  354. package/docs/v2/authentication/client-spa/index.html +2206 -0
  355. package/docs/v2/authentication/client-spfx/index.html +2397 -0
  356. package/docs/v2/authentication/index.html +2307 -0
  357. package/docs/v2/authentication/lambdaclient/index.html +2304 -0
  358. package/docs/v2/authentication/msaljsclient/index.html +2413 -0
  359. package/docs/v2/authentication/server-nodejs/index.html +2404 -0
  360. package/docs/v2/authentication/sp-app-registration/index.html +2273 -0
  361. package/docs/v2/common/collections/index.html +2277 -0
  362. package/docs/v2/common/custom-httpclientimpl/index.html +2300 -0
  363. package/docs/v2/common/index.html +2262 -0
  364. package/docs/v2/common/libconfig/index.html +2413 -0
  365. package/docs/v2/common/netutil/index.html +2350 -0
  366. package/docs/v2/common/storage/index.html +2339 -0
  367. package/docs/v2/common/util/index.html +2638 -0
  368. package/docs/v2/concepts/configuration/index.html +2685 -0
  369. package/docs/v2/concepts/custom-bundle/index.html +2279 -0
  370. package/docs/v2/concepts/error-handling/index.html +2539 -0
  371. package/docs/v2/concepts/ie11-mode/index.html +2278 -0
  372. package/docs/v2/concepts/invokable/index.html +2254 -0
  373. package/docs/v2/concepts/polyfill/index.html +2401 -0
  374. package/docs/v2/concepts/selective-imports/index.html +2360 -0
  375. package/docs/v2/concepts/settings/index.html +2551 -0
  376. package/docs/v2/config-store/configuration/index.html +2226 -0
  377. package/docs/v2/config-store/index.html +2239 -0
  378. package/docs/v2/config-store/providers/index.html +2275 -0
  379. package/docs/v2/contributing/debug-tests/index.html +2323 -0
  380. package/docs/v2/contributing/debugging/index.html +2514 -0
  381. package/docs/v2/contributing/documentation/index.html +2291 -0
  382. package/docs/v2/contributing/extending-the-library/index.html +2521 -0
  383. package/docs/v2/contributing/index.html +2270 -0
  384. package/docs/v2/contributing/local-debug-configuration/index.html +2284 -0
  385. package/docs/v2/contributing/pull-requests/index.html +2261 -0
  386. package/docs/v2/contributing/setup-dev-machine/index.html +2284 -0
  387. package/docs/v2/css/extra.css +33 -0
  388. package/docs/v2/debug-tests/index.html +15 -0
  389. package/docs/v2/debugging/index.html +15 -0
  390. package/docs/v2/documentation/index.html +15 -0
  391. package/docs/v2/getting-started/index.html +2789 -0
  392. package/docs/v2/getting-started-dev/index.html +15 -0
  393. package/docs/v2/graph/calendars/index.html +2569 -0
  394. package/docs/v2/graph/contacts/index.html +2673 -0
  395. package/docs/v2/graph/directoryobjects/index.html +2402 -0
  396. package/docs/v2/graph/groups/index.html +2488 -0
  397. package/docs/v2/graph/index.html +2333 -0
  398. package/docs/v2/graph/insights/index.html +2478 -0
  399. package/docs/v2/graph/invitations/index.html +2273 -0
  400. package/docs/v2/graph/onedrive/index.html +2617 -0
  401. package/docs/v2/graph/outlook/index.html +2363 -0
  402. package/docs/v2/graph/photos/index.html +2351 -0
  403. package/docs/v2/graph/planner/index.html +2628 -0
  404. package/docs/v2/graph/search/index.html +2264 -0
  405. package/docs/v2/graph/subscriptions/index.html +2333 -0
  406. package/docs/v2/graph/teams/index.html +2619 -0
  407. package/docs/v2/graph/users/index.html +2461 -0
  408. package/docs/v2/img/ConsoleListenerColors.png +0 -0
  409. package/docs/v2/img/Logo.png +0 -0
  410. package/docs/v2/img/PnPJS_FluentAPI.gif +0 -0
  411. package/docs/v2/img/SPFx-On-Premesis-2016-1.png +0 -0
  412. package/docs/v2/img/office365-header-icon.png +0 -0
  413. package/docs/v2/img/usage-2020-eoy.png +0 -0
  414. package/docs/v2/index.html +2410 -0
  415. package/docs/v2/logging/index.html +2622 -0
  416. package/docs/v2/news/2020-year-in-review/index.html +2525 -0
  417. package/docs/v2/nodejs/adal-fetch-client/index.html +2204 -0
  418. package/docs/v2/nodejs/bearer-token-fetch-client/index.html +2203 -0
  419. package/docs/v2/nodejs/index.html +2261 -0
  420. package/docs/v2/nodejs/provider-hosted-app/index.html +2220 -0
  421. package/docs/v2/nodejs/proxy/index.html +2238 -0
  422. package/docs/v2/nodejs/sp-extensions/index.html +2362 -0
  423. package/docs/v2/nodejs/sp-fetch-client/index.html +2294 -0
  424. package/docs/v2/nodejs-support/index.html +2398 -0
  425. package/docs/v2/npm-scripts/index.html +2521 -0
  426. package/docs/v2/odata/caching/index.html +2465 -0
  427. package/docs/v2/odata/core/index.html +2322 -0
  428. package/docs/v2/odata/debug/index.html +2358 -0
  429. package/docs/v2/odata/extensions/index.html +2581 -0
  430. package/docs/v2/odata/index.html +2259 -0
  431. package/docs/v2/odata/odata-batch/index.html +2250 -0
  432. package/docs/v2/odata/parsers/index.html +2355 -0
  433. package/docs/v2/odata/pipeline/index.html +2297 -0
  434. package/docs/v2/odata/queryable/index.html +2455 -0
  435. package/docs/v2/packages/index.html +2251 -0
  436. package/docs/v2/pnpjs/index.html +2281 -0
  437. package/docs/v2/search/search_index.json +1 -0
  438. package/docs/v2/sitemap.xml +483 -0
  439. package/docs/v2/sitemap.xml.gz +0 -0
  440. package/docs/v2/sp/alias-parameters/index.html +2330 -0
  441. package/docs/v2/sp/alm/index.html +2433 -0
  442. package/docs/v2/sp/attachments/index.html +2504 -0
  443. package/docs/v2/sp/clientside-pages/index.html +3477 -0
  444. package/docs/v2/sp/column-defaults/index.html +2540 -0
  445. package/docs/v2/sp/comments-likes/index.html +2646 -0
  446. package/docs/v2/sp/content-types/index.html +2462 -0
  447. package/docs/v2/sp/custom-irequestclient/index.html +2339 -0
  448. package/docs/v2/sp/entity-merging/index.html +2325 -0
  449. package/docs/v2/sp/features/index.html +2440 -0
  450. package/docs/v2/sp/fields/index.html +3103 -0
  451. package/docs/v2/sp/files/index.html +2949 -0
  452. package/docs/v2/sp/folders/index.html +2968 -0
  453. package/docs/v2/sp/forms/index.html +2289 -0
  454. package/docs/v2/sp/hubsites/index.html +2485 -0
  455. package/docs/v2/sp/index.html +2328 -0
  456. package/docs/v2/sp/items/index.html +2974 -0
  457. package/docs/v2/sp/lists/index.html +3387 -0
  458. package/docs/v2/sp/navigation/index.html +2535 -0
  459. package/docs/v2/sp/permissions/index.html +2338 -0
  460. package/docs/v2/sp/profiles/index.html +2806 -0
  461. package/docs/v2/sp/regional-settings/index.html +2394 -0
  462. package/docs/v2/sp/related-items/index.html +2417 -0
  463. package/docs/v2/sp/search/index.html +2474 -0
  464. package/docs/v2/sp/security/index.html +2432 -0
  465. package/docs/v2/sp/sharing/index.html +2589 -0
  466. package/docs/v2/sp/site-designs/index.html +2414 -0
  467. package/docs/v2/sp/site-groups/index.html +2504 -0
  468. package/docs/v2/sp/site-scripts/index.html +2433 -0
  469. package/docs/v2/sp/site-users/index.html +2641 -0
  470. package/docs/v2/sp/sites/index.html +2727 -0
  471. package/docs/v2/sp/social/index.html +2517 -0
  472. package/docs/v2/sp/sp-utilities-utility/index.html +2460 -0
  473. package/docs/v2/sp/subscriptions/index.html +2395 -0
  474. package/docs/v2/sp/taxonomy/index.html +2565 -0
  475. package/docs/v2/sp/tenant-properties/index.html +2286 -0
  476. package/docs/v2/sp/user-custom-actions/index.html +2424 -0
  477. package/docs/v2/sp/views/index.html +2652 -0
  478. package/docs/v2/sp/webs/index.html +4190 -0
  479. package/docs/v2/sp-addinhelpers/index.html +2274 -0
  480. package/docs/v2/sp-addinhelpers/sp-request-executor-client/index.html +2253 -0
  481. package/docs/v2/sp-addinhelpers/sp-rest-addin/index.html +2206 -0
  482. package/docs/v2/transition-guide/index.html +2435 -0
  483. package/mkdocs-requirements.txt +2 -0
  484. package/mkdocs.yml +188 -0
  485. package/package.json +96 -0
  486. package/packages/azidjsclient/index.ts +68 -0
  487. package/packages/azidjsclient/package.json +13 -0
  488. package/packages/azidjsclient/tsconfig.json +12 -0
  489. package/packages/core/behaviors/assign-from.ts +17 -0
  490. package/packages/core/behaviors/copy-from.ts +58 -0
  491. package/packages/core/extendable.ts +193 -0
  492. package/packages/core/index.ts +11 -0
  493. package/packages/core/moments.ts +117 -0
  494. package/packages/core/package.json +10 -0
  495. package/packages/core/storage.ts +274 -0
  496. package/packages/core/timeline.ts +387 -0
  497. package/packages/core/tsconfig.json +10 -0
  498. package/packages/core/util.ts +169 -0
  499. package/packages/graph/attachments/conversations.ts +14 -0
  500. package/packages/graph/attachments/index.ts +8 -0
  501. package/packages/graph/attachments/types.ts +37 -0
  502. package/packages/graph/batching.ts +408 -0
  503. package/packages/graph/behaviors/consistency-level.ts +17 -0
  504. package/packages/graph/behaviors/defaults.ts +41 -0
  505. package/packages/graph/behaviors/endpoint.ts +22 -0
  506. package/packages/graph/behaviors/graphbrowser.ts +38 -0
  507. package/packages/graph/behaviors/paged.ts +109 -0
  508. package/packages/graph/behaviors/spfx.ts +46 -0
  509. package/packages/graph/behaviors/telemetry.ts +19 -0
  510. package/packages/graph/bookings/funcs.ts +18 -0
  511. package/packages/graph/bookings/index.ts +62 -0
  512. package/packages/graph/bookings/types.ts +352 -0
  513. package/packages/graph/calendars/funcs.ts +58 -0
  514. package/packages/graph/calendars/groups.ts +19 -0
  515. package/packages/graph/calendars/index.ts +18 -0
  516. package/packages/graph/calendars/types.ts +73 -0
  517. package/packages/graph/calendars/users.ts +28 -0
  518. package/packages/graph/cloud-communications/index.ts +24 -0
  519. package/packages/graph/cloud-communications/types.ts +32 -0
  520. package/packages/graph/cloud-communications/users.ts +15 -0
  521. package/packages/graph/columns/addColumns.ts +28 -0
  522. package/packages/graph/columns/content-types.ts +44 -0
  523. package/packages/graph/columns/index.ts +14 -0
  524. package/packages/graph/columns/lists.ts +33 -0
  525. package/packages/graph/columns/sites.ts +32 -0
  526. package/packages/graph/columns/types.ts +24 -0
  527. package/packages/graph/contacts/index.ts +14 -0
  528. package/packages/graph/contacts/types.ts +126 -0
  529. package/packages/graph/contacts/users.ts +17 -0
  530. package/packages/graph/content-types/index.ts +11 -0
  531. package/packages/graph/content-types/lists.ts +44 -0
  532. package/packages/graph/content-types/sites.ts +70 -0
  533. package/packages/graph/content-types/types.ts +112 -0
  534. package/packages/graph/conversations/groups.ts +20 -0
  535. package/packages/graph/conversations/index.ts +19 -0
  536. package/packages/graph/conversations/types.ts +147 -0
  537. package/packages/graph/decorators.ts +164 -0
  538. package/packages/graph/directory-objects/index.ts +24 -0
  539. package/packages/graph/directory-objects/types.ts +94 -0
  540. package/packages/graph/fi.ts +46 -0
  541. package/packages/graph/graphqueryable.ts +193 -0
  542. package/packages/graph/groups/index.ts +25 -0
  543. package/packages/graph/groups/types.ts +130 -0
  544. package/packages/graph/index.ts +21 -0
  545. package/packages/graph/insights/index.ts +20 -0
  546. package/packages/graph/insights/types.ts +105 -0
  547. package/packages/graph/insights/users.ts +14 -0
  548. package/packages/graph/invitations/index.ts +22 -0
  549. package/packages/graph/invitations/types.ts +41 -0
  550. package/packages/graph/lists/drive.ts +21 -0
  551. package/packages/graph/lists/index.ts +10 -0
  552. package/packages/graph/lists/sites.ts +16 -0
  553. package/packages/graph/lists/types.ts +47 -0
  554. package/packages/graph/members/groups.ts +17 -0
  555. package/packages/graph/members/index.ts +8 -0
  556. package/packages/graph/members/types.ts +40 -0
  557. package/packages/graph/messages/index.ts +14 -0
  558. package/packages/graph/messages/types.ts +46 -0
  559. package/packages/graph/messages/users.ts +27 -0
  560. package/packages/graph/onedrive/funcs.ts +40 -0
  561. package/packages/graph/onedrive/groups.ts +33 -0
  562. package/packages/graph/onedrive/index.ts +48 -0
  563. package/packages/graph/onedrive/sites.ts +35 -0
  564. package/packages/graph/onedrive/types.ts +482 -0
  565. package/packages/graph/onedrive/users.ts +56 -0
  566. package/packages/graph/onenote/index.ts +16 -0
  567. package/packages/graph/onenote/types.ts +119 -0
  568. package/packages/graph/onenote/users.ts +14 -0
  569. package/packages/graph/operations.ts +22 -0
  570. package/packages/graph/outlook/index.ts +11 -0
  571. package/packages/graph/outlook/types.ts +58 -0
  572. package/packages/graph/outlook/users.ts +14 -0
  573. package/packages/graph/package.json +16 -0
  574. package/packages/graph/photos/groups.ts +14 -0
  575. package/packages/graph/photos/index.ts +7 -0
  576. package/packages/graph/photos/types.ts +33 -0
  577. package/packages/graph/photos/users.ts +14 -0
  578. package/packages/graph/planner/groups.ts +14 -0
  579. package/packages/graph/planner/index.ts +42 -0
  580. package/packages/graph/planner/types.ts +213 -0
  581. package/packages/graph/planner/users.ts +14 -0
  582. package/packages/graph/post-install.cjs +20 -0
  583. package/packages/graph/presets/all.ts +42 -0
  584. package/packages/graph/search/index.ts +18 -0
  585. package/packages/graph/search/types.ts +20 -0
  586. package/packages/graph/shares/index.ts +23 -0
  587. package/packages/graph/shares/types.ts +47 -0
  588. package/packages/graph/sites/group.ts +14 -0
  589. package/packages/graph/sites/index.ts +25 -0
  590. package/packages/graph/sites/types.ts +45 -0
  591. package/packages/graph/subscriptions/index.ts +24 -0
  592. package/packages/graph/subscriptions/types.ts +59 -0
  593. package/packages/graph/teams/index.ts +68 -0
  594. package/packages/graph/teams/types.ts +333 -0
  595. package/packages/graph/teams/users.ts +14 -0
  596. package/packages/graph/tsconfig.json +16 -0
  597. package/packages/graph/users/index.ts +34 -0
  598. package/packages/graph/users/types.ts +56 -0
  599. package/packages/graph/utils/type.ts +3 -0
  600. package/packages/logging/index.ts +145 -0
  601. package/packages/logging/listeners.ts +134 -0
  602. package/packages/logging/package.json +10 -0
  603. package/packages/logging/tsconfig.json +7 -0
  604. package/packages/msaljsclient/index.ts +40 -0
  605. package/packages/msaljsclient/package.json +12 -0
  606. package/packages/msaljsclient/tsconfig.json +12 -0
  607. package/packages/nodejs/behaviors/fetch.ts +130 -0
  608. package/packages/nodejs/behaviors/graphdefault.ts +50 -0
  609. package/packages/nodejs/behaviors/msal.ts +24 -0
  610. package/packages/nodejs/behaviors/spdefault.ts +45 -0
  611. package/packages/nodejs/behaviors/stream-parse.ts +7 -0
  612. package/packages/nodejs/index.ts +33 -0
  613. package/packages/nodejs/package.json +17 -0
  614. package/packages/nodejs/sp-extensions/stream.ts +136 -0
  615. package/packages/nodejs/tsconfig.json +28 -0
  616. package/packages/queryable/add-prop.ts +18 -0
  617. package/packages/queryable/behaviors/bearer-token.ts +15 -0
  618. package/packages/queryable/behaviors/browser-fetch.ts +131 -0
  619. package/packages/queryable/behaviors/caching-pessimistic.ts +67 -0
  620. package/packages/queryable/behaviors/caching.ts +149 -0
  621. package/packages/queryable/behaviors/cancelable.ts +264 -0
  622. package/packages/queryable/behaviors/inject-headers.ts +23 -0
  623. package/packages/queryable/behaviors/parsers.ts +134 -0
  624. package/packages/queryable/behaviors/resolvers.ts +28 -0
  625. package/packages/queryable/behaviors/timeout.ts +24 -0
  626. package/packages/queryable/index.ts +19 -0
  627. package/packages/queryable/invokable.ts +42 -0
  628. package/packages/queryable/operations.ts +32 -0
  629. package/packages/queryable/package.json +11 -0
  630. package/packages/queryable/queryable-factory.ts +19 -0
  631. package/packages/queryable/queryable.ts +239 -0
  632. package/packages/queryable/request-builders.ts +20 -0
  633. package/packages/queryable/tsconfig.json +11 -0
  634. package/packages/readme.md +21 -0
  635. package/packages/sp/appcatalog/index.ts +35 -0
  636. package/packages/sp/appcatalog/types.ts +176 -0
  637. package/packages/sp/appcatalog/web.ts +19 -0
  638. package/packages/sp/attachments/index.ts +11 -0
  639. package/packages/sp/attachments/item.ts +17 -0
  640. package/packages/sp/attachments/types.ts +95 -0
  641. package/packages/sp/batching.ts +483 -0
  642. package/packages/sp/behaviors/defaults.ts +38 -0
  643. package/packages/sp/behaviors/request-digest.ts +78 -0
  644. package/packages/sp/behaviors/spbrowser.ts +40 -0
  645. package/packages/sp/behaviors/spfx.ts +83 -0
  646. package/packages/sp/behaviors/telemetry.ts +35 -0
  647. package/packages/sp/clientside-pages/funcs.ts +27 -0
  648. package/packages/sp/clientside-pages/index.ts +27 -0
  649. package/packages/sp/clientside-pages/types.ts +1661 -0
  650. package/packages/sp/clientside-pages/web.ts +93 -0
  651. package/packages/sp/column-defaults/folder.ts +89 -0
  652. package/packages/sp/column-defaults/index.ts +8 -0
  653. package/packages/sp/column-defaults/list.ts +219 -0
  654. package/packages/sp/column-defaults/types.ts +19 -0
  655. package/packages/sp/comments/clientside-page.ts +120 -0
  656. package/packages/sp/comments/index.ts +14 -0
  657. package/packages/sp/comments/item.ts +77 -0
  658. package/packages/sp/comments/types.ts +160 -0
  659. package/packages/sp/content-types/index.ts +17 -0
  660. package/packages/sp/content-types/item.ts +17 -0
  661. package/packages/sp/content-types/list.ts +17 -0
  662. package/packages/sp/content-types/types.ts +181 -0
  663. package/packages/sp/content-types/web.ts +17 -0
  664. package/packages/sp/context-info/index.ts +40 -0
  665. package/packages/sp/decorators.ts +18 -0
  666. package/packages/sp/favorites/index.ts +32 -0
  667. package/packages/sp/favorites/types.ts +187 -0
  668. package/packages/sp/features/index.ts +11 -0
  669. package/packages/sp/features/site.ts +17 -0
  670. package/packages/sp/features/types.ts +73 -0
  671. package/packages/sp/features/web.ts +17 -0
  672. package/packages/sp/fi.ts +46 -0
  673. package/packages/sp/fields/index.ts +22 -0
  674. package/packages/sp/fields/list.ts +17 -0
  675. package/packages/sp/fields/types.ts +648 -0
  676. package/packages/sp/fields/web.ts +23 -0
  677. package/packages/sp/files/folder.ts +17 -0
  678. package/packages/sp/files/index.ts +25 -0
  679. package/packages/sp/files/item.ts +17 -0
  680. package/packages/sp/files/readable-file.ts +40 -0
  681. package/packages/sp/files/types.ts +771 -0
  682. package/packages/sp/files/web.ts +46 -0
  683. package/packages/sp/folders/index.ts +19 -0
  684. package/packages/sp/folders/item.ts +16 -0
  685. package/packages/sp/folders/list.ts +17 -0
  686. package/packages/sp/folders/types.ts +439 -0
  687. package/packages/sp/folders/web.ts +50 -0
  688. package/packages/sp/forms/index.ts +9 -0
  689. package/packages/sp/forms/list.ts +14 -0
  690. package/packages/sp/forms/types.ts +41 -0
  691. package/packages/sp/groupsitemanager/index.ts +18 -0
  692. package/packages/sp/groupsitemanager/types.ts +433 -0
  693. package/packages/sp/hubsites/index.ts +31 -0
  694. package/packages/sp/hubsites/site.ts +43 -0
  695. package/packages/sp/hubsites/types.ts +71 -0
  696. package/packages/sp/hubsites/web.ts +38 -0
  697. package/packages/sp/index.ts +24 -0
  698. package/packages/sp/items/get-all.ts +52 -0
  699. package/packages/sp/items/index.ts +18 -0
  700. package/packages/sp/items/list.ts +14 -0
  701. package/packages/sp/items/types.ts +405 -0
  702. package/packages/sp/lists/index.ts +23 -0
  703. package/packages/sp/lists/types.ts +851 -0
  704. package/packages/sp/lists/web.ts +68 -0
  705. package/packages/sp/navigation/index.ts +35 -0
  706. package/packages/sp/navigation/types.ts +243 -0
  707. package/packages/sp/navigation/web.ts +19 -0
  708. package/packages/sp/operations.ts +33 -0
  709. package/packages/sp/package.json +15 -0
  710. package/packages/sp/post-install.cjs +20 -0
  711. package/packages/sp/presets/all.ts +75 -0
  712. package/packages/sp/profiles/index.ts +30 -0
  713. package/packages/sp/profiles/types.ts +595 -0
  714. package/packages/sp/publishing-sitepageservice/index.ts +22 -0
  715. package/packages/sp/publishing-sitepageservice/types.ts +18 -0
  716. package/packages/sp/recycle-bin/index.ts +36 -0
  717. package/packages/sp/recycle-bin/types.ts +113 -0
  718. package/packages/sp/regional-settings/content-type.ts +11 -0
  719. package/packages/sp/regional-settings/field.ts +11 -0
  720. package/packages/sp/regional-settings/funcs.ts +10 -0
  721. package/packages/sp/regional-settings/index.ts +18 -0
  722. package/packages/sp/regional-settings/list.ts +11 -0
  723. package/packages/sp/regional-settings/types.ts +159 -0
  724. package/packages/sp/regional-settings/user-custom-actions.ts +11 -0
  725. package/packages/sp/regional-settings/web.ts +21 -0
  726. package/packages/sp/related-items/index.ts +7 -0
  727. package/packages/sp/related-items/types.ts +194 -0
  728. package/packages/sp/related-items/web.ts +22 -0
  729. package/packages/sp/search/index.ts +48 -0
  730. package/packages/sp/search/query.ts +254 -0
  731. package/packages/sp/search/suggest.ts +130 -0
  732. package/packages/sp/search/types.ts +480 -0
  733. package/packages/sp/security/funcs.ts +94 -0
  734. package/packages/sp/security/index.ts +21 -0
  735. package/packages/sp/security/item.ts +29 -0
  736. package/packages/sp/security/list.ts +29 -0
  737. package/packages/sp/security/types.ts +440 -0
  738. package/packages/sp/security/web.ts +34 -0
  739. package/packages/sp/sharing/file.ts +75 -0
  740. package/packages/sp/sharing/folder.ts +69 -0
  741. package/packages/sp/sharing/funcs.ts +258 -0
  742. package/packages/sp/sharing/index.ts +27 -0
  743. package/packages/sp/sharing/item.ts +53 -0
  744. package/packages/sp/sharing/types.ts +626 -0
  745. package/packages/sp/sharing/web.ts +109 -0
  746. package/packages/sp/site-designs/index.ts +29 -0
  747. package/packages/sp/site-designs/types.ts +456 -0
  748. package/packages/sp/site-designs/web.ts +41 -0
  749. package/packages/sp/site-groups/index.ts +11 -0
  750. package/packages/sp/site-groups/types.ts +133 -0
  751. package/packages/sp/site-groups/web.ts +73 -0
  752. package/packages/sp/site-scripts/index.ts +27 -0
  753. package/packages/sp/site-scripts/list.ts +27 -0
  754. package/packages/sp/site-scripts/types.ts +243 -0
  755. package/packages/sp/site-scripts/web.ts +24 -0
  756. package/packages/sp/site-users/index.ts +12 -0
  757. package/packages/sp/site-users/types.ts +195 -0
  758. package/packages/sp/site-users/web.ts +56 -0
  759. package/packages/sp/sites/index.ts +26 -0
  760. package/packages/sp/sites/types.ts +422 -0
  761. package/packages/sp/social/index.ts +33 -0
  762. package/packages/sp/social/types.ts +381 -0
  763. package/packages/sp/spqueryable.ts +244 -0
  764. package/packages/sp/sputilities/index.ts +23 -0
  765. package/packages/sp/sputilities/types.ts +197 -0
  766. package/packages/sp/subscriptions/index.ts +10 -0
  767. package/packages/sp/subscriptions/list.ts +18 -0
  768. package/packages/sp/subscriptions/types.ts +107 -0
  769. package/packages/sp/taxonomy/index.ts +50 -0
  770. package/packages/sp/taxonomy/types.ts +508 -0
  771. package/packages/sp/tsconfig.json +16 -0
  772. package/packages/sp/types.ts +283 -0
  773. package/packages/sp/user-custom-actions/index.ts +15 -0
  774. package/packages/sp/user-custom-actions/list.ts +18 -0
  775. package/packages/sp/user-custom-actions/site.ts +18 -0
  776. package/packages/sp/user-custom-actions/types.ts +133 -0
  777. package/packages/sp/user-custom-actions/web.ts +21 -0
  778. package/packages/sp/utils/encode-path-str.ts +29 -0
  779. package/packages/sp/utils/extract-web-url.ts +21 -0
  780. package/packages/sp/utils/file-names.ts +35 -0
  781. package/packages/sp/utils/metadata.ts +5 -0
  782. package/packages/sp/utils/odata-url-from.ts +42 -0
  783. package/packages/sp/utils/to-resource-path.ts +9 -0
  784. package/packages/sp/views/index.ts +14 -0
  785. package/packages/sp/views/list.ts +33 -0
  786. package/packages/sp/views/types.ts +210 -0
  787. package/packages/sp/webparts/file.ts +21 -0
  788. package/packages/sp/webparts/index.ts +11 -0
  789. package/packages/sp/webparts/types.ts +141 -0
  790. package/packages/sp/webs/index.ts +32 -0
  791. package/packages/sp/webs/types.ts +350 -0
  792. package/packages/sp-admin/index.ts +46 -0
  793. package/packages/sp-admin/office-tenant.ts +567 -0
  794. package/packages/sp-admin/package.json +13 -0
  795. package/packages/sp-admin/site-properties.ts +45 -0
  796. package/packages/sp-admin/tenant.ts +595 -0
  797. package/packages/sp-admin/tsconfig.json +20 -0
  798. package/packages/sp-admin/types.ts +1679 -0
  799. package/packages/tsconfig-watch.json +9 -0
  800. package/packages/tsconfig.json +37 -0
  801. package/pre-install.cjs +1 -0
  802. package/samples/custom-bundle-webpack/index.ts +33 -0
  803. package/samples/custom-bundle-webpack/package-lock.json +4601 -0
  804. package/samples/custom-bundle-webpack/package.json +18 -0
  805. package/samples/custom-bundle-webpack/readme.md +102 -0
  806. package/samples/custom-bundle-webpack/tsconfig.json +12 -0
  807. package/samples/custom-bundle-webpack/webpack.config.js +27 -0
  808. package/samples/nodejs-app/.vscode/launch.json +27 -0
  809. package/samples/nodejs-app/.vscode/settings.json +10 -0
  810. package/samples/nodejs-app/.vscode/tasks.json +22 -0
  811. package/samples/nodejs-app/index.ts +63 -0
  812. package/samples/nodejs-app/package-lock.json +259 -0
  813. package/samples/nodejs-app/package.json +21 -0
  814. package/samples/nodejs-app/readme.md +140 -0
  815. package/samples/nodejs-app/tsconfig.json +14 -0
  816. package/samples/nodejs-commonjs/package-lock.json +702 -0
  817. package/samples/nodejs-commonjs/package.json +21 -0
  818. package/samples/nodejs-commonjs/readme.md +58 -0
  819. package/samples/nodejs-commonjs/src/index.ts +23 -0
  820. package/samples/nodejs-commonjs/src/settings.ts +35 -0
  821. package/samples/nodejs-commonjs/tsconfig.json +35 -0
  822. package/samples/project-preset/README.md +73 -0
  823. package/samples/project-preset/package-lock.json +21097 -0
  824. package/samples/project-preset/package.json +29 -0
  825. package/samples/project-preset/teams/4530a515-8ba7-45bb-9a27-be06b33c59d4_color.png +0 -0
  826. package/samples/project-preset/teams/4530a515-8ba7-45bb-9a27-be06b33c59d4_outline.png +0 -0
  827. package/samples/readme.md +16 -0
  828. package/settings.example.js +57 -0
  829. package/test/args.ts +107 -0
  830. package/test/clean-subsite.ts +36 -0
  831. package/test/core/assumptions.ts +99 -0
  832. package/test/core/storage.ts +60 -0
  833. package/test/core/timeline.ts +205 -0
  834. package/test/core/util.ts +205 -0
  835. package/test/graph/assets/testconvert.docx +0 -0
  836. package/test/graph/batch.ts +125 -0
  837. package/test/graph/calendars.ts +234 -0
  838. package/test/graph/columns.ts +247 -0
  839. package/test/graph/contacts.ts +254 -0
  840. package/test/graph/content-types.ts +206 -0
  841. package/test/graph/directoryobjects.ts +115 -0
  842. package/test/graph/groups.ts +130 -0
  843. package/test/graph/lists.ts +72 -0
  844. package/test/graph/onedrive.ts +365 -0
  845. package/test/graph/outlook.ts +95 -0
  846. package/test/graph/paging.ts +91 -0
  847. package/test/graph/planner.ts +160 -0
  848. package/test/graph/querable.ts +97 -0
  849. package/test/graph/search.ts +4 -0
  850. package/test/graph/shares.ts +26 -0
  851. package/test/graph/sites.ts +40 -0
  852. package/test/graph/teams.ts +76 -0
  853. package/test/graph/utilities/getTestingGraphSPSite.ts +27 -0
  854. package/test/graph/utilities/getValidUser.ts +37 -0
  855. package/test/load-settings.ts +103 -0
  856. package/test/logging/logging.ts +86 -0
  857. package/test/mocha-root-hooks.ts +227 -0
  858. package/test/nodejs/sp-extensions.ts +86 -0
  859. package/test/pnp-test.ts +60 -0
  860. package/test/queryable/add-prop.ts +24 -0
  861. package/test/queryable/behaviors.ts +188 -0
  862. package/test/queryable/invokable.ts +35 -0
  863. package/test/queryable/queryable.ts +118 -0
  864. package/test/sp/alias.ts +46 -0
  865. package/test/sp/appcatalog.ts +142 -0
  866. package/test/sp/assets/helloworld.sppkg +0 -0
  867. package/test/sp/assets/sample_file.jpg +0 -0
  868. package/test/sp/attachments.ts +134 -0
  869. package/test/sp/batch.ts +362 -0
  870. package/test/sp/clientside-pages.ts +426 -0
  871. package/test/sp/column-defaults.ts +225 -0
  872. package/test/sp/comments.ts +202 -0
  873. package/test/sp/content-types.ts +68 -0
  874. package/test/sp/favorites.ts +2 -0
  875. package/test/sp/features.ts +201 -0
  876. package/test/sp/fields.ts +396 -0
  877. package/test/sp/files.ts +338 -0
  878. package/test/sp/folders.ts +242 -0
  879. package/test/sp/forms.ts +22 -0
  880. package/test/sp/groupsitemanager.ts +88 -0
  881. package/test/sp/hubsites.ts +41 -0
  882. package/test/sp/items.ts +179 -0
  883. package/test/sp/lists.ts +319 -0
  884. package/test/sp/navigation.ts +167 -0
  885. package/test/sp/profiles.ts +2 -0
  886. package/test/sp/query-escaping.ts +94 -0
  887. package/test/sp/recycle-bin.ts +1 -0
  888. package/test/sp/regional-settings.ts +58 -0
  889. package/test/sp/related-items.ts +94 -0
  890. package/test/sp/search.ts +39 -0
  891. package/test/sp/security.ts +90 -0
  892. package/test/sp/sharing.ts +313 -0
  893. package/test/sp/site-designs.ts +224 -0
  894. package/test/sp/site-groups.ts +98 -0
  895. package/test/sp/site-scripts.ts +162 -0
  896. package/test/sp/site-users.ts +93 -0
  897. package/test/sp/sites.ts +156 -0
  898. package/test/sp/social.ts +2 -0
  899. package/test/sp/spfx.ts +52 -0
  900. package/test/sp/sputilities.ts +78 -0
  901. package/test/sp/subscriptions.ts +64 -0
  902. package/test/sp/taxonomy.ts +178 -0
  903. package/test/sp/user-custom-actions.ts +31 -0
  904. package/test/sp/views.ts +117 -0
  905. package/test/sp/webparts.ts +38 -0
  906. package/test/sp/webs.ts +249 -0
  907. package/test/test-invokable-props.ts +35 -0
  908. package/test/test-props.ts +90 -0
  909. package/test/test-recording.ts +171 -0
  910. package/test/tsconfig.json +18 -0
  911. package/tools/buildsystem/package-lock.json +4404 -0
  912. package/tools/buildsystem/package.json +56 -0
  913. package/tools/buildsystem/readme.md +23 -0
  914. package/tools/config.js +34 -0
  915. package/tools/local-module-resolver/cjs.ts +33 -0
  916. package/tools/local-module-resolver/esm-debug.ts +2 -0
  917. package/tools/local-module-resolver/esm-test.ts +2 -0
  918. package/tools/local-module-resolver/esm.ts +112 -0
  919. package/tools/local-module-resolver/readme.md +8 -0
  920. package/tsconfig.buildsystem.json +17 -0
  921. package/tsconfig.json +42 -0
package/docs/v2/getting-started/index.html ADDED
@@ -0,0 +1,2789 @@
1
+
2
+ <!doctype html>
3
+ <html lang="en" class="no-js">
4
+ <head>
5
+
6
+ <meta charset="utf-8">
7
+ <meta name="viewport" content="width=device-width,initial-scale=1">
8
+
9
+
10
+ <link rel="canonical" href="https://pnp.github.io/pnpjs/getting-started/">
11
+
12
+
13
+ <link rel="shortcut icon" href="../assets/images/favicon.png">
14
+ <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-6.0.2">
15
+
16
+
17
+
18
+ <title>Getting Started - PnP/PnPjs</title>
19
+
20
+
21
+
22
+ <link rel="stylesheet" href="../assets/stylesheets/main.38780c08.min.css">
23
+
24
+
25
+ <link rel="stylesheet" href="../assets/stylesheets/palette.3f72e892.min.css">
26
+
27
+
28
+
29
+ <meta name="theme-color" content="#2094f3">
30
+
31
+
32
+
33
+
34
+
35
+
36
+
37
+ <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
38
+ <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
39
+ <style>body,input{font-family:"Roboto",-apple-system,BlinkMacSystemFont,Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono",SFMono-Regular,Consolas,Menlo,monospace}</style>
40
+
41
+
42
+
43
+
44
+ <link rel="stylesheet" href="../css/extra.css">
45
+
46
+
47
+ <img src="https://telemetry.sharepointpnp.com/@pnp/pnpjs/ghpages/pnpjs/getting-started/" alt="spacer" width="1" height="1" />
48
+
49
+
50
+ </head>
51
+
52
+
53
+
54
+
55
+
56
+
57
+
58
+ <body dir="ltr" data-md-color-scheme="" data-md-color-primary="blue" data-md-color-accent="">
59
+
60
+
61
+ <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
62
+ <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
63
+ <label class="md-overlay" for="__drawer"></label>
64
+ <div data-md-component="skip">
65
+
66
+
67
+ <a href="#getting-started" class="md-skip">
68
+ Skip to content
69
+ </a>
70
+
71
+ </div>
72
+ <div data-md-component="announce">
73
+
74
+ </div>
75
+
76
+ <header class="md-header" data-md-component="header">
77
+ <nav class="md-header-nav md-grid" aria-label="Header">
78
+ <a href="https://pnp.github.io/pnpjs/" title="PnP/PnPjs" class="md-header-nav__button md-logo" aria-label="PnP/PnPjs">
79
+
80
+ <img src="../img/Logo.png" alt="logo">
81
+
82
+ </a>
83
+ <label class="md-header-nav__button md-icon" for="__drawer">
84
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
85
+ </label>
86
+ <div class="md-header-nav__title" data-md-component="header-title">
87
+
88
+ <div class="md-header-nav__ellipsis">
89
+ <span class="md-header-nav__topic md-ellipsis">
90
+ PnP/PnPjs
91
+ </span>
92
+ <span class="md-header-nav__topic md-ellipsis">
93
+
94
+ Getting Started
95
+
96
+ </span>
97
+ </div>
98
+
99
+ </div>
100
+
101
+ <label class="md-header-nav__button md-icon" for="__search">
102
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
103
+ </label>
104
+
105
+ <div class="md-search" data-md-component="search" role="dialog">
106
+ <label class="md-search__overlay" for="__search"></label>
107
+ <div class="md-search__inner" role="search">
108
+ <form class="md-search__form" name="search">
109
+ <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active">
110
+ <label class="md-search__icon md-icon" for="__search">
111
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
112
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
113
+ </label>
114
+ <button type="reset" class="md-search__icon md-icon" aria-label="Clear" data-md-component="search-reset" tabindex="-1">
115
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
116
+ </button>
117
+ </form>
118
+ <div class="md-search__output">
119
+ <div class="md-search__scrollwrap" data-md-scrollfix>
120
+ <div class="md-search-result" data-md-component="search-result">
121
+ <div class="md-search-result__meta">
122
+ Initializing search
123
+ </div>
124
+ <ol class="md-search-result__list"></ol>
125
+ </div>
126
+ </div>
127
+ </div>
128
+ </div>
129
+ </div>
130
+
131
+
132
+ <div class="md-header-nav__source">
133
+
134
+ <a href="https://github.com/pnp/pnpjs/" title="Go to repository" class="md-source">
135
+ <div class="md-source__icon md-icon">
136
+
137
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 00-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 01-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 000 40.81l195.61 195.6a28.86 28.86 0 0040.8 0l194.69-194.69a28.86 28.86 0 000-40.81z"/></svg>
138
+ </div>
139
+ <div class="md-source__repository">
140
+ GitHub
141
+ </div>
142
+ </a>
143
+ </div>
144
+
145
+ </nav>
146
+ </header>
147
+
148
+ <div class="md-container" data-md-component="container">
149
+
150
+
151
+
152
+
153
+ <main class="md-main" data-md-component="main">
154
+ <div class="md-main__inner md-grid">
155
+
156
+
157
+ <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
158
+ <div class="md-sidebar__scrollwrap">
159
+ <div class="md-sidebar__inner">
160
+ <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
161
+ <label class="md-nav__title" for="__drawer">
162
+ <a href="https://pnp.github.io/pnpjs/" title="PnP/PnPjs" class="md-nav__button md-logo" aria-label="PnP/PnPjs">
163
+
164
+ <img src="../img/Logo.png" alt="logo">
165
+
166
+ </a>
167
+ PnP/PnPjs
168
+ </label>
169
+
170
+ <div class="md-nav__source">
171
+
172
+ <a href="https://github.com/pnp/pnpjs/" title="Go to repository" class="md-source">
173
+ <div class="md-source__icon md-icon">
174
+
175
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 00-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 01-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 000 40.81l195.61 195.6a28.86 28.86 0 0040.8 0l194.69-194.69a28.86 28.86 0 000-40.81z"/></svg>
176
+ </div>
177
+ <div class="md-source__repository">
178
+ GitHub
179
+ </div>
180
+ </a>
181
+ </div>
182
+
183
+ <ul class="md-nav__list" data-md-scrollfix>
184
+
185
+
186
+
187
+
188
+
189
+
190
+ <li class="md-nav__item">
191
+ <a href=".." class="md-nav__link">
192
+ Home
193
+ </a>
194
+ </li>
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+ <li class="md-nav__item">
203
+
204
+ <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
205
+
206
+
207
+
208
+
209
+ <label class="md-nav__link md-nav__link--active" for="__toc">
210
+ Getting Started
211
+ <span class="md-nav__icon md-icon"></span>
212
+ </label>
213
+
214
+ <a href="./" class="md-nav__link md-nav__link--active">
215
+ Getting Started
216
+ </a>
217
+
218
+
219
+ <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
220
+
221
+
222
+
223
+
224
+
225
+ <label class="md-nav__title" for="__toc">
226
+ <span class="md-nav__icon md-icon"></span>
227
+ Table of contents
228
+ </label>
229
+ <ul class="md-nav__list" data-md-scrollfix>
230
+
231
+ <li class="md-nav__item">
232
+ <a href="#install" class="md-nav__link">
233
+ Install
234
+ </a>
235
+
236
+ </li>
237
+
238
+ <li class="md-nav__item">
239
+ <a href="#getting-started-with-sharepoint-framework" class="md-nav__link">
240
+ Getting Started with SharePoint Framework
241
+ </a>
242
+
243
+ <nav class="md-nav" aria-label="Getting Started with SharePoint Framework">
244
+ <ul class="md-nav__list">
245
+
246
+ <li class="md-nav__item">
247
+ <a href="#establish-context" class="md-nav__link">
248
+ Establish Context
249
+ </a>
250
+
251
+ <nav class="md-nav" aria-label="Establish Context">
252
+ <ul class="md-nav__list">
253
+
254
+ <li class="md-nav__item">
255
+ <a href="#using-pnpcore-setup" class="md-nav__link">
256
+ Using @pnp/core setup
257
+ </a>
258
+
259
+ </li>
260
+
261
+ <li class="md-nav__item">
262
+ <a href="#using-pnpsp-setup" class="md-nav__link">
263
+ Using @pnp/sp setup
264
+ </a>
265
+
266
+ </li>
267
+
268
+ <li class="md-nav__item">
269
+ <a href="#using-pnpgraph-setup" class="md-nav__link">
270
+ Using @pnp/graph setup
271
+ </a>
272
+
273
+ </li>
274
+
275
+ <li class="md-nav__item">
276
+ <a href="#establish-context-within-an-spfx-service" class="md-nav__link">
277
+ Establish context within an SPFx service
278
+ </a>
279
+
280
+ </li>
281
+
282
+ </ul>
283
+ </nav>
284
+
285
+ </li>
286
+
287
+ </ul>
288
+ </nav>
289
+
290
+ </li>
291
+
292
+ <li class="md-nav__item">
293
+ <a href="#connect-to-sharepoint-from-node" class="md-nav__link">
294
+ Connect to SharePoint from Node
295
+ </a>
296
+
297
+ </li>
298
+
299
+ <li class="md-nav__item">
300
+ <a href="#connect-to-microsoft-graph-from-node" class="md-nav__link">
301
+ Connect to Microsoft Graph From Node
302
+ </a>
303
+
304
+ </li>
305
+
306
+ <li class="md-nav__item">
307
+ <a href="#getting-started-outside-sharepoint-framework" class="md-nav__link">
308
+ Getting Started outside SharePoint Framework
309
+ </a>
310
+
311
+ <nav class="md-nav" aria-label="Getting Started outside SharePoint Framework">
312
+ <ul class="md-nav__list">
313
+
314
+ <li class="md-nav__item">
315
+ <a href="#set-baseurl-through-setup" class="md-nav__link">
316
+ Set baseUrl through setup
317
+ </a>
318
+
319
+ </li>
320
+
321
+ <li class="md-nav__item">
322
+ <a href="#create-web-instances-directly" class="md-nav__link">
323
+ Create Web instances directly
324
+ </a>
325
+
326
+ </li>
327
+
328
+ </ul>
329
+ </nav>
330
+
331
+ </li>
332
+
333
+ <li class="md-nav__item">
334
+ <a href="#next-steps" class="md-nav__link">
335
+ Next Steps
336
+ </a>
337
+
338
+ </li>
339
+
340
+ </ul>
341
+
342
+ </nav>
343
+
344
+ </li>
345
+
346
+
347
+
348
+
349
+
350
+
351
+
352
+ <li class="md-nav__item">
353
+ <a href="../news/2020-year-in-review/" class="md-nav__link">
354
+ 2020 Year In Review
355
+ </a>
356
+ </li>
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+
365
+
366
+ <li class="md-nav__item md-nav__item--active md-nav__item--nested">
367
+
368
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4" checked>
369
+
370
+ <label class="md-nav__link" for="nav-4">
371
+ General
372
+ <span class="md-nav__icon md-icon"></span>
373
+ </label>
374
+ <nav class="md-nav" aria-label="General" data-md-level="1">
375
+ <label class="md-nav__title" for="nav-4">
376
+ <span class="md-nav__icon md-icon"></span>
377
+ General
378
+ </label>
379
+ <ul class="md-nav__list" data-md-scrollfix>
380
+
381
+
382
+
383
+
384
+
385
+
386
+
387
+
388
+
389
+ <li class="md-nav__item md-nav__item--active">
390
+
391
+ <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
392
+
393
+
394
+
395
+
396
+ <label class="md-nav__link md-nav__link--active" for="__toc">
397
+ Getting Started
398
+ <span class="md-nav__icon md-icon"></span>
399
+ </label>
400
+
401
+ <a href="./" class="md-nav__link md-nav__link--active">
402
+ Getting Started
403
+ </a>
404
+
405
+
406
+ <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
407
+
408
+
409
+
410
+
411
+
412
+ <label class="md-nav__title" for="__toc">
413
+ <span class="md-nav__icon md-icon"></span>
414
+ Table of contents
415
+ </label>
416
+ <ul class="md-nav__list" data-md-scrollfix>
417
+
418
+ <li class="md-nav__item">
419
+ <a href="#install" class="md-nav__link">
420
+ Install
421
+ </a>
422
+
423
+ </li>
424
+
425
+ <li class="md-nav__item">
426
+ <a href="#getting-started-with-sharepoint-framework" class="md-nav__link">
427
+ Getting Started with SharePoint Framework
428
+ </a>
429
+
430
+ <nav class="md-nav" aria-label="Getting Started with SharePoint Framework">
431
+ <ul class="md-nav__list">
432
+
433
+ <li class="md-nav__item">
434
+ <a href="#establish-context" class="md-nav__link">
435
+ Establish Context
436
+ </a>
437
+
438
+ <nav class="md-nav" aria-label="Establish Context">
439
+ <ul class="md-nav__list">
440
+
441
+ <li class="md-nav__item">
442
+ <a href="#using-pnpcore-setup" class="md-nav__link">
443
+ Using @pnp/core setup
444
+ </a>
445
+
446
+ </li>
447
+
448
+ <li class="md-nav__item">
449
+ <a href="#using-pnpsp-setup" class="md-nav__link">
450
+ Using @pnp/sp setup
451
+ </a>
452
+
453
+ </li>
454
+
455
+ <li class="md-nav__item">
456
+ <a href="#using-pnpgraph-setup" class="md-nav__link">
457
+ Using @pnp/graph setup
458
+ </a>
459
+
460
+ </li>
461
+
462
+ <li class="md-nav__item">
463
+ <a href="#establish-context-within-an-spfx-service" class="md-nav__link">
464
+ Establish context within an SPFx service
465
+ </a>
466
+
467
+ </li>
468
+
469
+ </ul>
470
+ </nav>
471
+
472
+ </li>
473
+
474
+ </ul>
475
+ </nav>
476
+
477
+ </li>
478
+
479
+ <li class="md-nav__item">
480
+ <a href="#connect-to-sharepoint-from-node" class="md-nav__link">
481
+ Connect to SharePoint from Node
482
+ </a>
483
+
484
+ </li>
485
+
486
+ <li class="md-nav__item">
487
+ <a href="#connect-to-microsoft-graph-from-node" class="md-nav__link">
488
+ Connect to Microsoft Graph From Node
489
+ </a>
490
+
491
+ </li>
492
+
493
+ <li class="md-nav__item">
494
+ <a href="#getting-started-outside-sharepoint-framework" class="md-nav__link">
495
+ Getting Started outside SharePoint Framework
496
+ </a>
497
+
498
+ <nav class="md-nav" aria-label="Getting Started outside SharePoint Framework">
499
+ <ul class="md-nav__list">
500
+
501
+ <li class="md-nav__item">
502
+ <a href="#set-baseurl-through-setup" class="md-nav__link">
503
+ Set baseUrl through setup
504
+ </a>
505
+
506
+ </li>
507
+
508
+ <li class="md-nav__item">
509
+ <a href="#create-web-instances-directly" class="md-nav__link">
510
+ Create Web instances directly
511
+ </a>
512
+
513
+ </li>
514
+
515
+ </ul>
516
+ </nav>
517
+
518
+ </li>
519
+
520
+ <li class="md-nav__item">
521
+ <a href="#next-steps" class="md-nav__link">
522
+ Next Steps
523
+ </a>
524
+
525
+ </li>
526
+
527
+ </ul>
528
+
529
+ </nav>
530
+
531
+ </li>
532
+
533
+
534
+
535
+
536
+
537
+
538
+
539
+ <li class="md-nav__item">
540
+ <a href="../transition-guide/" class="md-nav__link">
541
+ Transition Guide
542
+ </a>
543
+ </li>
544
+
545
+
546
+
547
+
548
+
549
+
550
+
551
+ <li class="md-nav__item">
552
+ <a href="../npm-scripts/" class="md-nav__link">
553
+ Npm Scripts
554
+ </a>
555
+ </li>
556
+
557
+
558
+
559
+
560
+
561
+
562
+
563
+ <li class="md-nav__item">
564
+ <a href="../SPFx-on-premises/" class="md-nav__link">
565
+ SPFx On-Premises
566
+ </a>
567
+ </li>
568
+
569
+
570
+
571
+
572
+
573
+
574
+
575
+ <li class="md-nav__item">
576
+ <a href="../nodejs-support/" class="md-nav__link">
577
+ Working in Nodejs
578
+ </a>
579
+ </li>
580
+
581
+
582
+ </ul>
583
+ </nav>
584
+ </li>
585
+
586
+
587
+
588
+
589
+
590
+
591
+
592
+ <li class="md-nav__item md-nav__item--nested">
593
+
594
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
595
+
596
+ <label class="md-nav__link" for="nav-5">
597
+ Library Concepts
598
+ <span class="md-nav__icon md-icon"></span>
599
+ </label>
600
+ <nav class="md-nav" aria-label="Library Concepts" data-md-level="1">
601
+ <label class="md-nav__title" for="nav-5">
602
+ <span class="md-nav__icon md-icon"></span>
603
+ Library Concepts
604
+ </label>
605
+ <ul class="md-nav__list" data-md-scrollfix>
606
+
607
+
608
+
609
+
610
+
611
+
612
+
613
+ <li class="md-nav__item">
614
+ <a href="../concepts/configuration/" class="md-nav__link">
615
+ Configuration
616
+ </a>
617
+ </li>
618
+
619
+
620
+
621
+
622
+
623
+
624
+
625
+ <li class="md-nav__item">
626
+ <a href="../concepts/selective-imports/" class="md-nav__link">
627
+ Selective Imports
628
+ </a>
629
+ </li>
630
+
631
+
632
+
633
+
634
+
635
+
636
+
637
+ <li class="md-nav__item">
638
+ <a href="../concepts/custom-bundle/" class="md-nav__link">
639
+ Custom Bundle
640
+ </a>
641
+ </li>
642
+
643
+
644
+
645
+
646
+
647
+
648
+
649
+ <li class="md-nav__item">
650
+ <a href="../concepts/ie11-mode/" class="md-nav__link">
651
+ IE11 Mode
652
+ </a>
653
+ </li>
654
+
655
+
656
+
657
+
658
+
659
+
660
+
661
+ <li class="md-nav__item">
662
+ <a href="../concepts/invokable/" class="md-nav__link">
663
+ Invokables
664
+ </a>
665
+ </li>
666
+
667
+
668
+
669
+
670
+
671
+
672
+
673
+ <li class="md-nav__item">
674
+ <a href="../concepts/polyfill/" class="md-nav__link">
675
+ Polyfills
676
+ </a>
677
+ </li>
678
+
679
+
680
+
681
+
682
+
683
+
684
+
685
+ <li class="md-nav__item">
686
+ <a href="../concepts/settings/" class="md-nav__link">
687
+ Settings
688
+ </a>
689
+ </li>
690
+
691
+
692
+
693
+
694
+
695
+
696
+
697
+ <li class="md-nav__item">
698
+ <a href="../concepts/error-handling/" class="md-nav__link">
699
+ Error Handling
700
+ </a>
701
+ </li>
702
+
703
+
704
+
705
+
706
+
707
+
708
+
709
+ <li class="md-nav__item md-nav__item--nested">
710
+
711
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-5-9" type="checkbox" id="nav-5-9">
712
+
713
+ <label class="md-nav__link" for="nav-5-9">
714
+ Authentication
715
+ <span class="md-nav__icon md-icon"></span>
716
+ </label>
717
+ <nav class="md-nav" aria-label="Authentication" data-md-level="2">
718
+ <label class="md-nav__title" for="nav-5-9">
719
+ <span class="md-nav__icon md-icon"></span>
720
+ Authentication
721
+ </label>
722
+ <ul class="md-nav__list" data-md-scrollfix>
723
+
724
+
725
+
726
+
727
+
728
+
729
+
730
+ <li class="md-nav__item">
731
+ <a href="../authentication/" class="md-nav__link">
732
+ Getting Started
733
+ </a>
734
+ </li>
735
+
736
+
737
+
738
+
739
+
740
+
741
+
742
+ <li class="md-nav__item">
743
+ <a href="../authentication/client-spfx/" class="md-nav__link">
744
+ SPFx Auth
745
+ </a>
746
+ </li>
747
+
748
+
749
+
750
+
751
+
752
+
753
+
754
+ <li class="md-nav__item">
755
+ <a href="../authentication/msaljsclient/" class="md-nav__link">
756
+ MSAL Client
757
+ </a>
758
+ </li>
759
+
760
+
761
+
762
+
763
+
764
+
765
+
766
+ <li class="md-nav__item">
767
+ <a href="../authentication/adaljsclient/" class="md-nav__link">
768
+ ADAL Client
769
+ </a>
770
+ </li>
771
+
772
+
773
+
774
+
775
+
776
+
777
+
778
+ <li class="md-nav__item">
779
+ <a href="../authentication/client-spa/" class="md-nav__link">
780
+ SPA Auth
781
+ </a>
782
+ </li>
783
+
784
+
785
+
786
+
787
+
788
+
789
+
790
+ <li class="md-nav__item">
791
+ <a href="../authentication/server-nodejs/" class="md-nav__link">
792
+ NodeJS Auth
793
+ </a>
794
+ </li>
795
+
796
+
797
+
798
+
799
+
800
+
801
+
802
+ <li class="md-nav__item">
803
+ <a href="../authentication/sp-app-registration/" class="md-nav__link">
804
+ SP App Reg
805
+ </a>
806
+ </li>
807
+
808
+
809
+
810
+
811
+
812
+
813
+
814
+ <li class="md-nav__item">
815
+ <a href="../authentication/bearertokenclient/" class="md-nav__link">
816
+ Bearer Token Client
817
+ </a>
818
+ </li>
819
+
820
+
821
+
822
+
823
+
824
+
825
+
826
+ <li class="md-nav__item">
827
+ <a href="../authentication/lambdaclient/" class="md-nav__link">
828
+ Lambda Token Client
829
+ </a>
830
+ </li>
831
+
832
+
833
+ </ul>
834
+ </nav>
835
+ </li>
836
+
837
+
838
+ </ul>
839
+ </nav>
840
+ </li>
841
+
842
+
843
+
844
+
845
+
846
+
847
+
848
+ <li class="md-nav__item md-nav__item--nested">
849
+
850
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6">
851
+
852
+ <label class="md-nav__link" for="nav-6">
853
+ Packages
854
+ <span class="md-nav__icon md-icon"></span>
855
+ </label>
856
+ <nav class="md-nav" aria-label="Packages" data-md-level="1">
857
+ <label class="md-nav__title" for="nav-6">
858
+ <span class="md-nav__icon md-icon"></span>
859
+ Packages
860
+ </label>
861
+ <ul class="md-nav__list" data-md-scrollfix>
862
+
863
+
864
+
865
+
866
+
867
+
868
+
869
+ <li class="md-nav__item">
870
+ <a href="../packages/" class="md-nav__link">
871
+ Packages
872
+ </a>
873
+ </li>
874
+
875
+
876
+
877
+
878
+
879
+
880
+
881
+ <li class="md-nav__item md-nav__item--nested">
882
+
883
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-6-2" type="checkbox" id="nav-6-2">
884
+
885
+ <label class="md-nav__link" for="nav-6-2">
886
+ common
887
+ <span class="md-nav__icon md-icon"></span>
888
+ </label>
889
+ <nav class="md-nav" aria-label="common" data-md-level="2">
890
+ <label class="md-nav__title" for="nav-6-2">
891
+ <span class="md-nav__icon md-icon"></span>
892
+ common
893
+ </label>
894
+ <ul class="md-nav__list" data-md-scrollfix>
895
+
896
+
897
+
898
+
899
+
900
+
901
+
902
+ <li class="md-nav__item">
903
+ <a href="../common/" class="md-nav__link">
904
+ common
905
+ </a>
906
+ </li>
907
+
908
+
909
+
910
+
911
+
912
+
913
+
914
+ <li class="md-nav__item">
915
+ <a href="../common/collections/" class="md-nav__link">
916
+ collections
917
+ </a>
918
+ </li>
919
+
920
+
921
+
922
+
923
+
924
+
925
+
926
+ <li class="md-nav__item">
927
+ <a href="../common/custom-httpclientimpl/" class="md-nav__link">
928
+ Custom HttpClientImpl
929
+ </a>
930
+ </li>
931
+
932
+
933
+
934
+
935
+
936
+
937
+
938
+ <li class="md-nav__item">
939
+ <a href="../common/libconfig/" class="md-nav__link">
940
+ libconfig
941
+ </a>
942
+ </li>
943
+
944
+
945
+
946
+
947
+
948
+
949
+
950
+ <li class="md-nav__item">
951
+ <a href="../common/netutil/" class="md-nav__link">
952
+ netutil
953
+ </a>
954
+ </li>
955
+
956
+
957
+
958
+
959
+
960
+
961
+
962
+ <li class="md-nav__item">
963
+ <a href="../common/storage/" class="md-nav__link">
964
+ storage
965
+ </a>
966
+ </li>
967
+
968
+
969
+
970
+
971
+
972
+
973
+
974
+ <li class="md-nav__item">
975
+ <a href="../common/util/" class="md-nav__link">
976
+ util
977
+ </a>
978
+ </li>
979
+
980
+
981
+ </ul>
982
+ </nav>
983
+ </li>
984
+
985
+
986
+
987
+
988
+
989
+
990
+
991
+ <li class="md-nav__item md-nav__item--nested">
992
+
993
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-6-3" type="checkbox" id="nav-6-3">
994
+
995
+ <label class="md-nav__link" for="nav-6-3">
996
+ config-store
997
+ <span class="md-nav__icon md-icon"></span>
998
+ </label>
999
+ <nav class="md-nav" aria-label="config-store" data-md-level="2">
1000
+ <label class="md-nav__title" for="nav-6-3">
1001
+ <span class="md-nav__icon md-icon"></span>
1002
+ config-store
1003
+ </label>
1004
+ <ul class="md-nav__list" data-md-scrollfix>
1005
+
1006
+
1007
+
1008
+
1009
+
1010
+
1011
+
1012
+ <li class="md-nav__item">
1013
+ <a href="../config-store/" class="md-nav__link">
1014
+ config-store
1015
+ </a>
1016
+ </li>
1017
+
1018
+
1019
+
1020
+
1021
+
1022
+
1023
+
1024
+ <li class="md-nav__item">
1025
+ <a href="../config-store/configuration/" class="md-nav__link">
1026
+ configuration
1027
+ </a>
1028
+ </li>
1029
+
1030
+
1031
+
1032
+
1033
+
1034
+
1035
+
1036
+ <li class="md-nav__item">
1037
+ <a href="../config-store/providers/" class="md-nav__link">
1038
+ providers
1039
+ </a>
1040
+ </li>
1041
+
1042
+
1043
+ </ul>
1044
+ </nav>
1045
+ </li>
1046
+
1047
+
1048
+
1049
+
1050
+
1051
+
1052
+
1053
+ <li class="md-nav__item md-nav__item--nested">
1054
+
1055
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-6-4" type="checkbox" id="nav-6-4">
1056
+
1057
+ <label class="md-nav__link" for="nav-6-4">
1058
+ graph
1059
+ <span class="md-nav__icon md-icon"></span>
1060
+ </label>
1061
+ <nav class="md-nav" aria-label="graph" data-md-level="2">
1062
+ <label class="md-nav__title" for="nav-6-4">
1063
+ <span class="md-nav__icon md-icon"></span>
1064
+ graph
1065
+ </label>
1066
+ <ul class="md-nav__list" data-md-scrollfix>
1067
+
1068
+
1069
+
1070
+
1071
+
1072
+
1073
+
1074
+ <li class="md-nav__item">
1075
+ <a href="../graph/" class="md-nav__link">
1076
+ graph
1077
+ </a>
1078
+ </li>
1079
+
1080
+
1081
+
1082
+
1083
+
1084
+
1085
+
1086
+ <li class="md-nav__item">
1087
+ <a href="../graph/groups/" class="md-nav__link">
1088
+ groups
1089
+ </a>
1090
+ </li>
1091
+
1092
+
1093
+
1094
+
1095
+
1096
+
1097
+
1098
+ <li class="md-nav__item">
1099
+ <a href="../graph/insights/" class="md-nav__link">
1100
+ insights
1101
+ </a>
1102
+ </li>
1103
+
1104
+
1105
+
1106
+
1107
+
1108
+
1109
+
1110
+ <li class="md-nav__item">
1111
+ <a href="../graph/contacts/" class="md-nav__link">
1112
+ contacts
1113
+ </a>
1114
+ </li>
1115
+
1116
+
1117
+
1118
+
1119
+
1120
+
1121
+
1122
+ <li class="md-nav__item">
1123
+ <a href="../graph/calendars/" class="md-nav__link">
1124
+ calendars
1125
+ </a>
1126
+ </li>
1127
+
1128
+
1129
+
1130
+
1131
+
1132
+
1133
+
1134
+ <li class="md-nav__item">
1135
+ <a href="../graph/directoryobjects/" class="md-nav__link">
1136
+ directory objects
1137
+ </a>
1138
+ </li>
1139
+
1140
+
1141
+
1142
+
1143
+
1144
+
1145
+
1146
+ <li class="md-nav__item">
1147
+ <a href="../graph/invitations/" class="md-nav__link">
1148
+ invitations
1149
+ </a>
1150
+ </li>
1151
+
1152
+
1153
+
1154
+
1155
+
1156
+
1157
+
1158
+ <li class="md-nav__item">
1159
+ <a href="../graph/onedrive/" class="md-nav__link">
1160
+ onedrive
1161
+ </a>
1162
+ </li>
1163
+
1164
+
1165
+
1166
+
1167
+
1168
+
1169
+
1170
+ <li class="md-nav__item">
1171
+ <a href="../graph/outlook/" class="md-nav__link">
1172
+ outlook
1173
+ </a>
1174
+ </li>
1175
+
1176
+
1177
+
1178
+
1179
+
1180
+
1181
+
1182
+ <li class="md-nav__item">
1183
+ <a href="../graph/photos/" class="md-nav__link">
1184
+ photos
1185
+ </a>
1186
+ </li>
1187
+
1188
+
1189
+
1190
+
1191
+
1192
+
1193
+
1194
+ <li class="md-nav__item">
1195
+ <a href="../graph/planner/" class="md-nav__link">
1196
+ planner
1197
+ </a>
1198
+ </li>
1199
+
1200
+
1201
+
1202
+
1203
+
1204
+
1205
+
1206
+ <li class="md-nav__item">
1207
+ <a href="../graph/search/" class="md-nav__link">
1208
+ search
1209
+ </a>
1210
+ </li>
1211
+
1212
+
1213
+
1214
+
1215
+
1216
+
1217
+
1218
+ <li class="md-nav__item">
1219
+ <a href="../graph/subscriptions/" class="md-nav__link">
1220
+ subscriptions
1221
+ </a>
1222
+ </li>
1223
+
1224
+
1225
+
1226
+
1227
+
1228
+
1229
+
1230
+ <li class="md-nav__item">
1231
+ <a href="../graph/teams/" class="md-nav__link">
1232
+ teams
1233
+ </a>
1234
+ </li>
1235
+
1236
+
1237
+
1238
+
1239
+
1240
+
1241
+
1242
+ <li class="md-nav__item">
1243
+ <a href="../graph/users/" class="md-nav__link">
1244
+ users
1245
+ </a>
1246
+ </li>
1247
+
1248
+
1249
+ </ul>
1250
+ </nav>
1251
+ </li>
1252
+
1253
+
1254
+
1255
+
1256
+
1257
+
1258
+
1259
+ <li class="md-nav__item">
1260
+ <a href="../logging/" class="md-nav__link">
1261
+ logging
1262
+ </a>
1263
+ </li>
1264
+
1265
+
1266
+
1267
+
1268
+
1269
+
1270
+
1271
+ <li class="md-nav__item md-nav__item--nested">
1272
+
1273
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-6-6" type="checkbox" id="nav-6-6">
1274
+
1275
+ <label class="md-nav__link" for="nav-6-6">
1276
+ nodejs
1277
+ <span class="md-nav__icon md-icon"></span>
1278
+ </label>
1279
+ <nav class="md-nav" aria-label="nodejs" data-md-level="2">
1280
+ <label class="md-nav__title" for="nav-6-6">
1281
+ <span class="md-nav__icon md-icon"></span>
1282
+ nodejs
1283
+ </label>
1284
+ <ul class="md-nav__list" data-md-scrollfix>
1285
+
1286
+
1287
+
1288
+
1289
+
1290
+
1291
+
1292
+ <li class="md-nav__item">
1293
+ <a href="../nodejs/" class="md-nav__link">
1294
+ nodejs
1295
+ </a>
1296
+ </li>
1297
+
1298
+
1299
+
1300
+
1301
+
1302
+
1303
+
1304
+ <li class="md-nav__item">
1305
+ <a href="../nodejs/sp-fetch-client/" class="md-nav__link">
1306
+ SPFetchClient
1307
+ </a>
1308
+ </li>
1309
+
1310
+
1311
+
1312
+
1313
+
1314
+
1315
+
1316
+ <li class="md-nav__item">
1317
+ <a href="../nodejs/adal-fetch-client/" class="md-nav__link">
1318
+ AdalFetchClient
1319
+ </a>
1320
+ </li>
1321
+
1322
+
1323
+
1324
+
1325
+
1326
+
1327
+
1328
+ <li class="md-nav__item">
1329
+ <a href="../nodejs/bearer-token-fetch-client/" class="md-nav__link">
1330
+ BearerTokenFetchClient
1331
+ </a>
1332
+ </li>
1333
+
1334
+
1335
+
1336
+
1337
+
1338
+
1339
+
1340
+ <li class="md-nav__item">
1341
+ <a href="../nodejs/provider-hosted-app/" class="md-nav__link">
1342
+ ProviderHostedRequestContext
1343
+ </a>
1344
+ </li>
1345
+
1346
+
1347
+
1348
+
1349
+
1350
+
1351
+
1352
+ <li class="md-nav__item">
1353
+ <a href="../nodejs/sp-extensions/" class="md-nav__link">
1354
+ sp Extensions
1355
+ </a>
1356
+ </li>
1357
+
1358
+
1359
+
1360
+
1361
+
1362
+
1363
+
1364
+ <li class="md-nav__item">
1365
+ <a href="../nodejs/proxy/" class="md-nav__link">
1366
+ proxy
1367
+ </a>
1368
+ </li>
1369
+
1370
+
1371
+ </ul>
1372
+ </nav>
1373
+ </li>
1374
+
1375
+
1376
+
1377
+
1378
+
1379
+
1380
+
1381
+ <li class="md-nav__item md-nav__item--nested">
1382
+
1383
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-6-7" type="checkbox" id="nav-6-7">
1384
+
1385
+ <label class="md-nav__link" for="nav-6-7">
1386
+ odata
1387
+ <span class="md-nav__icon md-icon"></span>
1388
+ </label>
1389
+ <nav class="md-nav" aria-label="odata" data-md-level="2">
1390
+ <label class="md-nav__title" for="nav-6-7">
1391
+ <span class="md-nav__icon md-icon"></span>
1392
+ odata
1393
+ </label>
1394
+ <ul class="md-nav__list" data-md-scrollfix>
1395
+
1396
+
1397
+
1398
+
1399
+
1400
+
1401
+
1402
+ <li class="md-nav__item">
1403
+ <a href="../odata/" class="md-nav__link">
1404
+ odata
1405
+ </a>
1406
+ </li>
1407
+
1408
+
1409
+
1410
+
1411
+
1412
+
1413
+
1414
+ <li class="md-nav__item">
1415
+ <a href="../odata/caching/" class="md-nav__link">
1416
+ caching
1417
+ </a>
1418
+ </li>
1419
+
1420
+
1421
+
1422
+
1423
+
1424
+
1425
+
1426
+ <li class="md-nav__item">
1427
+ <a href="../odata/core/" class="md-nav__link">
1428
+ core
1429
+ </a>
1430
+ </li>
1431
+
1432
+
1433
+
1434
+
1435
+
1436
+
1437
+
1438
+ <li class="md-nav__item">
1439
+ <a href="../odata/odata-batch/" class="md-nav__link">
1440
+ OData Batching
1441
+ </a>
1442
+ </li>
1443
+
1444
+
1445
+
1446
+
1447
+
1448
+
1449
+
1450
+ <li class="md-nav__item">
1451
+ <a href="../odata/extensions/" class="md-nav__link">
1452
+ Extending an OData library
1453
+ </a>
1454
+ </li>
1455
+
1456
+
1457
+
1458
+
1459
+
1460
+
1461
+
1462
+ <li class="md-nav__item">
1463
+ <a href="../odata/debug/" class="md-nav__link">
1464
+ Debugging Proxy Objects
1465
+ </a>
1466
+ </li>
1467
+
1468
+
1469
+
1470
+
1471
+
1472
+
1473
+
1474
+ <li class="md-nav__item">
1475
+ <a href="../odata/parsers/" class="md-nav__link">
1476
+ Parsers
1477
+ </a>
1478
+ </li>
1479
+
1480
+
1481
+
1482
+
1483
+
1484
+
1485
+
1486
+ <li class="md-nav__item">
1487
+ <a href="../odata/pipeline/" class="md-nav__link">
1488
+ Pipeline
1489
+ </a>
1490
+ </li>
1491
+
1492
+
1493
+
1494
+
1495
+
1496
+
1497
+
1498
+ <li class="md-nav__item">
1499
+ <a href="../odata/queryable/" class="md-nav__link">
1500
+ Queryable
1501
+ </a>
1502
+ </li>
1503
+
1504
+
1505
+ </ul>
1506
+ </nav>
1507
+ </li>
1508
+
1509
+
1510
+
1511
+
1512
+
1513
+
1514
+
1515
+ <li class="md-nav__item md-nav__item--nested">
1516
+
1517
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-6-8" type="checkbox" id="nav-6-8">
1518
+
1519
+ <label class="md-nav__link" for="nav-6-8">
1520
+ pnpjs
1521
+ <span class="md-nav__icon md-icon"></span>
1522
+ </label>
1523
+ <nav class="md-nav" aria-label="pnpjs" data-md-level="2">
1524
+ <label class="md-nav__title" for="nav-6-8">
1525
+ <span class="md-nav__icon md-icon"></span>
1526
+ pnpjs
1527
+ </label>
1528
+ <ul class="md-nav__list" data-md-scrollfix>
1529
+
1530
+
1531
+
1532
+
1533
+
1534
+
1535
+
1536
+ <li class="md-nav__item">
1537
+ <a href="../pnpjs/" class="md-nav__link">
1538
+ pnpjs
1539
+ </a>
1540
+ </li>
1541
+
1542
+
1543
+ </ul>
1544
+ </nav>
1545
+ </li>
1546
+
1547
+
1548
+
1549
+
1550
+
1551
+
1552
+
1553
+ <li class="md-nav__item md-nav__item--nested">
1554
+
1555
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-6-9" type="checkbox" id="nav-6-9">
1556
+
1557
+ <label class="md-nav__link" for="nav-6-9">
1558
+ sp
1559
+ <span class="md-nav__icon md-icon"></span>
1560
+ </label>
1561
+ <nav class="md-nav" aria-label="sp" data-md-level="2">
1562
+ <label class="md-nav__title" for="nav-6-9">
1563
+ <span class="md-nav__icon md-icon"></span>
1564
+ sp
1565
+ </label>
1566
+ <ul class="md-nav__list" data-md-scrollfix>
1567
+
1568
+
1569
+
1570
+
1571
+
1572
+
1573
+
1574
+ <li class="md-nav__item">
1575
+ <a href="../sp/" class="md-nav__link">
1576
+ sp
1577
+ </a>
1578
+ </li>
1579
+
1580
+
1581
+
1582
+
1583
+
1584
+
1585
+
1586
+ <li class="md-nav__item">
1587
+ <a href="../sp/alias-parameters/" class="md-nav__link">
1588
+ Alias Parameters
1589
+ </a>
1590
+ </li>
1591
+
1592
+
1593
+
1594
+
1595
+
1596
+
1597
+
1598
+ <li class="md-nav__item">
1599
+ <a href="../sp/alm/" class="md-nav__link">
1600
+ ALM api
1601
+ </a>
1602
+ </li>
1603
+
1604
+
1605
+
1606
+
1607
+
1608
+
1609
+
1610
+ <li class="md-nav__item">
1611
+ <a href="../sp/attachments/" class="md-nav__link">
1612
+ Attachments
1613
+ </a>
1614
+ </li>
1615
+
1616
+
1617
+
1618
+
1619
+
1620
+
1621
+
1622
+ <li class="md-nav__item">
1623
+ <a href="../sp/clientside-pages/" class="md-nav__link">
1624
+ Client-side Pages
1625
+ </a>
1626
+ </li>
1627
+
1628
+
1629
+
1630
+
1631
+
1632
+
1633
+
1634
+ <li class="md-nav__item">
1635
+ <a href="../sp/column-defaults/" class="md-nav__link">
1636
+ Column Defaults
1637
+ </a>
1638
+ </li>
1639
+
1640
+
1641
+
1642
+
1643
+
1644
+
1645
+
1646
+ <li class="md-nav__item">
1647
+ <a href="../sp/comments-likes/" class="md-nav__link">
1648
+ Comments and Likes
1649
+ </a>
1650
+ </li>
1651
+
1652
+
1653
+
1654
+
1655
+
1656
+
1657
+
1658
+ <li class="md-nav__item">
1659
+ <a href="../sp/content-types/" class="md-nav__link">
1660
+ Content Types
1661
+ </a>
1662
+ </li>
1663
+
1664
+
1665
+
1666
+
1667
+
1668
+
1669
+
1670
+ <li class="md-nav__item">
1671
+ <a href="../sp/entity-merging/" class="md-nav__link">
1672
+ Entity Merging
1673
+ </a>
1674
+ </li>
1675
+
1676
+
1677
+
1678
+
1679
+
1680
+
1681
+
1682
+ <li class="md-nav__item">
1683
+ <a href="../sp/features/" class="md-nav__link">
1684
+ Features
1685
+ </a>
1686
+ </li>
1687
+
1688
+
1689
+
1690
+
1691
+
1692
+
1693
+
1694
+ <li class="md-nav__item">
1695
+ <a href="../sp/fields/" class="md-nav__link">
1696
+ Fields
1697
+ </a>
1698
+ </li>
1699
+
1700
+
1701
+
1702
+
1703
+
1704
+
1705
+
1706
+ <li class="md-nav__item">
1707
+ <a href="../sp/files/" class="md-nav__link">
1708
+ Files
1709
+ </a>
1710
+ </li>
1711
+
1712
+
1713
+
1714
+
1715
+
1716
+
1717
+
1718
+ <li class="md-nav__item">
1719
+ <a href="../sp/folders/" class="md-nav__link">
1720
+ Folders
1721
+ </a>
1722
+ </li>
1723
+
1724
+
1725
+
1726
+
1727
+
1728
+
1729
+
1730
+ <li class="md-nav__item">
1731
+ <a href="../sp/forms/" class="md-nav__link">
1732
+ Forms
1733
+ </a>
1734
+ </li>
1735
+
1736
+
1737
+
1738
+
1739
+
1740
+
1741
+
1742
+ <li class="md-nav__item">
1743
+ <a href="../sp/hubsites/" class="md-nav__link">
1744
+ Hubsites
1745
+ </a>
1746
+ </li>
1747
+
1748
+
1749
+
1750
+
1751
+
1752
+
1753
+
1754
+ <li class="md-nav__item">
1755
+ <a href="../sp/items/" class="md-nav__link">
1756
+ List Items
1757
+ </a>
1758
+ </li>
1759
+
1760
+
1761
+
1762
+
1763
+
1764
+
1765
+
1766
+ <li class="md-nav__item">
1767
+ <a href="../sp/lists/" class="md-nav__link">
1768
+ Lists
1769
+ </a>
1770
+ </li>
1771
+
1772
+
1773
+
1774
+
1775
+
1776
+
1777
+
1778
+ <li class="md-nav__item">
1779
+ <a href="../sp/navigation/" class="md-nav__link">
1780
+ Navigation
1781
+ </a>
1782
+ </li>
1783
+
1784
+
1785
+
1786
+
1787
+
1788
+
1789
+
1790
+ <li class="md-nav__item">
1791
+ <a href="../sp/permissions/" class="md-nav__link">
1792
+ Permissions
1793
+ </a>
1794
+ </li>
1795
+
1796
+
1797
+
1798
+
1799
+
1800
+
1801
+
1802
+ <li class="md-nav__item">
1803
+ <a href="../sp/profiles/" class="md-nav__link">
1804
+ Profiles
1805
+ </a>
1806
+ </li>
1807
+
1808
+
1809
+
1810
+
1811
+
1812
+
1813
+
1814
+ <li class="md-nav__item">
1815
+ <a href="../sp/regional-settings/" class="md-nav__link">
1816
+ Regional Settings
1817
+ </a>
1818
+ </li>
1819
+
1820
+
1821
+
1822
+
1823
+
1824
+
1825
+
1826
+ <li class="md-nav__item">
1827
+ <a href="../sp/related-items/" class="md-nav__link">
1828
+ Related Items
1829
+ </a>
1830
+ </li>
1831
+
1832
+
1833
+
1834
+
1835
+
1836
+
1837
+
1838
+ <li class="md-nav__item">
1839
+ <a href="../sp/search/" class="md-nav__link">
1840
+ Search
1841
+ </a>
1842
+ </li>
1843
+
1844
+
1845
+
1846
+
1847
+
1848
+
1849
+
1850
+ <li class="md-nav__item">
1851
+ <a href="../sp/security/" class="md-nav__link">
1852
+ Security
1853
+ </a>
1854
+ </li>
1855
+
1856
+
1857
+
1858
+
1859
+
1860
+
1861
+
1862
+ <li class="md-nav__item">
1863
+ <a href="../sp/sharing/" class="md-nav__link">
1864
+ Sharing
1865
+ </a>
1866
+ </li>
1867
+
1868
+
1869
+
1870
+
1871
+
1872
+
1873
+
1874
+ <li class="md-nav__item">
1875
+ <a href="../sp/site-designs/" class="md-nav__link">
1876
+ Site Designs
1877
+ </a>
1878
+ </li>
1879
+
1880
+
1881
+
1882
+
1883
+
1884
+
1885
+
1886
+ <li class="md-nav__item">
1887
+ <a href="../sp/site-groups/" class="md-nav__link">
1888
+ Site Groups
1889
+ </a>
1890
+ </li>
1891
+
1892
+
1893
+
1894
+
1895
+
1896
+
1897
+
1898
+ <li class="md-nav__item">
1899
+ <a href="../sp/site-scripts/" class="md-nav__link">
1900
+ Site Scripts
1901
+ </a>
1902
+ </li>
1903
+
1904
+
1905
+
1906
+
1907
+
1908
+
1909
+
1910
+ <li class="md-nav__item">
1911
+ <a href="../sp/site-users/" class="md-nav__link">
1912
+ Site Users
1913
+ </a>
1914
+ </li>
1915
+
1916
+
1917
+
1918
+
1919
+
1920
+
1921
+
1922
+ <li class="md-nav__item">
1923
+ <a href="../sp/sites/" class="md-nav__link">
1924
+ Sites
1925
+ </a>
1926
+ </li>
1927
+
1928
+
1929
+
1930
+
1931
+
1932
+
1933
+
1934
+ <li class="md-nav__item">
1935
+ <a href="../sp/social/" class="md-nav__link">
1936
+ Social
1937
+ </a>
1938
+ </li>
1939
+
1940
+
1941
+
1942
+
1943
+
1944
+
1945
+
1946
+ <li class="md-nav__item">
1947
+ <a href="../sp/sp-utilities-utility/" class="md-nav__link">
1948
+ SP.Utilities.Utility
1949
+ </a>
1950
+ </li>
1951
+
1952
+
1953
+
1954
+
1955
+
1956
+
1957
+
1958
+ <li class="md-nav__item">
1959
+ <a href="../sp/subscriptions/" class="md-nav__link">
1960
+ Subscriptions
1961
+ </a>
1962
+ </li>
1963
+
1964
+
1965
+
1966
+
1967
+
1968
+
1969
+
1970
+ <li class="md-nav__item">
1971
+ <a href="../sp/taxonomy/" class="md-nav__link">
1972
+ Taxonomy
1973
+ </a>
1974
+ </li>
1975
+
1976
+
1977
+
1978
+
1979
+
1980
+
1981
+
1982
+ <li class="md-nav__item">
1983
+ <a href="../sp/tenant-properties/" class="md-nav__link">
1984
+ Tenant Properties
1985
+ </a>
1986
+ </li>
1987
+
1988
+
1989
+
1990
+
1991
+
1992
+
1993
+
1994
+ <li class="md-nav__item">
1995
+ <a href="../sp/user-custom-actions/" class="md-nav__link">
1996
+ User custom actions
1997
+ </a>
1998
+ </li>
1999
+
2000
+
2001
+
2002
+
2003
+
2004
+
2005
+
2006
+ <li class="md-nav__item">
2007
+ <a href="../sp/views/" class="md-nav__link">
2008
+ Views
2009
+ </a>
2010
+ </li>
2011
+
2012
+
2013
+
2014
+
2015
+
2016
+
2017
+
2018
+ <li class="md-nav__item">
2019
+ <a href="../sp/webs/" class="md-nav__link">
2020
+ Webs
2021
+ </a>
2022
+ </li>
2023
+
2024
+
2025
+
2026
+
2027
+
2028
+
2029
+
2030
+ <li class="md-nav__item">
2031
+ <a href="../sp/custom-irequestclient/" class="md-nav__link">
2032
+ Custom Request Client
2033
+ </a>
2034
+ </li>
2035
+
2036
+
2037
+ </ul>
2038
+ </nav>
2039
+ </li>
2040
+
2041
+
2042
+
2043
+
2044
+
2045
+
2046
+
2047
+ <li class="md-nav__item md-nav__item--nested">
2048
+
2049
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-6-10" type="checkbox" id="nav-6-10">
2050
+
2051
+ <label class="md-nav__link" for="nav-6-10">
2052
+ sp-addinhelpers
2053
+ <span class="md-nav__icon md-icon"></span>
2054
+ </label>
2055
+ <nav class="md-nav" aria-label="sp-addinhelpers" data-md-level="2">
2056
+ <label class="md-nav__title" for="nav-6-10">
2057
+ <span class="md-nav__icon md-icon"></span>
2058
+ sp-addinhelpers
2059
+ </label>
2060
+ <ul class="md-nav__list" data-md-scrollfix>
2061
+
2062
+
2063
+
2064
+
2065
+
2066
+
2067
+
2068
+ <li class="md-nav__item">
2069
+ <a href="../sp-addinhelpers/" class="md-nav__link">
2070
+ sp-addinhelpers
2071
+ </a>
2072
+ </li>
2073
+
2074
+
2075
+
2076
+
2077
+
2078
+
2079
+
2080
+ <li class="md-nav__item">
2081
+ <a href="../sp-addinhelpers/sp-request-executor-client/" class="md-nav__link">
2082
+ SPRequestExecutorClient
2083
+ </a>
2084
+ </li>
2085
+
2086
+
2087
+
2088
+
2089
+
2090
+
2091
+
2092
+ <li class="md-nav__item">
2093
+ <a href="../sp-addinhelpers/sp-rest-addin/" class="md-nav__link">
2094
+ SPRestAddIn
2095
+ </a>
2096
+ </li>
2097
+
2098
+
2099
+ </ul>
2100
+ </nav>
2101
+ </li>
2102
+
2103
+
2104
+ </ul>
2105
+ </nav>
2106
+ </li>
2107
+
2108
+
2109
+
2110
+
2111
+
2112
+
2113
+
2114
+ <li class="md-nav__item md-nav__item--nested">
2115
+
2116
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7">
2117
+
2118
+ <label class="md-nav__link" for="nav-7">
2119
+ Contributing
2120
+ <span class="md-nav__icon md-icon"></span>
2121
+ </label>
2122
+ <nav class="md-nav" aria-label="Contributing" data-md-level="1">
2123
+ <label class="md-nav__title" for="nav-7">
2124
+ <span class="md-nav__icon md-icon"></span>
2125
+ Contributing
2126
+ </label>
2127
+ <ul class="md-nav__list" data-md-scrollfix>
2128
+
2129
+
2130
+
2131
+
2132
+
2133
+
2134
+
2135
+ <li class="md-nav__item">
2136
+ <a href="../contributing/" class="md-nav__link">
2137
+ Contributing
2138
+ </a>
2139
+ </li>
2140
+
2141
+
2142
+
2143
+
2144
+
2145
+
2146
+
2147
+ <li class="md-nav__item">
2148
+ <a href="../contributing/setup-dev-machine/" class="md-nav__link">
2149
+ Setup Dev Machine
2150
+ </a>
2151
+ </li>
2152
+
2153
+
2154
+
2155
+
2156
+
2157
+
2158
+
2159
+ <li class="md-nav__item">
2160
+ <a href="../contributing/local-debug-configuration/" class="md-nav__link">
2161
+ Local Debug Configuration
2162
+ </a>
2163
+ </li>
2164
+
2165
+
2166
+
2167
+
2168
+
2169
+
2170
+
2171
+ <li class="md-nav__item">
2172
+ <a href="../contributing/debugging/" class="md-nav__link">
2173
+ Debugging
2174
+ </a>
2175
+ </li>
2176
+
2177
+
2178
+
2179
+
2180
+
2181
+
2182
+
2183
+ <li class="md-nav__item">
2184
+ <a href="../contributing/extending-the-library/" class="md-nav__link">
2185
+ Extending the library
2186
+ </a>
2187
+ </li>
2188
+
2189
+
2190
+
2191
+
2192
+
2193
+
2194
+
2195
+ <li class="md-nav__item">
2196
+ <a href="../contributing/debug-tests/" class="md-nav__link">
2197
+ Writing Tests
2198
+ </a>
2199
+ </li>
2200
+
2201
+
2202
+
2203
+
2204
+
2205
+
2206
+
2207
+ <li class="md-nav__item">
2208
+ <a href="../contributing/documentation/" class="md-nav__link">
2209
+ Update Documentation
2210
+ </a>
2211
+ </li>
2212
+
2213
+
2214
+
2215
+
2216
+
2217
+
2218
+
2219
+ <li class="md-nav__item">
2220
+ <a href="../contributing/pull-requests/" class="md-nav__link">
2221
+ Submit a Pull Request
2222
+ </a>
2223
+ </li>
2224
+
2225
+
2226
+ </ul>
2227
+ </nav>
2228
+ </li>
2229
+
2230
+
2231
+
2232
+
2233
+
2234
+
2235
+
2236
+ <li class="md-nav__item md-nav__item--nested">
2237
+
2238
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8">
2239
+
2240
+ <label class="md-nav__link" for="nav-8">
2241
+ Version 1 Docs
2242
+ <span class="md-nav__icon md-icon"></span>
2243
+ </label>
2244
+ <nav class="md-nav" aria-label="Version 1 Docs" data-md-level="1">
2245
+ <label class="md-nav__title" for="nav-8">
2246
+ <span class="md-nav__icon md-icon"></span>
2247
+ Version 1 Docs
2248
+ </label>
2249
+ <ul class="md-nav__list" data-md-scrollfix>
2250
+
2251
+
2252
+
2253
+
2254
+
2255
+
2256
+
2257
+ <li class="md-nav__item">
2258
+ <a href="../v1/" class="md-nav__link">
2259
+ Home
2260
+ </a>
2261
+ </li>
2262
+
2263
+
2264
+ </ul>
2265
+ </nav>
2266
+ </li>
2267
+
2268
+
2269
+
2270
+
2271
+
2272
+
2273
+
2274
+ <li class="md-nav__item md-nav__item--nested">
2275
+
2276
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9">
2277
+
2278
+ <label class="md-nav__link" for="nav-9">
2279
+ Version 2 Docs
2280
+ <span class="md-nav__icon md-icon"></span>
2281
+ </label>
2282
+ <nav class="md-nav" aria-label="Version 2 Docs" data-md-level="1">
2283
+ <label class="md-nav__title" for="nav-9">
2284
+ <span class="md-nav__icon md-icon"></span>
2285
+ Version 2 Docs
2286
+ </label>
2287
+ <ul class="md-nav__list" data-md-scrollfix>
2288
+
2289
+
2290
+
2291
+
2292
+
2293
+
2294
+
2295
+ <li class="md-nav__item">
2296
+ <a href="../v2/index.html" class="md-nav__link">
2297
+ Home
2298
+ </a>
2299
+ </li>
2300
+
2301
+
2302
+ </ul>
2303
+ </nav>
2304
+ </li>
2305
+
2306
+
2307
+ </ul>
2308
+ </nav>
2309
+ </div>
2310
+ </div>
2311
+ </div>
2312
+
2313
+
2314
+ <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
2315
+ <div class="md-sidebar__scrollwrap">
2316
+ <div class="md-sidebar__inner">
2317
+
2318
+ <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2319
+
2320
+
2321
+
2322
+
2323
+
2324
+ <label class="md-nav__title" for="__toc">
2325
+ <span class="md-nav__icon md-icon"></span>
2326
+ Table of contents
2327
+ </label>
2328
+ <ul class="md-nav__list" data-md-scrollfix>
2329
+
2330
+ <li class="md-nav__item">
2331
+ <a href="#install" class="md-nav__link">
2332
+ Install
2333
+ </a>
2334
+
2335
+ </li>
2336
+
2337
+ <li class="md-nav__item">
2338
+ <a href="#getting-started-with-sharepoint-framework" class="md-nav__link">
2339
+ Getting Started with SharePoint Framework
2340
+ </a>
2341
+
2342
+ <nav class="md-nav" aria-label="Getting Started with SharePoint Framework">
2343
+ <ul class="md-nav__list">
2344
+
2345
+ <li class="md-nav__item">
2346
+ <a href="#establish-context" class="md-nav__link">
2347
+ Establish Context
2348
+ </a>
2349
+
2350
+ <nav class="md-nav" aria-label="Establish Context">
2351
+ <ul class="md-nav__list">
2352
+
2353
+ <li class="md-nav__item">
2354
+ <a href="#using-pnpcore-setup" class="md-nav__link">
2355
+ Using @pnp/core setup
2356
+ </a>
2357
+
2358
+ </li>
2359
+
2360
+ <li class="md-nav__item">
2361
+ <a href="#using-pnpsp-setup" class="md-nav__link">
2362
+ Using @pnp/sp setup
2363
+ </a>
2364
+
2365
+ </li>
2366
+
2367
+ <li class="md-nav__item">
2368
+ <a href="#using-pnpgraph-setup" class="md-nav__link">
2369
+ Using @pnp/graph setup
2370
+ </a>
2371
+
2372
+ </li>
2373
+
2374
+ <li class="md-nav__item">
2375
+ <a href="#establish-context-within-an-spfx-service" class="md-nav__link">
2376
+ Establish context within an SPFx service
2377
+ </a>
2378
+
2379
+ </li>
2380
+
2381
+ </ul>
2382
+ </nav>
2383
+
2384
+ </li>
2385
+
2386
+ </ul>
2387
+ </nav>
2388
+
2389
+ </li>
2390
+
2391
+ <li class="md-nav__item">
2392
+ <a href="#connect-to-sharepoint-from-node" class="md-nav__link">
2393
+ Connect to SharePoint from Node
2394
+ </a>
2395
+
2396
+ </li>
2397
+
2398
+ <li class="md-nav__item">
2399
+ <a href="#connect-to-microsoft-graph-from-node" class="md-nav__link">
2400
+ Connect to Microsoft Graph From Node
2401
+ </a>
2402
+
2403
+ </li>
2404
+
2405
+ <li class="md-nav__item">
2406
+ <a href="#getting-started-outside-sharepoint-framework" class="md-nav__link">
2407
+ Getting Started outside SharePoint Framework
2408
+ </a>
2409
+
2410
+ <nav class="md-nav" aria-label="Getting Started outside SharePoint Framework">
2411
+ <ul class="md-nav__list">
2412
+
2413
+ <li class="md-nav__item">
2414
+ <a href="#set-baseurl-through-setup" class="md-nav__link">
2415
+ Set baseUrl through setup
2416
+ </a>
2417
+
2418
+ </li>
2419
+
2420
+ <li class="md-nav__item">
2421
+ <a href="#create-web-instances-directly" class="md-nav__link">
2422
+ Create Web instances directly
2423
+ </a>
2424
+
2425
+ </li>
2426
+
2427
+ </ul>
2428
+ </nav>
2429
+
2430
+ </li>
2431
+
2432
+ <li class="md-nav__item">
2433
+ <a href="#next-steps" class="md-nav__link">
2434
+ Next Steps
2435
+ </a>
2436
+
2437
+ </li>
2438
+
2439
+ </ul>
2440
+
2441
+ </nav>
2442
+ </div>
2443
+ </div>
2444
+ </div>
2445
+
2446
+
2447
+ <div class="md-content">
2448
+ <article class="md-content__inner md-typeset">
2449
+
2450
+
2451
+ <a href="https://github.com/pnp/pnpjs/tree/version-2/docs/getting-started.md" title="Edit this page" class="md-content__button md-icon">
2452
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
2453
+ </a>
2454
+
2455
+
2456
+ <h1 id="getting-started">Getting Started<a class="headerlink" href="#getting-started" title="Permanent link">&para;</a></h1>
2457
+ <p>These libraries are geared towards folks working with TypeScript but will work equally well for JavaScript projects. To get started you need to install the libraries you need via npm. Many of the packages have a peer dependency to other packages with the @pnp namespace meaning you may need to install more than one package. All packages are released together eliminating version confusion - all packages will depend on packages with the same version number.</p>
2458
+ <p>If you need to support older browsers please review the article on <a href="../concepts/polyfill/">polyfills</a> for required functionality.</p>
2459
+ <h2 id="install">Install<a class="headerlink" href="#install" title="Permanent link">&para;</a></h2>
2460
+ <p>First you will need to install those libraries you want to use in your application. Here we will install the most frequently used packages. This step applies to any environment or project.</p>
2461
+ <p><code>npm install @pnp/sp @pnp/graph --save</code></p>
2462
+ <p>Next we can import and use the functionality within our application. Below is a very simple example, please see the individual package documentation
2463
+ for more details and examples.</p>
2464
+ <pre><code class="language-TypeScript">import { getRandomString } from &quot;@pnp/core&quot;;
2465
+
2466
+ (function() {
2467
+
2468
+ // get and log a random string
2469
+ console.log(getRandomString(20));
2470
+
2471
+ })()
2472
+ </code></pre>
2473
+ <h2 id="getting-started-with-sharepoint-framework">Getting Started with SharePoint Framework<a class="headerlink" href="#getting-started-with-sharepoint-framework" title="Permanent link">&para;</a></h2>
2474
+ <p>The @pnp/sp and @pnp/graph libraries are designed to work seamlessly within SharePoint Framework projects with a small amount of upfront configuration. If you are running in 2016 or 2019 on-premises please <a href="../SPFx-on-premises/">read this note</a> on a workaround for the included TypeScript version. If you are targeting SharePoint online you do not need to take any additional steps.</p>
2475
+ <h3 id="establish-context">Establish Context<a class="headerlink" href="#establish-context" title="Permanent link">&para;</a></h3>
2476
+ <p>Because SharePoint Framework provides a local context to each component we need to set that context within the library. This allows us to determine request urls as well as use the SPFx HttpGraphClient within @pnp/graph. There are two ways to provide the SPFx context to the library. Either through the setup method imported from @pnp/core or using the setup method on either the @pnp/sp or @pnp/graph main export. All three are shown below and are equivalent, meaning if you are already importing the sp variable from @pnp/sp or the graph variable from @pnp/graph you should use their setup method to reduce imports.</p>
2477
+ <p>The setup is always done in the onInit method to ensure it runs before your other life-cycle code. You can also set any other settings at this time.</p>
2478
+ <h4 id="using-pnpcore-setup">Using @pnp/core setup<a class="headerlink" href="#using-pnpcore-setup" title="Permanent link">&para;</a></h4>
2479
+ <pre><code class="language-TypeScript">import { setup as pnpSetup } from &quot;@pnp/core&quot;;
2480
+
2481
+ // ...
2482
+
2483
+ protected onInit(): Promise&lt;void&gt; {
2484
+
2485
+ return super.onInit().then(_ =&gt; {
2486
+
2487
+ // other init code may be present
2488
+
2489
+ pnpSetup({
2490
+ spfxContext: this.context
2491
+ });
2492
+ });
2493
+ }
2494
+
2495
+ // ...
2496
+
2497
+ </code></pre>
2498
+ <h4 id="using-pnpsp-setup">Using @pnp/sp setup<a class="headerlink" href="#using-pnpsp-setup" title="Permanent link">&para;</a></h4>
2499
+ <pre><code class="language-TypeScript">import { sp } from &quot;@pnp/sp/presets/all&quot;;
2500
+
2501
+ // ...
2502
+
2503
+ protected onInit(): Promise&lt;void&gt; {
2504
+
2505
+ return super.onInit().then(_ =&gt; {
2506
+
2507
+ // other init code may be present
2508
+
2509
+ sp.setup({
2510
+ spfxContext: this.context
2511
+ });
2512
+ });
2513
+ }
2514
+
2515
+ // ...
2516
+
2517
+ </code></pre>
2518
+ <p>Sp setup also supports passing just the SPFx context object directly as this is the most common case</p>
2519
+ <pre><code class="language-TypeScript">import { sp } from &quot;@pnp/sp/presets/all&quot;;
2520
+
2521
+ // ...
2522
+
2523
+ protected async onInit(): Promise&lt;void&gt; {
2524
+
2525
+ await super.onInit();
2526
+
2527
+ // other init code may be present
2528
+
2529
+ sp.setup(this.context);
2530
+ }
2531
+
2532
+ // ...
2533
+
2534
+ </code></pre>
2535
+ <h4 id="using-pnpgraph-setup">Using @pnp/graph setup<a class="headerlink" href="#using-pnpgraph-setup" title="Permanent link">&para;</a></h4>
2536
+ <pre><code class="language-TypeScript">import { graph } from &quot;@pnp/graph/presets/all&quot;;
2537
+
2538
+ // ...
2539
+
2540
+ protected onInit(): Promise&lt;void&gt; {
2541
+
2542
+ return super.onInit().then(_ =&gt; {
2543
+
2544
+ // other init code may be present
2545
+
2546
+ graph.setup({
2547
+ spfxContext: this.context
2548
+ });
2549
+ });
2550
+ }
2551
+
2552
+ // ...
2553
+
2554
+ </code></pre>
2555
+ <h4 id="establish-context-within-an-spfx-service">Establish context within an SPFx service<a class="headerlink" href="#establish-context-within-an-spfx-service" title="Permanent link">&para;</a></h4>
2556
+ <p>Because you do not have full access to the context object within a service you need to setup things a little differently. If you do not need AAD tokens you can leave that part out and specify just the pageContext.</p>
2557
+ <pre><code class="language-TypeScript">import { ServiceKey, ServiceScope } from &quot;@microsoft/sp-core-library&quot;;
2558
+ import { PageContext } from &quot;@microsoft/sp-page-context&quot;;
2559
+ import { AadTokenProviderFactory } from &quot;@microsoft/sp-http&quot;;
2560
+ import { sp } from &quot;@pnp/sp&quot;;
2561
+ import &quot;@pnp/sp/webs&quot;;
2562
+ import &quot;@pnp/sp/lists/web&quot;;
2563
+
2564
+ export interface ISampleService {
2565
+ getLists(): Promise&lt;any[]&gt;;
2566
+ }
2567
+
2568
+ export class SampleService {
2569
+
2570
+ public static readonly serviceKey: ServiceKey&lt;ISampleService&gt; = ServiceKey.create&lt;ISampleService&gt;('SPFx:SampleService', SampleService);
2571
+
2572
+ constructor(serviceScope: ServiceScope) {
2573
+
2574
+ serviceScope.whenFinished(() =&gt; {
2575
+
2576
+ const pageContext = serviceScope.consume(PageContext.serviceKey);
2577
+ const tokenProviderFactory = serviceScope.consume(AadTokenProviderFactory.serviceKey);
2578
+
2579
+ // we need to &quot;spoof&quot; the context object with the parts we need for PnPjs
2580
+ sp.setup({
2581
+ spfxContext: {
2582
+ aadTokenProviderFactory: tokenProviderFactory,
2583
+ pageContext: pageContext,
2584
+ }
2585
+ });
2586
+
2587
+ // This approach also works if you do not require AAD tokens
2588
+ // you don't need to do both
2589
+ // sp.setup({
2590
+ // sp : {
2591
+ // baseUrl : pageContext.web.absoluteUrl
2592
+ // }
2593
+ // });
2594
+ });
2595
+ }
2596
+ public getLists(): Promise&lt;any[]&gt; {
2597
+ return sp.web.lists();
2598
+ }
2599
+ }
2600
+ </code></pre>
2601
+ <h2 id="connect-to-sharepoint-from-node">Connect to SharePoint from Node<a class="headerlink" href="#connect-to-sharepoint-from-node" title="Permanent link">&para;</a></h2>
2602
+ <blockquote>
2603
+ <p>Please see the <a href="../nodejs">main article on how we support node versions</a> that require commonjs modules.</p>
2604
+ </blockquote>
2605
+ <p><code>npm i @pnp/sp-commonjs @pnp/nodejs-commonjs</code></p>
2606
+ <p>This will install the logging, common, odata, sp, and nodejs packages. You can read more about what each package does starting on the <a href="../packages/">packages</a> page.
2607
+ Once these are installed you need to import them into your project, to communicate with SharePoint from node we'll need the following imports:</p>
2608
+ <pre><code class="language-TypeScript">import { sp } from &quot;@pnp/sp-commonjs&quot;;
2609
+ import { SPFetchClient } from &quot;@pnp/nodejs-commonjs&quot;;
2610
+ </code></pre>
2611
+ <p>Once you have imported the necessary resources you can update your code to setup the node fetch client as well as make a call to SharePoint.</p>
2612
+ <pre><code class="language-TypeScript">// configure your node options (only once in your application)
2613
+ sp.setup({
2614
+ sp: {
2615
+ fetchClientFactory: () =&gt; {
2616
+ return new SPFetchClient(&quot;{site url}&quot;, &quot;{client id}&quot;, &quot;{client secret}&quot;);
2617
+ },
2618
+ },
2619
+ });
2620
+
2621
+ // make a call to SharePoint and log it in the console
2622
+ sp.web.select(&quot;Title&quot;, &quot;Description&quot;)().then(w =&gt; {
2623
+ console.log(JSON.stringify(w, null, 4));
2624
+ });
2625
+ </code></pre>
2626
+ <h2 id="connect-to-microsoft-graph-from-node">Connect to Microsoft Graph From Node<a class="headerlink" href="#connect-to-microsoft-graph-from-node" title="Permanent link">&para;</a></h2>
2627
+ <p>Similar to the above you can also make calls to the Graph api from node using the libraries. Again we start with installing the required resources. You can see
2628
+ <a href="https://github.com/pnp/pnpjs/blob/main/debug/launch/graph.ts">./debug/launch/graph.ts</a> for a live example.</p>
2629
+ <pre><code class="language-CMD">npm i @pnp/graph-commonjs @pnp/nodejs-commonjs
2630
+ </code></pre>
2631
+ <p>Now we need to import what we'll need to call graph</p>
2632
+ <pre><code class="language-TypeScript">import { graph } from &quot;@pnp/graph-commonjs&quot;;
2633
+ import { AdalFetchClient } from &quot;@pnp/nodejs-commonjs&quot;;
2634
+ </code></pre>
2635
+ <p>Now we can make our graph calls after setting up the Adal client. Note you'll need to setup an AzureAD App registration with the necessary permissions.</p>
2636
+ <pre><code class="language-TypeScript">graph.setup({
2637
+ graph: {
2638
+ fetchClientFactory: () =&gt; {
2639
+ return new AdalFetchClient(&quot;{mytenant}.onmicrosoft.com&quot;, &quot;{application id}&quot;, &quot;{application secret}&quot;);
2640
+ },
2641
+ },
2642
+ });
2643
+
2644
+ // make a call to Graph and get all the groups
2645
+ graph.groups().then(g =&gt; {
2646
+ console.log(JSON.stringify(g, null, 4));
2647
+ });
2648
+ </code></pre>
2649
+ <h2 id="getting-started-outside-sharepoint-framework">Getting Started outside SharePoint Framework<a class="headerlink" href="#getting-started-outside-sharepoint-framework" title="Permanent link">&para;</a></h2>
2650
+ <p>In some cases you may be working in a way such that we cannot determine the base url for the web. In this scenario you have two options.</p>
2651
+ <h3 id="set-baseurl-through-setup">Set baseUrl through setup<a class="headerlink" href="#set-baseurl-through-setup" title="Permanent link">&para;</a></h3>
2652
+ <p>Here we are setting the baseUrl via the sp.setup method. We are also setting the headers to use <code>verbose</code> mode, something you may have to do when
2653
+ working against unpatched versions of SharePoint 2013 as <a href="https://blogs.msdn.microsoft.com/patrickrodgers/2016/06/13/pnp-jscore-1-0-1/">discussed here</a>.
2654
+ This is optional for 2016 or SharePoint Online. The library does not support setting the headers to use <code>nometadata</code> as we rely on the metadata in the response to do some of the more complicated functions. Some of the pure data calls will probably work but it is not a supported configuration.</p>
2655
+ <pre><code class="language-TypeScript">import { sp } from &quot;@pnp/sp/presets/all&quot;;
2656
+
2657
+ sp.setup({
2658
+ sp: {
2659
+ headers: {
2660
+ Accept: &quot;application/json;odata=verbose&quot;,
2661
+ },
2662
+ baseUrl: &quot;{Absolute SharePoint Web URL}&quot;
2663
+ },
2664
+ });
2665
+
2666
+ const w = await sp.web();
2667
+ </code></pre>
2668
+ <h3 id="create-web-instances-directly">Create Web instances directly<a class="headerlink" href="#create-web-instances-directly" title="Permanent link">&para;</a></h3>
2669
+ <p>Using this method you create the web directly with the url you want to use as the base.</p>
2670
+ <pre><code class="language-TypeScript">import { Web } from &quot;@pnp/sp/presets/all&quot;;
2671
+
2672
+ const web = Web(&quot;{Absolute SharePoint Web URL}&quot;);
2673
+ const w = await web();
2674
+ </code></pre>
2675
+ <h2 id="next-steps">Next Steps<a class="headerlink" href="#next-steps" title="Permanent link">&para;</a></h2>
2676
+ <p>Be sure to <a href="../concepts/configuration/">review the article describing all of the available settings</a> across the libraries.</p>
2677
+
2678
+
2679
+
2680
+
2681
+
2682
+
2683
+
2684
+ </article>
2685
+ </div>
2686
+ </div>
2687
+ </main>
2688
+
2689
+
2690
+ <footer class="md-footer">
2691
+
2692
+ <div class="md-footer-nav">
2693
+ <nav class="md-footer-nav__inner md-grid" aria-label="Footer">
2694
+
2695
+ <a href="../news/2020-year-in-review/" class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
2696
+ <div class="md-footer-nav__button md-icon">
2697
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
2698
+ </div>
2699
+ <div class="md-footer-nav__title">
2700
+ <div class="md-ellipsis">
2701
+ <span class="md-footer-nav__direction">
2702
+ Previous
2703
+ </span>
2704
+ 2020 Year In Review
2705
+ </div>
2706
+ </div>
2707
+ </a>
2708
+
2709
+
2710
+ <a href="../transition-guide/" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
2711
+ <div class="md-footer-nav__title">
2712
+ <div class="md-ellipsis">
2713
+ <span class="md-footer-nav__direction">
2714
+ Next
2715
+ </span>
2716
+ Transition Guide
2717
+ </div>
2718
+ </div>
2719
+ <div class="md-footer-nav__button md-icon">
2720
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
2721
+ </div>
2722
+ </a>
2723
+
2724
+ </nav>
2725
+ </div>
2726
+
2727
+ <div class="md-footer-meta md-typeset">
2728
+ <div class="md-footer-meta__inner md-grid">
2729
+ <div class="md-footer-copyright">
2730
+
2731
+ Made with
2732
+ <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2733
+ Material for MkDocs
2734
+ </a>
2735
+ </div>
2736
+
2737
+ <div class="md-footer-social">
2738
+
2739
+
2740
+
2741
+
2742
+
2743
+
2744
+ <a href="https://twitter.com/m365pnpjs" target="_blank" rel="noopener" title="twitter.com" class="md-footer-social__link">
2745
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"/></svg>
2746
+ </a>
2747
+
2748
+
2749
+
2750
+
2751
+
2752
+
2753
+ <a href="http://aka.ms/sppnp-videos" target="_blank" rel="noopener" title="aka.ms" class="md-footer-social__link">
2754
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><path d="M549.655 124.083c-6.281-23.65-24.787-42.276-48.284-48.597C458.781 64 288 64 288 64S117.22 64 74.629 75.486c-23.497 6.322-42.003 24.947-48.284 48.597-11.412 42.867-11.412 132.305-11.412 132.305s0 89.438 11.412 132.305c6.281 23.65 24.787 41.5 48.284 47.821C117.22 448 288 448 288 448s170.78 0 213.371-11.486c23.497-6.321 42.003-24.171 48.284-47.821 11.412-42.867 11.412-132.305 11.412-132.305s0-89.438-11.412-132.305zm-317.51 213.508V175.185l142.739 81.205-142.739 81.201z"/></svg>
2755
+ </a>
2756
+
2757
+
2758
+
2759
+
2760
+
2761
+
2762
+ <a href="https://aka.ms/sppnp" target="_blank" rel="noopener" title="aka.ms" class="md-footer-social__link">
2763
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M0 32h214.6v214.6H0V32zm233.4 0H448v214.6H233.4V32zM0 265.4h214.6V480H0V265.4zm233.4 0H448V480H233.4V265.4z"/></svg>
2764
+ </a>
2765
+
2766
+ </div>
2767
+
2768
+ </div>
2769
+ </div>
2770
+ </footer>
2771
+
2772
+ </div>
2773
+
2774
+ <script src="../assets/javascripts/vendor.77e55a48.min.js"></script>
2775
+ <script src="../assets/javascripts/bundle.9554a270.min.js"></script><script id="__lang" type="application/json">{"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}</script>
2776
+
2777
+ <script>
2778
+ app = initialize({
2779
+ base: "..",
2780
+ features: [],
2781
+ search: Object.assign({
2782
+ worker: "../assets/javascripts/worker/search.4ac00218.min.js"
2783
+ }, typeof search !== "undefined" && search)
2784
+ })
2785
+ </script>
2786
+
2787
+
2788
+ </body>
2789
+ </html>