@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/v1/sp/docs/sites/index.html ADDED
@@ -0,0 +1,2186 @@
1
+
2
+
3
+
4
+
5
+ <!DOCTYPE html>
6
+ <html lang="en" class="no-js">
7
+ <head>
8
+
9
+ <meta charset="utf-8">
10
+ <meta name="viewport" content="width=device-width,initial-scale=1">
11
+ <meta http-equiv="x-ua-compatible" content="ie=edge">
12
+
13
+
14
+ <link rel="canonical" href="https://pnp.github.io/pnpjs/sp/docs/sites/">
15
+
16
+
17
+
18
+ <meta name="lang:clipboard.copy" content="Copy to clipboard">
19
+
20
+ <meta name="lang:clipboard.copied" content="Copied to clipboard">
21
+
22
+ <meta name="lang:search.language" content="en">
23
+
24
+ <meta name="lang:search.pipeline.stopwords" content="True">
25
+
26
+ <meta name="lang:search.pipeline.trimmer" content="True">
27
+
28
+ <meta name="lang:search.result.none" content="No matching documents">
29
+
30
+ <meta name="lang:search.result.one" content="1 matching document">
31
+
32
+ <meta name="lang:search.result.other" content="# matching documents">
33
+
34
+ <meta name="lang:search.tokenizer" content="[\s\-]+">
35
+
36
+ <link rel="shortcut icon" href="../../../assets/images/favicon.png">
37
+ <meta name="generator" content="mkdocs-1.0.1, mkdocs-material-3.0.3">
38
+
39
+
40
+
41
+ <title>Sites - PnP/PnPjs</title>
42
+
43
+
44
+
45
+ <link rel="stylesheet" href="../../../assets/stylesheets/application.451f80e5.css">
46
+
47
+ <link rel="stylesheet" href="../../../assets/stylesheets/application-palette.22915126.css">
48
+
49
+
50
+
51
+
52
+ <meta name="theme-color" content="#2196f3">
53
+
54
+
55
+
56
+ <script src="../../../assets/javascripts/modernizr.1aa3b519.js"></script>
57
+
58
+
59
+ <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
60
+
61
+ <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono">
62
+ <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
63
+
64
+
65
+ <link rel="stylesheet" href="../../../assets/fonts/material-icons.css">
66
+
67
+ <link rel="stylesheet" href="../../../documentation/css/extra.css">
68
+
69
+
70
+ </head>
71
+
72
+
73
+
74
+ <body dir="ltr" data-md-color-primary="blue" data-md-color-accent="">
75
+
76
+ <svg class="md-svg">
77
+ <defs>
78
+
79
+
80
+ <svg xmlns="http://www.w3.org/2000/svg" width="416" height="448"
81
+ viewBox="0 0 416 448" id="__github">
82
+ <path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19-18.125
83
+ 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 18.125-8.5
84
+ 18.125 8.5 10.75 19 3.125 20.5zM320 304q0 10-3.125 20.5t-10.75
85
+ 19-18.125 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19
86
+ 18.125-8.5 18.125 8.5 10.75 19 3.125 20.5zM360
87
+ 304q0-30-17.25-51t-46.75-21q-10.25 0-48.75 5.25-17.75 2.75-39.25
88
+ 2.75t-39.25-2.75q-38-5.25-48.75-5.25-29.5 0-46.75 21t-17.25 51q0 22 8
89
+ 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0
90
+ 37.25-1.75t35-7.375 30.5-15 20.25-25.75 8-38.375zM416 260q0 51.75-15.25
91
+ 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5-41.75
92
+ 1.125q-19.5 0-35.5-0.75t-36.875-3.125-38.125-7.5-34.25-12.875-30.25-20.25-21.5-28.75q-15.5-30.75-15.5-82.75
93
+ 0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25
94
+ 30.875q36.75-8.75 77.25-8.75 37 0 70 8 26.25-20.5
95
+ 46.75-30.25t47.25-9.75q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34
96
+ 99.5z" />
97
+ </svg>
98
+
99
+ </defs>
100
+ </svg>
101
+ <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
102
+ <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
103
+ <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
104
+
105
+ <a href="../../../#pnpspsite-site-properties" tabindex="1" class="md-skip">
106
+ Skip to content
107
+ </a>
108
+
109
+
110
+ <header class="md-header" data-md-component="header">
111
+ <nav class="md-header-nav md-grid">
112
+ <div class="md-flex">
113
+ <div class="md-flex__cell md-flex__cell--shrink">
114
+ <a href="https://pnp.github.io/pnpjs/" title="PnP/PnPjs" class="md-header-nav__button md-logo">
115
+
116
+ <img src="../../../documentation/img/Logo.png" width="24" height="24">
117
+
118
+ </a>
119
+ </div>
120
+ <div class="md-flex__cell md-flex__cell--shrink">
121
+ <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
122
+ </div>
123
+ <div class="md-flex__cell md-flex__cell--stretch">
124
+ <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
125
+
126
+
127
+ <span class="md-header-nav__topic">
128
+ PnP/PnPjs
129
+ </span>
130
+ <span class="md-header-nav__topic">
131
+ Sites
132
+ </span>
133
+
134
+
135
+ </div>
136
+ </div>
137
+ <div class="md-flex__cell md-flex__cell--shrink">
138
+
139
+
140
+ <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
141
+
142
+ <div class="md-search" data-md-component="search" role="dialog">
143
+ <label class="md-search__overlay" for="__search"></label>
144
+ <div class="md-search__inner" role="search">
145
+ <form class="md-search__form" name="search">
146
+ <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
147
+ <label class="md-icon md-search__icon" for="__search"></label>
148
+ <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
149
+ &#xE5CD;
150
+ </button>
151
+ </form>
152
+ <div class="md-search__output">
153
+ <div class="md-search__scrollwrap" data-md-scrollfix>
154
+ <div class="md-search-result" data-md-component="result">
155
+ <div class="md-search-result__meta">
156
+ Type to start searching
157
+ </div>
158
+ <ol class="md-search-result__list"></ol>
159
+ </div>
160
+ </div>
161
+ </div>
162
+ </div>
163
+ </div>
164
+
165
+
166
+ </div>
167
+
168
+ <div class="md-flex__cell md-flex__cell--shrink">
169
+ <div class="md-header-nav__source">
170
+
171
+
172
+
173
+
174
+
175
+
176
+ <a href="http://github.com/pnp/pnpjs/" title="Go to repository" class="md-source" data-md-source="github">
177
+
178
+ <div class="md-source__icon">
179
+ <svg viewBox="0 0 24 24" width="24" height="24">
180
+ <use xlink:href="#__github" width="24" height="24"></use>
181
+ </svg>
182
+ </div>
183
+
184
+ <div class="md-source__repository">
185
+ GitHub
186
+ </div>
187
+ </a>
188
+
189
+ </div>
190
+ </div>
191
+
192
+ </div>
193
+ </nav>
194
+ </header>
195
+
196
+ <div class="md-container">
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+ <nav class="md-tabs md-tabs--active" data-md-component="tabs">
206
+ <div class="md-tabs__inner md-grid">
207
+ <ul class="md-tabs__list">
208
+
209
+
210
+ <li class="md-tabs__item">
211
+
212
+ <a href="../../.." title="Home" class="md-tabs__link">
213
+ Home
214
+ </a>
215
+
216
+ </li>
217
+
218
+
219
+
220
+
221
+
222
+
223
+
224
+
225
+
226
+ <li class="md-tabs__item">
227
+
228
+ <a href="../../../documentation/getting-started/" title="General" class="md-tabs__link">
229
+ General
230
+ </a>
231
+
232
+ </li>
233
+
234
+
235
+
236
+
237
+
238
+
239
+ <li class="md-tabs__item">
240
+
241
+ <a href="../../../documentation/packages/" title="Packages" class="md-tabs__link md-tabs__link--active">
242
+ Packages
243
+ </a>
244
+
245
+ </li>
246
+
247
+
248
+
249
+ </ul>
250
+ </div>
251
+ </nav>
252
+
253
+ <main class="md-main">
254
+ <div class="md-main__inner md-grid" data-md-component="container">
255
+
256
+
257
+ <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
258
+ <div class="md-sidebar__scrollwrap">
259
+ <div class="md-sidebar__inner">
260
+ <nav class="md-nav md-nav--primary" data-md-level="0">
261
+ <label class="md-nav__title md-nav__title--site" for="__drawer">
262
+ <a href="https://pnp.github.io/pnpjs/" title="PnP/PnPjs" class="md-nav__button md-logo">
263
+
264
+ <img src="../../../documentation/img/Logo.png" width="48" height="48">
265
+
266
+ </a>
267
+ PnP/PnPjs
268
+ </label>
269
+
270
+ <div class="md-nav__source">
271
+
272
+
273
+
274
+
275
+
276
+
277
+ <a href="http://github.com/pnp/pnpjs/" title="Go to repository" class="md-source" data-md-source="github">
278
+
279
+ <div class="md-source__icon">
280
+ <svg viewBox="0 0 24 24" width="24" height="24">
281
+ <use xlink:href="#__github" width="24" height="24"></use>
282
+ </svg>
283
+ </div>
284
+
285
+ <div class="md-source__repository">
286
+ GitHub
287
+ </div>
288
+ </a>
289
+
290
+ </div>
291
+
292
+ <ul class="md-nav__list" data-md-scrollfix>
293
+
294
+
295
+
296
+
297
+
298
+
299
+ <li class="md-nav__item">
300
+ <a href="../../.." title="Home" class="md-nav__link">
301
+ Home
302
+ </a>
303
+ </li>
304
+
305
+
306
+
307
+
308
+
309
+
310
+
311
+ <li class="md-nav__item">
312
+ <a href="../../../documentation/getting-started/" title="Getting Started" class="md-nav__link">
313
+ Getting Started
314
+ </a>
315
+ </li>
316
+
317
+
318
+
319
+
320
+
321
+
322
+
323
+ <li class="md-nav__item">
324
+ <a href="../../../documentation/transition-guide/" title="Transition Guide" class="md-nav__link">
325
+ Transition Guide
326
+ </a>
327
+ </li>
328
+
329
+
330
+
331
+
332
+
333
+
334
+
335
+ <li class="md-nav__item md-nav__item--nested">
336
+
337
+ <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
338
+
339
+ <label class="md-nav__link" for="nav-4">
340
+ General
341
+ </label>
342
+ <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
343
+ <label class="md-nav__title" for="nav-4">
344
+ General
345
+ </label>
346
+ <ul class="md-nav__list" data-md-scrollfix>
347
+
348
+
349
+
350
+
351
+
352
+
353
+
354
+ <li class="md-nav__item">
355
+ <a href="../../../documentation/getting-started/" title="Getting Started" class="md-nav__link">
356
+ Getting Started
357
+ </a>
358
+ </li>
359
+
360
+
361
+
362
+
363
+
364
+
365
+
366
+ <li class="md-nav__item">
367
+ <a href="../../../documentation/getting-started-dev/" title="Getting Started Contributing" class="md-nav__link">
368
+ Getting Started Contributing
369
+ </a>
370
+ </li>
371
+
372
+
373
+
374
+
375
+
376
+
377
+
378
+ <li class="md-nav__item">
379
+ <a href="../../../documentation/gulp-commands/" title="Gulp Commands" class="md-nav__link">
380
+ Gulp Commands
381
+ </a>
382
+ </li>
383
+
384
+
385
+
386
+
387
+
388
+
389
+
390
+ <li class="md-nav__item">
391
+ <a href="../../../documentation/debugging/" title="Debugging" class="md-nav__link">
392
+ Debugging
393
+ </a>
394
+ </li>
395
+
396
+
397
+
398
+
399
+
400
+
401
+
402
+ <li class="md-nav__item">
403
+ <a href="../../../documentation/documentation/" title="Building Docs" class="md-nav__link">
404
+ Building Docs
405
+ </a>
406
+ </li>
407
+
408
+
409
+
410
+
411
+
412
+
413
+
414
+ <li class="md-nav__item">
415
+ <a href="../../../documentation/deployment/" title="Deployment" class="md-nav__link">
416
+ Deployment
417
+ </a>
418
+ </li>
419
+
420
+
421
+
422
+
423
+
424
+
425
+
426
+ <li class="md-nav__item">
427
+ <a href="../../../documentation/beta-versions/" title="Install Beta Versions" class="md-nav__link">
428
+ Install Beta Versions
429
+ </a>
430
+ </li>
431
+
432
+
433
+
434
+
435
+
436
+
437
+
438
+ <li class="md-nav__item">
439
+ <a href="../../../documentation/polyfill/" title="Polyfills" class="md-nav__link">
440
+ Polyfills
441
+ </a>
442
+ </li>
443
+
444
+
445
+
446
+
447
+
448
+
449
+
450
+ <li class="md-nav__item">
451
+ <a href="../../../documentation/package-structure/" title="Package Structure" class="md-nav__link">
452
+ Package Structure
453
+ </a>
454
+ </li>
455
+
456
+
457
+
458
+
459
+
460
+
461
+
462
+ <li class="md-nav__item">
463
+ <a href="../../../documentation/SPFx-On-Premesis-2016/" title="SPFx On-Premises 2016" class="md-nav__link">
464
+ SPFx On-Premises 2016
465
+ </a>
466
+ </li>
467
+
468
+
469
+
470
+
471
+
472
+
473
+
474
+ <li class="md-nav__item">
475
+ <a href="../../../documentation/transition-guide/" title="Transition Guide" class="md-nav__link">
476
+ Transition Guide
477
+ </a>
478
+ </li>
479
+
480
+
481
+ </ul>
482
+ </nav>
483
+ </li>
484
+
485
+
486
+
487
+
488
+
489
+
490
+
491
+
492
+
493
+ <li class="md-nav__item md-nav__item--active md-nav__item--nested">
494
+
495
+ <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5" checked>
496
+
497
+ <label class="md-nav__link" for="nav-5">
498
+ Packages
499
+ </label>
500
+ <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
501
+ <label class="md-nav__title" for="nav-5">
502
+ Packages
503
+ </label>
504
+ <ul class="md-nav__list" data-md-scrollfix>
505
+
506
+
507
+
508
+
509
+
510
+
511
+
512
+ <li class="md-nav__item">
513
+ <a href="../../../documentation/packages/" title="Packages" class="md-nav__link">
514
+ Packages
515
+ </a>
516
+ </li>
517
+
518
+
519
+
520
+
521
+
522
+
523
+
524
+ <li class="md-nav__item md-nav__item--nested">
525
+
526
+ <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-2" type="checkbox" id="nav-5-2">
527
+
528
+ <label class="md-nav__link" for="nav-5-2">
529
+ common
530
+ </label>
531
+ <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
532
+ <label class="md-nav__title" for="nav-5-2">
533
+ common
534
+ </label>
535
+ <ul class="md-nav__list" data-md-scrollfix>
536
+
537
+
538
+
539
+
540
+
541
+
542
+
543
+ <li class="md-nav__item">
544
+ <a href="../../../common/docs/" title="common" class="md-nav__link">
545
+ common
546
+ </a>
547
+ </li>
548
+
549
+
550
+
551
+
552
+
553
+
554
+
555
+ <li class="md-nav__item">
556
+ <a href="../../../common/docs/adalclient/" title="adalclient" class="md-nav__link">
557
+ adalclient
558
+ </a>
559
+ </li>
560
+
561
+
562
+
563
+
564
+
565
+
566
+
567
+ <li class="md-nav__item">
568
+ <a href="../../../common/docs/blobutil.md" title="blobutil" class="md-nav__link">
569
+ blobutil
570
+ </a>
571
+ </li>
572
+
573
+
574
+
575
+
576
+
577
+
578
+
579
+ <li class="md-nav__item">
580
+ <a href="../../../common/docs/collections/" title="collections" class="md-nav__link">
581
+ collections
582
+ </a>
583
+ </li>
584
+
585
+
586
+
587
+
588
+
589
+
590
+
591
+ <li class="md-nav__item">
592
+ <a href="../../../common/docs/custom-httpclientimpl/" title="Custom HttpClientImpl" class="md-nav__link">
593
+ Custom HttpClientImpl
594
+ </a>
595
+ </li>
596
+
597
+
598
+
599
+
600
+
601
+
602
+
603
+ <li class="md-nav__item">
604
+ <a href="../../../common/docs/libconfig/" title="libconfig" class="md-nav__link">
605
+ libconfig
606
+ </a>
607
+ </li>
608
+
609
+
610
+
611
+
612
+
613
+
614
+
615
+ <li class="md-nav__item">
616
+ <a href="../../../common/docs/netutil/" title="netutil" class="md-nav__link">
617
+ netutil
618
+ </a>
619
+ </li>
620
+
621
+
622
+
623
+
624
+
625
+
626
+
627
+ <li class="md-nav__item">
628
+ <a href="../../../common/docs/storage/" title="storage" class="md-nav__link">
629
+ storage
630
+ </a>
631
+ </li>
632
+
633
+
634
+
635
+
636
+
637
+
638
+
639
+ <li class="md-nav__item">
640
+ <a href="../../../common/docs/util/" title="util" class="md-nav__link">
641
+ util
642
+ </a>
643
+ </li>
644
+
645
+
646
+ </ul>
647
+ </nav>
648
+ </li>
649
+
650
+
651
+
652
+
653
+
654
+
655
+
656
+ <li class="md-nav__item md-nav__item--nested">
657
+
658
+ <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-3" type="checkbox" id="nav-5-3">
659
+
660
+ <label class="md-nav__link" for="nav-5-3">
661
+ config-store
662
+ </label>
663
+ <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
664
+ <label class="md-nav__title" for="nav-5-3">
665
+ config-store
666
+ </label>
667
+ <ul class="md-nav__list" data-md-scrollfix>
668
+
669
+
670
+
671
+
672
+
673
+
674
+
675
+ <li class="md-nav__item">
676
+ <a href="../../../config-store/docs/" title="config-store" class="md-nav__link">
677
+ config-store
678
+ </a>
679
+ </li>
680
+
681
+
682
+
683
+
684
+
685
+
686
+
687
+ <li class="md-nav__item">
688
+ <a href="../../../config-store/docs/configuration/" title="configuration" class="md-nav__link">
689
+ configuration
690
+ </a>
691
+ </li>
692
+
693
+
694
+
695
+
696
+
697
+
698
+
699
+ <li class="md-nav__item">
700
+ <a href="../../../config-store/docs/providers/" title="providers" class="md-nav__link">
701
+ providers
702
+ </a>
703
+ </li>
704
+
705
+
706
+ </ul>
707
+ </nav>
708
+ </li>
709
+
710
+
711
+
712
+
713
+
714
+
715
+
716
+ <li class="md-nav__item md-nav__item--nested">
717
+
718
+ <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-4" type="checkbox" id="nav-5-4">
719
+
720
+ <label class="md-nav__link" for="nav-5-4">
721
+ graph
722
+ </label>
723
+ <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
724
+ <label class="md-nav__title" for="nav-5-4">
725
+ graph
726
+ </label>
727
+ <ul class="md-nav__list" data-md-scrollfix>
728
+
729
+
730
+
731
+
732
+
733
+
734
+
735
+ <li class="md-nav__item">
736
+ <a href="../../../graph/docs/" title="graph" class="md-nav__link">
737
+ graph
738
+ </a>
739
+ </li>
740
+
741
+
742
+
743
+
744
+
745
+
746
+
747
+ <li class="md-nav__item">
748
+ <a href="../../../graph/docs/contacts/" title="contacts" class="md-nav__link">
749
+ contacts
750
+ </a>
751
+ </li>
752
+
753
+
754
+
755
+
756
+
757
+
758
+
759
+ <li class="md-nav__item">
760
+ <a href="../../../graph/docs/directoryobjects/" title="directory objects" class="md-nav__link">
761
+ directory objects
762
+ </a>
763
+ </li>
764
+
765
+
766
+
767
+
768
+
769
+
770
+
771
+ <li class="md-nav__item">
772
+ <a href="../../../graph/docs/invitations/" title="invitations" class="md-nav__link">
773
+ invitations
774
+ </a>
775
+ </li>
776
+
777
+
778
+
779
+
780
+
781
+
782
+
783
+ <li class="md-nav__item">
784
+ <a href="../../../graph/docs/onedrive/" title="onedrive" class="md-nav__link">
785
+ onedrive
786
+ </a>
787
+ </li>
788
+
789
+
790
+
791
+
792
+
793
+
794
+
795
+ <li class="md-nav__item">
796
+ <a href="../../../graph/docs/planner/" title="planner" class="md-nav__link">
797
+ planner
798
+ </a>
799
+ </li>
800
+
801
+
802
+
803
+
804
+
805
+
806
+
807
+ <li class="md-nav__item">
808
+ <a href="../../../graph/docs/subscriptions/" title="subscriptions" class="md-nav__link">
809
+ subscriptions
810
+ </a>
811
+ </li>
812
+
813
+
814
+
815
+
816
+
817
+
818
+
819
+ <li class="md-nav__item">
820
+ <a href="../../../graph/docs/teams/" title="teams" class="md-nav__link">
821
+ teams
822
+ </a>
823
+ </li>
824
+
825
+
826
+ </ul>
827
+ </nav>
828
+ </li>
829
+
830
+
831
+
832
+
833
+
834
+
835
+
836
+ <li class="md-nav__item">
837
+ <a href="../../../logging/docs/" title="logging" class="md-nav__link">
838
+ logging
839
+ </a>
840
+ </li>
841
+
842
+
843
+
844
+
845
+
846
+
847
+
848
+ <li class="md-nav__item md-nav__item--nested">
849
+
850
+ <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-6" type="checkbox" id="nav-5-6">
851
+
852
+ <label class="md-nav__link" for="nav-5-6">
853
+ nodejs
854
+ </label>
855
+ <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
856
+ <label class="md-nav__title" for="nav-5-6">
857
+ nodejs
858
+ </label>
859
+ <ul class="md-nav__list" data-md-scrollfix>
860
+
861
+
862
+
863
+
864
+
865
+
866
+
867
+ <li class="md-nav__item">
868
+ <a href="../../../nodejs/docs/" title="nodejs" class="md-nav__link">
869
+ nodejs
870
+ </a>
871
+ </li>
872
+
873
+
874
+
875
+
876
+
877
+
878
+
879
+ <li class="md-nav__item">
880
+ <a href="../../../nodejs/docs/adal-fetch-client/" title="AdalFetchClient" class="md-nav__link">
881
+ AdalFetchClient
882
+ </a>
883
+ </li>
884
+
885
+
886
+
887
+
888
+
889
+
890
+
891
+ <li class="md-nav__item">
892
+ <a href="../../../nodejs/docs/sp-fetch-client/" title="SPFetchClient" class="md-nav__link">
893
+ SPFetchClient
894
+ </a>
895
+ </li>
896
+
897
+
898
+
899
+
900
+
901
+
902
+
903
+ <li class="md-nav__item">
904
+ <a href="../../../nodejs/docs/bearer-token-fetch-client/" title="BearerTokenFetchClient" class="md-nav__link">
905
+ BearerTokenFetchClient
906
+ </a>
907
+ </li>
908
+
909
+
910
+
911
+
912
+
913
+
914
+
915
+ <li class="md-nav__item">
916
+ <a href="../../../nodejs/docs/provider-hosted-app/" title="ProviderHostedRequestContext" class="md-nav__link">
917
+ ProviderHostedRequestContext
918
+ </a>
919
+ </li>
920
+
921
+
922
+ </ul>
923
+ </nav>
924
+ </li>
925
+
926
+
927
+
928
+
929
+
930
+
931
+
932
+ <li class="md-nav__item md-nav__item--nested">
933
+
934
+ <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-7" type="checkbox" id="nav-5-7">
935
+
936
+ <label class="md-nav__link" for="nav-5-7">
937
+ odata
938
+ </label>
939
+ <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
940
+ <label class="md-nav__title" for="nav-5-7">
941
+ odata
942
+ </label>
943
+ <ul class="md-nav__list" data-md-scrollfix>
944
+
945
+
946
+
947
+
948
+
949
+
950
+
951
+ <li class="md-nav__item">
952
+ <a href="../../../queryable/docs/" title="odata" class="md-nav__link">
953
+ odata
954
+ </a>
955
+ </li>
956
+
957
+
958
+
959
+
960
+
961
+
962
+
963
+ <li class="md-nav__item">
964
+ <a href="../../../queryable/docs/caching/" title="caching" class="md-nav__link">
965
+ caching
966
+ </a>
967
+ </li>
968
+
969
+
970
+
971
+
972
+
973
+
974
+
975
+ <li class="md-nav__item">
976
+ <a href="../../../queryable/docs/core/" title="core" class="md-nav__link">
977
+ core
978
+ </a>
979
+ </li>
980
+
981
+
982
+
983
+
984
+
985
+
986
+
987
+ <li class="md-nav__item">
988
+ <a href="../../../queryable/docs/odata-batch/" title="OData Batching" class="md-nav__link">
989
+ OData Batching
990
+ </a>
991
+ </li>
992
+
993
+
994
+
995
+
996
+
997
+
998
+
999
+ <li class="md-nav__item">
1000
+ <a href="../../../queryable/docs/parsers/" title="Parsers" class="md-nav__link">
1001
+ Parsers
1002
+ </a>
1003
+ </li>
1004
+
1005
+
1006
+
1007
+
1008
+
1009
+
1010
+
1011
+ <li class="md-nav__item">
1012
+ <a href="../../../queryable/docs/pipeline/" title="Pipeline" class="md-nav__link">
1013
+ Pipeline
1014
+ </a>
1015
+ </li>
1016
+
1017
+
1018
+
1019
+
1020
+
1021
+
1022
+
1023
+ <li class="md-nav__item">
1024
+ <a href="../../../queryable/docs/queryable/" title="Queryable" class="md-nav__link">
1025
+ Queryable
1026
+ </a>
1027
+ </li>
1028
+
1029
+
1030
+ </ul>
1031
+ </nav>
1032
+ </li>
1033
+
1034
+
1035
+
1036
+
1037
+
1038
+
1039
+
1040
+ <li class="md-nav__item">
1041
+ <a href="../../../pnpjs/docs/" title="pnpjs" class="md-nav__link">
1042
+ pnpjs
1043
+ </a>
1044
+ </li>
1045
+
1046
+
1047
+
1048
+
1049
+
1050
+
1051
+
1052
+
1053
+
1054
+ <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1055
+
1056
+ <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-9" type="checkbox" id="nav-5-9" checked>
1057
+
1058
+ <label class="md-nav__link" for="nav-5-9">
1059
+ sp
1060
+ </label>
1061
+ <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
1062
+ <label class="md-nav__title" for="nav-5-9">
1063
+ sp
1064
+ </label>
1065
+ <ul class="md-nav__list" data-md-scrollfix>
1066
+
1067
+
1068
+
1069
+
1070
+
1071
+
1072
+
1073
+ <li class="md-nav__item">
1074
+ <a href="../" title="sp" class="md-nav__link">
1075
+ sp
1076
+ </a>
1077
+ </li>
1078
+
1079
+
1080
+
1081
+
1082
+
1083
+
1084
+
1085
+ <li class="md-nav__item">
1086
+ <a href="../alias-parameters/" title="Alias Parameters" class="md-nav__link">
1087
+ Alias Parameters
1088
+ </a>
1089
+ </li>
1090
+
1091
+
1092
+
1093
+
1094
+
1095
+
1096
+
1097
+ <li class="md-nav__item">
1098
+ <a href="../alm/" title="ALM api" class="md-nav__link">
1099
+ ALM api
1100
+ </a>
1101
+ </li>
1102
+
1103
+
1104
+
1105
+
1106
+
1107
+
1108
+
1109
+ <li class="md-nav__item">
1110
+ <a href="../attachments/" title="Attachments" class="md-nav__link">
1111
+ Attachments
1112
+ </a>
1113
+ </li>
1114
+
1115
+
1116
+
1117
+
1118
+
1119
+
1120
+
1121
+ <li class="md-nav__item">
1122
+ <a href="../client-side-pages/" title="Client-side Pages" class="md-nav__link">
1123
+ Client-side Pages
1124
+ </a>
1125
+ </li>
1126
+
1127
+
1128
+
1129
+
1130
+
1131
+
1132
+
1133
+ <li class="md-nav__item">
1134
+ <a href="../content-types/" title="Content Types" class="md-nav__link">
1135
+ Content Types
1136
+ </a>
1137
+ </li>
1138
+
1139
+
1140
+
1141
+
1142
+
1143
+
1144
+
1145
+ <li class="md-nav__item">
1146
+ <a href="../entity-merging/" title="Entity Merging" class="md-nav__link">
1147
+ Entity Merging
1148
+ </a>
1149
+ </li>
1150
+
1151
+
1152
+
1153
+
1154
+
1155
+
1156
+
1157
+ <li class="md-nav__item">
1158
+ <a href="../features/" title="Features" class="md-nav__link">
1159
+ Features
1160
+ </a>
1161
+ </li>
1162
+
1163
+
1164
+
1165
+
1166
+
1167
+
1168
+
1169
+ <li class="md-nav__item">
1170
+ <a href="../fields/" title="Fields" class="md-nav__link">
1171
+ Fields
1172
+ </a>
1173
+ </li>
1174
+
1175
+
1176
+
1177
+
1178
+
1179
+
1180
+
1181
+ <li class="md-nav__item">
1182
+ <a href="../files/" title="Files" class="md-nav__link">
1183
+ Files
1184
+ </a>
1185
+ </li>
1186
+
1187
+
1188
+
1189
+
1190
+
1191
+
1192
+
1193
+ <li class="md-nav__item">
1194
+ <a href="../items/" title="List Items" class="md-nav__link">
1195
+ List Items
1196
+ </a>
1197
+ </li>
1198
+
1199
+
1200
+
1201
+
1202
+
1203
+
1204
+
1205
+ <li class="md-nav__item">
1206
+ <a href="../navigation-service/" title="Navigation Service" class="md-nav__link">
1207
+ Navigation Service
1208
+ </a>
1209
+ </li>
1210
+
1211
+
1212
+
1213
+
1214
+
1215
+
1216
+
1217
+ <li class="md-nav__item">
1218
+ <a href="../permissions/" title="Permissions" class="md-nav__link">
1219
+ Permissions
1220
+ </a>
1221
+ </li>
1222
+
1223
+
1224
+
1225
+
1226
+
1227
+
1228
+
1229
+ <li class="md-nav__item">
1230
+ <a href="../profiles/" title="Profiles" class="md-nav__link">
1231
+ Profiles
1232
+ </a>
1233
+ </li>
1234
+
1235
+
1236
+
1237
+
1238
+
1239
+
1240
+
1241
+ <li class="md-nav__item">
1242
+ <a href="../related-items/" title="Related Items" class="md-nav__link">
1243
+ Related Items
1244
+ </a>
1245
+ </li>
1246
+
1247
+
1248
+
1249
+
1250
+
1251
+
1252
+
1253
+ <li class="md-nav__item">
1254
+ <a href="../search/" title="Search" class="md-nav__link">
1255
+ Search
1256
+ </a>
1257
+ </li>
1258
+
1259
+
1260
+
1261
+
1262
+
1263
+
1264
+
1265
+ <li class="md-nav__item">
1266
+ <a href="../sharing/" title="Sharing" class="md-nav__link">
1267
+ Sharing
1268
+ </a>
1269
+ </li>
1270
+
1271
+
1272
+
1273
+
1274
+
1275
+
1276
+
1277
+
1278
+
1279
+ <li class="md-nav__item md-nav__item--active">
1280
+
1281
+ <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1282
+
1283
+
1284
+
1285
+
1286
+ <label class="md-nav__link md-nav__link--active" for="__toc">
1287
+ Sites
1288
+ </label>
1289
+
1290
+ <a href="./" title="Sites" class="md-nav__link md-nav__link--active">
1291
+ Sites
1292
+ </a>
1293
+
1294
+
1295
+ <nav class="md-nav md-nav--secondary">
1296
+
1297
+
1298
+
1299
+
1300
+
1301
+ <label class="md-nav__title" for="__toc">Table of contents</label>
1302
+ <ul class="md-nav__list" data-md-scrollfix>
1303
+
1304
+ <li class="md-nav__item">
1305
+ <a href="#get-context-information-for-the-current-site-collection" title="Get context information for the current site collection" class="md-nav__link">
1306
+ Get context information for the current site collection
1307
+ </a>
1308
+
1309
+ </li>
1310
+
1311
+ <li class="md-nav__item">
1312
+ <a href="#get-document-libraries-of-a-web" title="Get document libraries of a web" class="md-nav__link">
1313
+ Get document libraries of a web
1314
+ </a>
1315
+
1316
+ </li>
1317
+
1318
+ <li class="md-nav__item">
1319
+ <a href="#open-web-by-id" title="Open Web By Id" class="md-nav__link">
1320
+ Open Web By Id
1321
+ </a>
1322
+
1323
+ </li>
1324
+
1325
+ <li class="md-nav__item">
1326
+ <a href="#get-site-collection-url-from-page" title="Get site collection url from page" class="md-nav__link">
1327
+ Get site collection url from page
1328
+ </a>
1329
+
1330
+ </li>
1331
+
1332
+ <li class="md-nav__item">
1333
+ <a href="#join-a-hub-site" title="Join a hub site" class="md-nav__link">
1334
+ Join a hub site
1335
+ </a>
1336
+
1337
+ </li>
1338
+
1339
+ <li class="md-nav__item">
1340
+ <a href="#disassociate-the-current-site-collection-from-a-hub-site-collection" title="Disassociate the current site collection from a hub site collection" class="md-nav__link">
1341
+ Disassociate the current site collection from a hub site collection
1342
+ </a>
1343
+
1344
+ </li>
1345
+
1346
+ <li class="md-nav__item">
1347
+ <a href="#register-a-hub-site" title="Register a hub site" class="md-nav__link">
1348
+ Register a hub site
1349
+ </a>
1350
+
1351
+ </li>
1352
+
1353
+ <li class="md-nav__item">
1354
+ <a href="#un-register-a-hub-site" title="Un-Register a hub site" class="md-nav__link">
1355
+ Un-Register a hub site
1356
+ </a>
1357
+
1358
+ </li>
1359
+
1360
+ <li class="md-nav__item">
1361
+ <a href="#create-a-modern-communication-site" title="Create a modern communication site" class="md-nav__link">
1362
+ Create a modern communication site
1363
+ </a>
1364
+
1365
+ </li>
1366
+
1367
+ <li class="md-nav__item">
1368
+ <a href="#create-a-modern-team-site" title="Create a modern team site" class="md-nav__link">
1369
+ Create a modern team site
1370
+ </a>
1371
+
1372
+ </li>
1373
+
1374
+ <li class="md-nav__item">
1375
+ <a href="#delete-a-site-collection" title="Delete a site collection" class="md-nav__link">
1376
+ Delete a site collection
1377
+ </a>
1378
+
1379
+ </li>
1380
+
1381
+
1382
+
1383
+
1384
+
1385
+ </ul>
1386
+
1387
+ </nav>
1388
+
1389
+ </li>
1390
+
1391
+
1392
+
1393
+
1394
+
1395
+
1396
+
1397
+ <li class="md-nav__item">
1398
+ <a href="../sitedesigns/" title="Site Designs" class="md-nav__link">
1399
+ Site Designs
1400
+ </a>
1401
+ </li>
1402
+
1403
+
1404
+
1405
+
1406
+
1407
+
1408
+
1409
+ <li class="md-nav__item">
1410
+ <a href="../social/" title="Social" class="md-nav__link">
1411
+ Social
1412
+ </a>
1413
+ </li>
1414
+
1415
+
1416
+
1417
+
1418
+
1419
+
1420
+
1421
+ <li class="md-nav__item">
1422
+ <a href="../sp-utilities-utility/" title="SP.Utilities.Utility" class="md-nav__link">
1423
+ SP.Utilities.Utility
1424
+ </a>
1425
+ </li>
1426
+
1427
+
1428
+
1429
+
1430
+
1431
+
1432
+
1433
+ <li class="md-nav__item">
1434
+ <a href="../tenant-properties/" title="Tenant Properties" class="md-nav__link">
1435
+ Tenant Properties
1436
+ </a>
1437
+ </li>
1438
+
1439
+
1440
+
1441
+
1442
+
1443
+
1444
+
1445
+ <li class="md-nav__item">
1446
+ <a href="../views/" title="Views" class="md-nav__link">
1447
+ Views
1448
+ </a>
1449
+ </li>
1450
+
1451
+
1452
+
1453
+
1454
+
1455
+
1456
+
1457
+ <li class="md-nav__item">
1458
+ <a href="../webs/" title="Webs" class="md-nav__link">
1459
+ Webs
1460
+ </a>
1461
+ </li>
1462
+
1463
+
1464
+
1465
+
1466
+
1467
+
1468
+
1469
+ <li class="md-nav__item">
1470
+ <a href="../comments-likes/" title="Comments and Likes" class="md-nav__link">
1471
+ Comments and Likes
1472
+ </a>
1473
+ </li>
1474
+
1475
+
1476
+ </ul>
1477
+ </nav>
1478
+ </li>
1479
+
1480
+
1481
+
1482
+
1483
+
1484
+
1485
+
1486
+ <li class="md-nav__item md-nav__item--nested">
1487
+
1488
+ <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-10" type="checkbox" id="nav-5-10">
1489
+
1490
+ <label class="md-nav__link" for="nav-5-10">
1491
+ sp-addinhelpers
1492
+ </label>
1493
+ <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
1494
+ <label class="md-nav__title" for="nav-5-10">
1495
+ sp-addinhelpers
1496
+ </label>
1497
+ <ul class="md-nav__list" data-md-scrollfix>
1498
+
1499
+
1500
+
1501
+
1502
+
1503
+
1504
+
1505
+ <li class="md-nav__item">
1506
+ <a href="../../../sp-addinhelpers/docs/" title="sp-addinhelpers" class="md-nav__link">
1507
+ sp-addinhelpers
1508
+ </a>
1509
+ </li>
1510
+
1511
+
1512
+
1513
+
1514
+
1515
+
1516
+
1517
+ <li class="md-nav__item">
1518
+ <a href="../../../sp-addinhelpers/docs/sp-request-executor-client/" title="SPRequestExecutorClient" class="md-nav__link">
1519
+ SPRequestExecutorClient
1520
+ </a>
1521
+ </li>
1522
+
1523
+
1524
+
1525
+
1526
+
1527
+
1528
+
1529
+ <li class="md-nav__item">
1530
+ <a href="../../../sp-addinhelpers/docs/sp-rest-addin/" title="SPRestAddIn" class="md-nav__link">
1531
+ SPRestAddIn
1532
+ </a>
1533
+ </li>
1534
+
1535
+
1536
+ </ul>
1537
+ </nav>
1538
+ </li>
1539
+
1540
+
1541
+
1542
+
1543
+
1544
+
1545
+
1546
+ <li class="md-nav__item">
1547
+ <a href="../../../sp-clientsvc/docs/" title="sp-clientsvc" class="md-nav__link">
1548
+ sp-clientsvc
1549
+ </a>
1550
+ </li>
1551
+
1552
+
1553
+
1554
+
1555
+
1556
+
1557
+
1558
+ <li class="md-nav__item md-nav__item--nested">
1559
+
1560
+ <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-12" type="checkbox" id="nav-5-12">
1561
+
1562
+ <label class="md-nav__link" for="nav-5-12">
1563
+ sp-taxonomy
1564
+ </label>
1565
+ <nav class="md-nav" data-md-component="collapsible" data-md-level="2">
1566
+ <label class="md-nav__title" for="nav-5-12">
1567
+ sp-taxonomy
1568
+ </label>
1569
+ <ul class="md-nav__list" data-md-scrollfix>
1570
+
1571
+
1572
+
1573
+
1574
+
1575
+
1576
+
1577
+ <li class="md-nav__item">
1578
+ <a href="../../../sp-taxonomy/docs/" title="sp-taxonomy" class="md-nav__link">
1579
+ sp-taxonomy
1580
+ </a>
1581
+ </li>
1582
+
1583
+
1584
+
1585
+
1586
+
1587
+
1588
+
1589
+ <li class="md-nav__item">
1590
+ <a href="../../../sp-taxonomy/docs/term-stores/" title="Term Stores" class="md-nav__link">
1591
+ Term Stores
1592
+ </a>
1593
+ </li>
1594
+
1595
+
1596
+
1597
+
1598
+
1599
+
1600
+
1601
+ <li class="md-nav__item">
1602
+ <a href="../../../sp-taxonomy/docs/term-groups/" title="Term Groups" class="md-nav__link">
1603
+ Term Groups
1604
+ </a>
1605
+ </li>
1606
+
1607
+
1608
+
1609
+
1610
+
1611
+
1612
+
1613
+ <li class="md-nav__item">
1614
+ <a href="../../../sp-taxonomy/docs/term-sets/" title="Term Sets" class="md-nav__link">
1615
+ Term Sets
1616
+ </a>
1617
+ </li>
1618
+
1619
+
1620
+
1621
+
1622
+
1623
+
1624
+
1625
+ <li class="md-nav__item">
1626
+ <a href="../../../sp-taxonomy/docs/terms/" title="Terms" class="md-nav__link">
1627
+ Terms
1628
+ </a>
1629
+ </li>
1630
+
1631
+
1632
+
1633
+
1634
+
1635
+
1636
+
1637
+ <li class="md-nav__item">
1638
+ <a href="../../../sp-taxonomy/docs/labels/" title="Labels" class="md-nav__link">
1639
+ Labels
1640
+ </a>
1641
+ </li>
1642
+
1643
+
1644
+
1645
+
1646
+
1647
+
1648
+
1649
+ <li class="md-nav__item">
1650
+ <a href="../../../sp-taxonomy/docs/utilities/" title="Utilities" class="md-nav__link">
1651
+ Utilities
1652
+ </a>
1653
+ </li>
1654
+
1655
+
1656
+ </ul>
1657
+ </nav>
1658
+ </li>
1659
+
1660
+
1661
+ </ul>
1662
+ </nav>
1663
+ </li>
1664
+
1665
+
1666
+ </ul>
1667
+ </nav>
1668
+ </div>
1669
+ </div>
1670
+ </div>
1671
+
1672
+
1673
+ <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
1674
+ <div class="md-sidebar__scrollwrap">
1675
+ <div class="md-sidebar__inner">
1676
+
1677
+ <nav class="md-nav md-nav--secondary">
1678
+
1679
+
1680
+
1681
+
1682
+
1683
+ <label class="md-nav__title" for="__toc">Table of contents</label>
1684
+ <ul class="md-nav__list" data-md-scrollfix>
1685
+
1686
+ <li class="md-nav__item">
1687
+ <a href="#get-context-information-for-the-current-site-collection" title="Get context information for the current site collection" class="md-nav__link">
1688
+ Get context information for the current site collection
1689
+ </a>
1690
+
1691
+ </li>
1692
+
1693
+ <li class="md-nav__item">
1694
+ <a href="#get-document-libraries-of-a-web" title="Get document libraries of a web" class="md-nav__link">
1695
+ Get document libraries of a web
1696
+ </a>
1697
+
1698
+ </li>
1699
+
1700
+ <li class="md-nav__item">
1701
+ <a href="#open-web-by-id" title="Open Web By Id" class="md-nav__link">
1702
+ Open Web By Id
1703
+ </a>
1704
+
1705
+ </li>
1706
+
1707
+ <li class="md-nav__item">
1708
+ <a href="#get-site-collection-url-from-page" title="Get site collection url from page" class="md-nav__link">
1709
+ Get site collection url from page
1710
+ </a>
1711
+
1712
+ </li>
1713
+
1714
+ <li class="md-nav__item">
1715
+ <a href="#join-a-hub-site" title="Join a hub site" class="md-nav__link">
1716
+ Join a hub site
1717
+ </a>
1718
+
1719
+ </li>
1720
+
1721
+ <li class="md-nav__item">
1722
+ <a href="#disassociate-the-current-site-collection-from-a-hub-site-collection" title="Disassociate the current site collection from a hub site collection" class="md-nav__link">
1723
+ Disassociate the current site collection from a hub site collection
1724
+ </a>
1725
+
1726
+ </li>
1727
+
1728
+ <li class="md-nav__item">
1729
+ <a href="#register-a-hub-site" title="Register a hub site" class="md-nav__link">
1730
+ Register a hub site
1731
+ </a>
1732
+
1733
+ </li>
1734
+
1735
+ <li class="md-nav__item">
1736
+ <a href="#un-register-a-hub-site" title="Un-Register a hub site" class="md-nav__link">
1737
+ Un-Register a hub site
1738
+ </a>
1739
+
1740
+ </li>
1741
+
1742
+ <li class="md-nav__item">
1743
+ <a href="#create-a-modern-communication-site" title="Create a modern communication site" class="md-nav__link">
1744
+ Create a modern communication site
1745
+ </a>
1746
+
1747
+ </li>
1748
+
1749
+ <li class="md-nav__item">
1750
+ <a href="#create-a-modern-team-site" title="Create a modern team site" class="md-nav__link">
1751
+ Create a modern team site
1752
+ </a>
1753
+
1754
+ </li>
1755
+
1756
+ <li class="md-nav__item">
1757
+ <a href="#delete-a-site-collection" title="Delete a site collection" class="md-nav__link">
1758
+ Delete a site collection
1759
+ </a>
1760
+
1761
+ </li>
1762
+
1763
+
1764
+
1765
+
1766
+
1767
+ </ul>
1768
+
1769
+ </nav>
1770
+ </div>
1771
+ </div>
1772
+ </div>
1773
+
1774
+
1775
+ <div class="md-content">
1776
+ <article class="md-content__inner md-typeset">
1777
+
1778
+
1779
+ <a href="http://github.com/pnp/pnpjs/tree/dev/packages/sp/docs/sites.md" title="Edit this page" class="md-icon md-content__icon">&#xE3C9;</a>
1780
+
1781
+
1782
+ <h1 id="pnpspsite-site-properties">@pnp/sp/site - Site properties<a class="headerlink" href="#pnpspsite-site-properties" title="Permanent link">&para;</a></h1>
1783
+ <p>Site collection are one of the fundamental entry points while working with SharePoint. Sites serve as container for webs, lists, features and other entity types.</p>
1784
+ <h2 id="get-context-information-for-the-current-site-collection">Get context information for the current site collection<a class="headerlink" href="#get-context-information-for-the-current-site-collection" title="Permanent link">&para;</a></h2>
1785
+ <p>Using the library, you can get the context information of the current site collection</p>
1786
+ <div class="codehilite"><pre><span></span><span class="kr">import</span> <span class="p">{</span> <span class="nx">sp</span> <span class="p">}</span> <span class="nx">from</span> <span class="s2">&quot;@pnp/sp&quot;</span><span class="p">;</span>
1787
+
1788
+ <span class="nx">sp</span><span class="p">.</span><span class="nx">site</span><span class="p">.</span><span class="nx">getContextInfo</span><span class="p">().</span><span class="nx">then</span><span class="p">(</span><span class="nx">d</span> <span class="o">=&gt;</span><span class="p">{</span>
1789
+ <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">d</span><span class="p">.</span><span class="nx">FormDigestValue</span><span class="p">);</span>
1790
+ <span class="p">});</span>
1791
+ </pre></div>
1792
+
1793
+
1794
+ <h2 id="get-document-libraries-of-a-web">Get document libraries of a web<a class="headerlink" href="#get-document-libraries-of-a-web" title="Permanent link">&para;</a></h2>
1795
+ <p>Using the library, you can get a list of the document libraries present in the a given web.</p>
1796
+ <p><strong>Note:</strong> Works only in SharePoint online</p>
1797
+ <div class="codehilite"><pre><span></span><span class="kr">import</span> <span class="p">{</span> <span class="nx">sp</span> <span class="p">}</span> <span class="nx">from</span> <span class="s2">&quot;@pnp/sp&quot;</span><span class="p">;</span>
1798
+
1799
+ <span class="nx">sp</span><span class="p">.</span><span class="nx">site</span><span class="p">.</span><span class="nx">getDocumentLibraries</span><span class="p">(</span><span class="s2">&quot;https://tenant.sharepoint.com/sites/test/subsite&quot;</span><span class="p">).</span><span class="nx">then</span><span class="p">((</span><span class="nx">d</span>:<span class="kt">DocumentLibraryInformation</span><span class="p">[])</span> <span class="o">=&gt;</span> <span class="p">{</span>
1800
+ <span class="c1">// iterate over the array of doc lib</span>
1801
+ <span class="p">});</span>
1802
+ </pre></div>
1803
+
1804
+
1805
+ <h2 id="open-web-by-id">Open Web By Id<a class="headerlink" href="#open-web-by-id" title="Permanent link">&para;</a></h2>
1806
+ <p>Because this method is a POST request you can chain off it directly. You will get back the full web properties in the data property of the return object. You can also chain directly off the returned Web instance on the web property.</p>
1807
+ <div class="codehilite"><pre><span></span><span class="nx">sp</span><span class="p">.</span><span class="nx">site</span><span class="p">.</span><span class="nx">openWebById</span><span class="p">(</span><span class="s2">&quot;111ca453-90f5-482e-a381-cee1ff383c9e&quot;</span><span class="p">).</span><span class="nx">then</span><span class="p">(</span><span class="nx">w</span> <span class="o">=&gt;</span> <span class="p">{</span>
1808
+
1809
+ <span class="c1">//we got all the data from the web as well</span>
1810
+ <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">w</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
1811
+
1812
+ <span class="c1">// we can chain</span>
1813
+ <span class="nx">w</span><span class="p">.</span><span class="nx">web</span><span class="p">.</span><span class="nx">select</span><span class="p">(</span><span class="s2">&quot;Title&quot;</span><span class="p">).</span><span class="nx">get</span><span class="p">().</span><span class="nx">then</span><span class="p">(</span><span class="nx">w2</span> <span class="o">=&gt;</span> <span class="p">{</span>
1814
+ <span class="c1">// ...</span>
1815
+ <span class="p">});</span>
1816
+ <span class="p">});</span>
1817
+ </pre></div>
1818
+
1819
+
1820
+ <h2 id="get-site-collection-url-from-page">Get site collection url from page<a class="headerlink" href="#get-site-collection-url-from-page" title="Permanent link">&para;</a></h2>
1821
+ <p>Using the library, you can get the site collection url by providing a page url</p>
1822
+ <div class="codehilite"><pre><span></span><span class="kr">import</span> <span class="p">{</span> <span class="nx">sp</span> <span class="p">}</span> <span class="nx">from</span> <span class="s2">&quot;@pnp/sp&quot;</span><span class="p">;</span>
1823
+
1824
+ <span class="nx">sp</span><span class="p">.</span><span class="nx">site</span><span class="p">.</span><span class="nx">getWebUrlFromPageUrl</span><span class="p">(</span><span class="s2">&quot;https://tenant.sharepoint.com/sites/test/Pages/test.aspx&quot;</span><span class="p">).</span><span class="nx">then</span><span class="p">(</span><span class="nx">d</span> <span class="o">=&gt;</span> <span class="p">{</span>
1825
+ <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">d</span><span class="p">);</span>
1826
+ <span class="p">});</span>
1827
+ </pre></div>
1828
+
1829
+
1830
+ <h2 id="join-a-hub-site">Join a hub site<a class="headerlink" href="#join-a-hub-site" title="Permanent link">&para;</a></h2>
1831
+ <p>Added in <em>1.2.4</em></p>
1832
+ <p><strong>Note:</strong> Works only in SharePoint online</p>
1833
+ <p>Join the current site collection to a hub site collection</p>
1834
+ <div class="codehilite"><pre><span></span><span class="kr">import</span> <span class="p">{</span> <span class="nx">sp</span><span class="p">,</span> <span class="nx">Site</span> <span class="p">}</span> <span class="nx">from</span> <span class="s2">&quot;@pnp/sp&quot;</span><span class="p">;</span>
1835
+
1836
+ <span class="kd">var</span> <span class="nx">site</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Site</span><span class="p">(</span><span class="s2">&quot;https://tenant.sharepoint.com/sites/HubSite/&quot;</span><span class="p">);</span>
1837
+
1838
+ <span class="kd">var</span> <span class="nx">hubSiteID</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span><span class="p">;</span>
1839
+
1840
+ <span class="nx">site</span><span class="p">.</span><span class="nx">select</span><span class="p">(</span><span class="s2">&quot;ID&quot;</span><span class="p">).</span><span class="nx">get</span><span class="p">().</span><span class="nx">then</span><span class="p">(</span><span class="nx">d</span> <span class="o">=&gt;</span> <span class="p">{</span>
1841
+ <span class="c1">// get ID of the hub site collection</span>
1842
+ <span class="nx">hubSiteID</span> <span class="o">=</span> <span class="nx">d</span><span class="p">.</span><span class="nx">Id</span><span class="p">;</span>
1843
+
1844
+ <span class="c1">// associate the current site collection the hub site collection</span>
1845
+ <span class="nx">sp</span><span class="p">.</span><span class="nx">site</span><span class="p">.</span><span class="nx">joinHubSite</span><span class="p">(</span><span class="nx">hubSiteID</span><span class="p">).</span><span class="nx">then</span><span class="p">(</span><span class="nx">d</span> <span class="o">=&gt;</span> <span class="p">{</span>
1846
+ <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">d</span><span class="p">);</span>
1847
+ <span class="p">});</span>
1848
+
1849
+ <span class="p">});</span>
1850
+ </pre></div>
1851
+
1852
+
1853
+ <h2 id="disassociate-the-current-site-collection-from-a-hub-site-collection">Disassociate the current site collection from a hub site collection<a class="headerlink" href="#disassociate-the-current-site-collection-from-a-hub-site-collection" title="Permanent link">&para;</a></h2>
1854
+ <p>Added in <em>1.2.4</em></p>
1855
+ <p><strong>Note:</strong> Works only in SharePoint online</p>
1856
+ <div class="codehilite"><pre><span></span><span class="kr">import</span> <span class="p">{</span> <span class="nx">sp</span> <span class="p">}</span> <span class="nx">from</span> <span class="s2">&quot;@pnp/sp&quot;</span><span class="p">;</span>
1857
+
1858
+ <span class="nx">sp</span><span class="p">.</span><span class="nx">site</span><span class="p">.</span><span class="nx">joinHubSite</span><span class="p">(</span><span class="s2">&quot;00000000-0000-0000-0000-000000000000&quot;</span><span class="p">).</span><span class="nx">then</span><span class="p">(</span><span class="nx">d</span> <span class="o">=&gt;</span> <span class="p">{</span>
1859
+ <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">d</span><span class="p">);</span>
1860
+ <span class="p">});</span>
1861
+ </pre></div>
1862
+
1863
+
1864
+ <h2 id="register-a-hub-site">Register a hub site<a class="headerlink" href="#register-a-hub-site" title="Permanent link">&para;</a></h2>
1865
+ <p>Added in <em>1.2.4</em></p>
1866
+ <p><strong>Note:</strong> Works only in SharePoint online</p>
1867
+ <p>Registers the current site collection as a hub site collection</p>
1868
+ <div class="codehilite"><pre><span></span><span class="kr">import</span> <span class="p">{</span> <span class="nx">sp</span> <span class="p">}</span> <span class="nx">from</span> <span class="s2">&quot;@pnp/sp&quot;</span><span class="p">;</span>
1869
+
1870
+ <span class="nx">sp</span><span class="p">.</span><span class="nx">site</span><span class="p">.</span><span class="nx">registerHubSite</span><span class="p">().</span><span class="nx">then</span><span class="p">(</span><span class="nx">d</span> <span class="o">=&gt;</span> <span class="p">{</span>
1871
+ <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">d</span><span class="p">);</span>
1872
+ <span class="p">});</span>
1873
+ </pre></div>
1874
+
1875
+
1876
+ <h2 id="un-register-a-hub-site">Un-Register a hub site<a class="headerlink" href="#un-register-a-hub-site" title="Permanent link">&para;</a></h2>
1877
+ <p>Added in <em>1.2.4</em></p>
1878
+ <p><strong>Note:</strong> Works only in SharePoint online</p>
1879
+ <p>Un-Registers the current site collection as a hub site collection</p>
1880
+ <div class="codehilite"><pre><span></span><span class="kr">import</span> <span class="p">{</span> <span class="nx">sp</span> <span class="p">}</span> <span class="nx">from</span> <span class="s2">&quot;@pnp/sp&quot;</span><span class="p">;</span>
1881
+
1882
+ <span class="nx">sp</span><span class="p">.</span><span class="nx">site</span><span class="p">.</span><span class="nx">unRegisterHubSite</span><span class="p">().</span><span class="nx">then</span><span class="p">(</span><span class="nx">d</span> <span class="o">=&gt;</span> <span class="p">{</span>
1883
+ <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">d</span><span class="p">);</span>
1884
+ <span class="p">});</span>
1885
+ </pre></div>
1886
+
1887
+
1888
+ <h2 id="create-a-modern-communication-site">Create a modern communication site<a class="headerlink" href="#create-a-modern-communication-site" title="Permanent link">&para;</a></h2>
1889
+ <p>Added in <em>1.2.6</em></p>
1890
+ <p><strong>Note:</strong> Works only in SharePoint online</p>
1891
+ <p>Creates a modern communication site.</p>
1892
+ <table>
1893
+ <thead>
1894
+ <tr>
1895
+ <th>Property</th>
1896
+ <th>Type</th>
1897
+ <th>Required</th>
1898
+ <th>Description</th>
1899
+ </tr>
1900
+ </thead>
1901
+ <tbody>
1902
+ <tr>
1903
+ <td>Title</td>
1904
+ <td>string</td>
1905
+ <td>yes</td>
1906
+ <td>The title of the site to create.</td>
1907
+ </tr>
1908
+ <tr>
1909
+ <td>lcid</td>
1910
+ <td>number</td>
1911
+ <td>yes</td>
1912
+ <td>The default language to use for the site.</td>
1913
+ </tr>
1914
+ <tr>
1915
+ <td>shareByEmailEnabled</td>
1916
+ <td>boolean</td>
1917
+ <td>yes</td>
1918
+ <td>If set to true, it will enable sharing files via Email. By default it is set to false</td>
1919
+ </tr>
1920
+ <tr>
1921
+ <td>url</td>
1922
+ <td>string</td>
1923
+ <td>yes</td>
1924
+ <td>The fully qualified URL (e.g. https://yourtenant.sharepoint.com/sites/mysitecollection) of the site.</td>
1925
+ </tr>
1926
+ <tr>
1927
+ <td>description</td>
1928
+ <td>string</td>
1929
+ <td>no</td>
1930
+ <td>The description of the communication site.</td>
1931
+ </tr>
1932
+ <tr>
1933
+ <td>classification</td>
1934
+ <td>string</td>
1935
+ <td>no</td>
1936
+ <td>The Site classification to use. For instance 'Contoso Classified'. See https://www.youtube.com/watch?v=E-8Z2ggHcS0 for more information</td>
1937
+ </tr>
1938
+ <tr>
1939
+ <td>siteDesignId</td>
1940
+ <td>string</td>
1941
+ <td>no</td>
1942
+ <td>The Guid of the site design to be used.</td>
1943
+ </tr>
1944
+ <tr>
1945
+ <td></td>
1946
+ <td></td>
1947
+ <td></td>
1948
+ <td>You can use the below default OOTB GUIDs:</td>
1949
+ </tr>
1950
+ <tr>
1951
+ <td></td>
1952
+ <td></td>
1953
+ <td></td>
1954
+ <td>Topic: null</td>
1955
+ </tr>
1956
+ <tr>
1957
+ <td></td>
1958
+ <td></td>
1959
+ <td></td>
1960
+ <td>Showcase: 6142d2a0-63a5-4ba0-aede-d9fefca2c767</td>
1961
+ </tr>
1962
+ <tr>
1963
+ <td></td>
1964
+ <td></td>
1965
+ <td></td>
1966
+ <td>Blank: f6cc5403-0d63-442e-96c0-285923709ffc</td>
1967
+ </tr>
1968
+ <tr>
1969
+ <td></td>
1970
+ <td></td>
1971
+ <td></td>
1972
+ <td></td>
1973
+ </tr>
1974
+ <tr>
1975
+ <td>hubSiteId</td>
1976
+ <td>string</td>
1977
+ <td>no</td>
1978
+ <td>The Guid of the already existing Hub site</td>
1979
+ </tr>
1980
+ <tr>
1981
+ <td>owner</td>
1982
+ <td>string</td>
1983
+ <td>no</td>
1984
+ <td>Required when using app-only context. Owner principal name e.g. user@tenant.onmicrosoft.com</td>
1985
+ </tr>
1986
+ </tbody>
1987
+ </table>
1988
+ <div class="codehilite"><pre><span></span><span class="kr">import</span> <span class="p">{</span> <span class="nx">sp</span> <span class="p">}</span> <span class="nx">from</span> <span class="s2">&quot;@pnp/sp&quot;</span><span class="p">;</span>
1989
+
1990
+ <span class="kr">const</span> <span class="nx">s</span> <span class="o">=</span> <span class="nx">await</span> <span class="nx">sp</span><span class="p">.</span><span class="nx">site</span><span class="p">.</span><span class="nx">createCommunicationSite</span><span class="p">(</span>
1991
+ <span class="s2">&quot;Title&quot;</span><span class="p">,</span>
1992
+ <span class="mi">1033</span><span class="p">,</span>
1993
+ <span class="kc">true</span><span class="p">,</span>
1994
+ <span class="s2">&quot;https://tenant.sharepoint.com/sites/commSite&quot;</span><span class="p">,</span>
1995
+ <span class="s2">&quot;Description&quot;</span><span class="p">,</span>
1996
+ <span class="s2">&quot;HBI&quot;</span><span class="p">,</span>
1997
+ <span class="s2">&quot;f6cc5403-0d63-442e-96c0-285923709ffc&quot;</span><span class="p">,</span>
1998
+ <span class="s2">&quot;a00ec589-ea9f-4dba-a34e-67e78d41e509&quot;</span><span class="p">,</span>
1999
+ <span class="s2">&quot;user@TENANT.onmicrosoft.com&quot;</span><span class="p">);</span>
2000
+ </pre></div>
2001
+
2002
+
2003
+ <h2 id="create-a-modern-team-site">Create a modern team site<a class="headerlink" href="#create-a-modern-team-site" title="Permanent link">&para;</a></h2>
2004
+ <p>Added in <em>1.2.6</em></p>
2005
+ <p><strong>Note:</strong> Works only in SharePoint online. It wont work with App only tokens</p>
2006
+ <p>Creates a modern team site backed by O365 group.</p>
2007
+ <table>
2008
+ <thead>
2009
+ <tr>
2010
+ <th>Property</th>
2011
+ <th>Type</th>
2012
+ <th>Required</th>
2013
+ <th>Description</th>
2014
+ </tr>
2015
+ </thead>
2016
+ <tbody>
2017
+ <tr>
2018
+ <td>displayName</td>
2019
+ <td>string</td>
2020
+ <td>yes</td>
2021
+ <td>The title/displayName of the site to be created.</td>
2022
+ </tr>
2023
+ <tr>
2024
+ <td>alias</td>
2025
+ <td>string</td>
2026
+ <td>yes</td>
2027
+ <td>Alias of the underlying Office 365 Group.</td>
2028
+ </tr>
2029
+ <tr>
2030
+ <td>isPublic</td>
2031
+ <td>boolean</td>
2032
+ <td>yes</td>
2033
+ <td>Defines whether the Office 365 Group will be public (default), or private.</td>
2034
+ </tr>
2035
+ <tr>
2036
+ <td>lcid</td>
2037
+ <td>number</td>
2038
+ <td>yes</td>
2039
+ <td>The language to use for the site. If not specified will default to English (1033).</td>
2040
+ </tr>
2041
+ <tr>
2042
+ <td>description</td>
2043
+ <td>string</td>
2044
+ <td>no</td>
2045
+ <td>The description of the modern team site.</td>
2046
+ </tr>
2047
+ <tr>
2048
+ <td>classification</td>
2049
+ <td>string</td>
2050
+ <td>no</td>
2051
+ <td>The Site classification to use. For instance 'Contoso Classified'. See https://www.youtube.com/watch?v=E-8Z2ggHcS0 for more information</td>
2052
+ </tr>
2053
+ <tr>
2054
+ <td>owners</td>
2055
+ <td>string array (string[])</td>
2056
+ <td>no</td>
2057
+ <td>The Owners of the site to be created</td>
2058
+ </tr>
2059
+ <tr>
2060
+ <td>hubSiteId</td>
2061
+ <td>string</td>
2062
+ <td>no</td>
2063
+ <td>The Guid of the already existing Hub site</td>
2064
+ </tr>
2065
+ </tbody>
2066
+ </table>
2067
+ <div class="codehilite"><pre><span></span><span class="kr">import</span> <span class="p">{</span> <span class="nx">sp</span> <span class="p">}</span> <span class="nx">from</span> <span class="s2">&quot;@pnp/sp&quot;</span><span class="p">;</span>
2068
+
2069
+ <span class="nx">sp</span><span class="p">.</span><span class="nx">site</span><span class="p">.</span><span class="nx">createModernTeamSite</span><span class="p">(</span>
2070
+ <span class="s2">&quot;displayName&quot;</span><span class="p">,</span>
2071
+ <span class="s2">&quot;alias&quot;</span><span class="p">,</span>
2072
+ <span class="kc">true</span><span class="p">,</span>
2073
+ <span class="mi">1033</span><span class="p">,</span>
2074
+ <span class="s2">&quot;description&quot;</span><span class="p">,</span>
2075
+ <span class="s2">&quot;HBI&quot;</span><span class="p">,</span>
2076
+ <span class="p">[</span><span class="s2">&quot;user1@tenant.onmicrosoft.com&quot;</span><span class="p">,</span><span class="s2">&quot;user2@tenant.onmicrosoft.com&quot;</span><span class="p">,</span><span class="s2">&quot;user3@tenant.onmicrosoft.com&quot;</span><span class="p">],</span>
2077
+ <span class="s2">&quot;a00ec589-ea9f-4dba-a34e-67e78d41e509&quot;</span><span class="p">)</span>
2078
+ <span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="nx">d</span> <span class="o">=&gt;</span> <span class="p">{</span>
2079
+ <span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">d</span><span class="p">);</span>
2080
+ <span class="p">});</span>
2081
+ </pre></div>
2082
+
2083
+
2084
+ <h2 id="delete-a-site-collection">Delete a site collection<a class="headerlink" href="#delete-a-site-collection" title="Permanent link">&para;</a></h2>
2085
+ <div class="codehilite"><pre><span></span><span class="kr">import</span> <span class="p">{</span> <span class="nx">sp</span> <span class="p">}</span> <span class="nx">from</span> <span class="s2">&quot;@pnp/sp&quot;</span><span class="p">;</span>
2086
+
2087
+ <span class="c1">// Delete the current site</span>
2088
+ <span class="nx">await</span> <span class="nx">sp</span><span class="p">.</span><span class="nx">site</span><span class="p">.</span><span class="k">delete</span><span class="p">();</span>
2089
+
2090
+ <span class="c1">// Specify which site to delete</span>
2091
+ <span class="kr">const</span> <span class="nx">siteUrl</span> <span class="o">=</span> <span class="s2">&quot;https://tenant.sharepoint.com/sites/tstpnpsitecoldelete5&quot;</span><span class="p">;</span>
2092
+ <span class="kr">const</span> <span class="nx">site2</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Site</span><span class="p">(</span><span class="nx">siteUrl</span><span class="p">);</span>
2093
+ <span class="nx">await</span> <span class="nx">site2</span><span class="p">.</span><span class="k">delete</span><span class="p">();</span>
2094
+ </pre></div>
2095
+
2096
+
2097
+
2098
+
2099
+
2100
+
2101
+
2102
+
2103
+
2104
+ </article>
2105
+ </div>
2106
+ </div>
2107
+ </main>
2108
+
2109
+
2110
+ <footer class="md-footer">
2111
+
2112
+ <div class="md-footer-nav">
2113
+ <nav class="md-footer-nav__inner md-grid">
2114
+
2115
+ <a href="../sharing/" title="Sharing" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
2116
+ <div class="md-flex__cell md-flex__cell--shrink">
2117
+ <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
2118
+ </div>
2119
+ <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
2120
+ <span class="md-flex__ellipsis">
2121
+ <span class="md-footer-nav__direction">
2122
+ Previous
2123
+ </span>
2124
+ Sharing
2125
+ </span>
2126
+ </div>
2127
+ </a>
2128
+
2129
+
2130
+ <a href="../sitedesigns/" title="Site Designs" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
2131
+ <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
2132
+ <span class="md-flex__ellipsis">
2133
+ <span class="md-footer-nav__direction">
2134
+ Next
2135
+ </span>
2136
+ Site Designs
2137
+ </span>
2138
+ </div>
2139
+ <div class="md-flex__cell md-flex__cell--shrink">
2140
+ <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
2141
+ </div>
2142
+ </a>
2143
+
2144
+ </nav>
2145
+ </div>
2146
+
2147
+ <div class="md-footer-meta md-typeset">
2148
+ <div class="md-footer-meta__inner md-grid">
2149
+ <div class="md-footer-copyright">
2150
+
2151
+ powered by
2152
+ <a href="https://www.mkdocs.org">MkDocs</a>
2153
+ and
2154
+ <a href="https://squidfunk.github.io/mkdocs-material/">
2155
+ Material for MkDocs</a>
2156
+ </div>
2157
+
2158
+
2159
+ <div class="md-footer-social">
2160
+ <link rel="stylesheet" href="../../../assets/fonts/font-awesome.css">
2161
+
2162
+ <a href="https://twitter.com/officedevpnp" class="md-footer-social__link fa fa-twitter"></a>
2163
+
2164
+ <a href="http://aka.ms/sppnp-videos" class="md-footer-social__link fa fa-youtube"></a>
2165
+
2166
+ <a href="https://aka.ms/sppnp" class="md-footer-social__link fa fa-link"></a>
2167
+
2168
+ </div>
2169
+
2170
+
2171
+ </div>
2172
+ </div>
2173
+ </footer>
2174
+
2175
+ </div>
2176
+
2177
+ <script src="../../../assets/javascripts/application.583bbe55.js"></script>
2178
+
2179
+ <script>app.initialize({version:"1.0.1",url:{base:"../../.."}})</script>
2180
+
2181
+
2182
+
2183
+ <img src="https://telemetry.sharepointpnp.com/@pnp/pnpjs/ghpages/pnpjs/sp/docs/sites/" alt="spacer" />
2184
+
2185
+ </body>
2186
+ </html>