@zxncij2390/monorepo3 3.18.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (921) hide show
  1. package/.eslintignore +16 -0
  2. package/.eslintrc.cjs +150 -0
  3. package/.github/ISSUE_TEMPLATE/bug-report.yml +178 -0
  4. package/.github/ISSUE_TEMPLATE/enhancement.yml +99 -0
  5. package/.github/ISSUE_TEMPLATE/question.yml +72 -0
  6. package/.github/ISSUE_TEMPLATE.md +39 -0
  7. package/.github/PULL_REQUEST_TEMPLATE.md +24 -0
  8. package/.github/workflows/lock.yml +18 -0
  9. package/.github/workflows/publish-buildsystem.yml +34 -0
  10. package/.github/workflows/publish-docs.yml +21 -0
  11. package/.github/workflows/publish.yml +40 -0
  12. package/.github/workflows/pull_request.yaml +28 -0
  13. package/.github/workflows/push.yaml +32 -0
  14. package/.github/workflows/v3-nightly.yml +40 -0
  15. package/.mocharc.cjs +68 -0
  16. package/.vscode/launch.json +103 -0
  17. package/.vscode/settings.json +17 -0
  18. package/.vscode/tasks.json +124 -0
  19. package/AUTHORS +13 -0
  20. package/CHANGELOG.md +33 -0
  21. package/CODE_OF_CONDUCT.md +6 -0
  22. package/CONTRIBUTING.md +9 -0
  23. package/LICENSE +25 -0
  24. package/README.md +66 -0
  25. package/buildsystem-config.ts +146 -0
  26. package/debug/launch/graph.ts +20 -0
  27. package/debug/launch/main.ts +38 -0
  28. package/debug/launch/setup.ts +50 -0
  29. package/debug/launch/sp.ts +21 -0
  30. package/debug/launch/tsconfig.json +27 -0
  31. package/debug/serve/main.ts +47 -0
  32. package/debug/serve/plumbing/local-module-resolver-plugin.ts +68 -0
  33. package/debug/serve/plumbing/run.ts +24 -0
  34. package/debug/serve/plumbing/serve.ts +27 -0
  35. package/debug/serve/plumbing/webpack.config.ts +43 -0
  36. package/debug/serve/spa.html +12 -0
  37. package/debug/serve/tsconfig.json +15 -0
  38. package/debug/spfx/.eslintrc.js +352 -0
  39. package/debug/spfx/README.md +73 -0
  40. package/debug/spfx/package-lock.json +57299 -0
  41. package/debug/spfx/package.json +38 -0
  42. package/debug/spfx/pnpjs-local-debug-start.js +19 -0
  43. package/debug/spfx/teams/f4c0e5ff-c402-46b7-8073-8cc506808d06_color.png +0 -0
  44. package/debug/spfx/teams/f4c0e5ff-c402-46b7-8073-8cc506808d06_outline.png +0 -0
  45. package/docs/_theme/main.html +5 -0
  46. package/docs/azidjsclient/index.md +36 -0
  47. package/docs/concepts/adv-clientside-pages.md +169 -0
  48. package/docs/concepts/auth-browser.md +42 -0
  49. package/docs/concepts/auth-nodejs.md +101 -0
  50. package/docs/concepts/auth-spfx.md +76 -0
  51. package/docs/concepts/authentication.md +42 -0
  52. package/docs/concepts/batching-caching.md +77 -0
  53. package/docs/concepts/batching.md +257 -0
  54. package/docs/concepts/calling-other-endpoints.md +213 -0
  55. package/docs/concepts/custom-bundle.md +15 -0
  56. package/docs/concepts/error-handling.md +245 -0
  57. package/docs/concepts/invokable.md +7 -0
  58. package/docs/concepts/nightly-builds.md +19 -0
  59. package/docs/concepts/project-preset.md +123 -0
  60. package/docs/concepts/selective-imports.md +106 -0
  61. package/docs/concepts/typings.md +23 -0
  62. package/docs/contributing/debug-tests.md +76 -0
  63. package/docs/contributing/debugging.md +135 -0
  64. package/docs/contributing/documentation.md +34 -0
  65. package/docs/contributing/extending-the-library.md +223 -0
  66. package/docs/contributing/index.md +22 -0
  67. package/docs/contributing/local-debug-configuration.md +28 -0
  68. package/docs/contributing/npm-scripts.md +148 -0
  69. package/docs/contributing/pull-requests.md +27 -0
  70. package/docs/contributing/settings.md +98 -0
  71. package/docs/contributing/setup-dev-machine.md +36 -0
  72. package/docs/core/behavior-recipes.md +199 -0
  73. package/docs/core/behaviors.md +179 -0
  74. package/docs/core/moments.md +215 -0
  75. package/docs/core/observers.md +100 -0
  76. package/docs/core/storage.md +90 -0
  77. package/docs/core/timeline.md +190 -0
  78. package/docs/core/util.md +191 -0
  79. package/docs/css/extra.css +33 -0
  80. package/docs/getting-started.md +361 -0
  81. package/docs/graph/behaviors.md +267 -0
  82. package/docs/graph/bookings.md +180 -0
  83. package/docs/graph/calendars.md +270 -0
  84. package/docs/graph/cloud-communications.md +40 -0
  85. package/docs/graph/columns.md +125 -0
  86. package/docs/graph/contacts.md +298 -0
  87. package/docs/graph/content-types.md +193 -0
  88. package/docs/graph/directoryobjects.md +106 -0
  89. package/docs/graph/groups.md +164 -0
  90. package/docs/graph/insights.md +151 -0
  91. package/docs/graph/invitations.md +22 -0
  92. package/docs/graph/items.md +38 -0
  93. package/docs/graph/lists.md +87 -0
  94. package/docs/graph/messages.md +20 -0
  95. package/docs/graph/onedrive.md +614 -0
  96. package/docs/graph/outlook.md +82 -0
  97. package/docs/graph/photos.md +71 -0
  98. package/docs/graph/planner.md +249 -0
  99. package/docs/graph/search.md +25 -0
  100. package/docs/graph/shares.md +44 -0
  101. package/docs/graph/sites.md +47 -0
  102. package/docs/graph/subscriptions.md +79 -0
  103. package/docs/graph/teams.md +293 -0
  104. package/docs/graph/users.md +134 -0
  105. package/docs/img/ConsoleListenerColors.png +0 -0
  106. package/docs/img/Logo.png +0 -0
  107. package/docs/img/PnPJS_FluentAPI.gif +0 -0
  108. package/docs/img/SPFx-On-Premesis-2016-1.png +0 -0
  109. package/docs/img/TimelineArchitecture.jpg +0 -0
  110. package/docs/img/csp_copyccvalue.png +0 -0
  111. package/docs/img/csp_networktab.png +0 -0
  112. package/docs/img/office365-header-icon.png +0 -0
  113. package/docs/img/usage-2020-eoy.png +0 -0
  114. package/docs/img/usage-2021-eoy.png +0 -0
  115. package/docs/img/usage-2022-eoy.png +0 -0
  116. package/docs/index.md +56 -0
  117. package/docs/logging/index.md +262 -0
  118. package/docs/msaljsclient/index.md +33 -0
  119. package/docs/news/2020-year-in-review.md +162 -0
  120. package/docs/news/2021-year-in-review.md +148 -0
  121. package/docs/news/2022-year-in-review.md +122 -0
  122. package/docs/nodejs/behaviors.md +164 -0
  123. package/docs/nodejs/sp-extensions.md +99 -0
  124. package/docs/packages.md +53 -0
  125. package/docs/queryable/behaviors.md +496 -0
  126. package/docs/queryable/extensions.md +204 -0
  127. package/docs/queryable/queryable.md +385 -0
  128. package/docs/sp/alias-parameters.md +76 -0
  129. package/docs/sp/alm.md +139 -0
  130. package/docs/sp/attachments.md +157 -0
  131. package/docs/sp/behaviors.md +142 -0
  132. package/docs/sp/clientside-pages.md +1048 -0
  133. package/docs/sp/column-defaults.md +241 -0
  134. package/docs/sp/comments-likes.md +302 -0
  135. package/docs/sp/content-types.md +131 -0
  136. package/docs/sp/context-info.md +67 -0
  137. package/docs/sp/favorites.md +91 -0
  138. package/docs/sp/features.md +83 -0
  139. package/docs/sp/fields.md +668 -0
  140. package/docs/sp/files.md +559 -0
  141. package/docs/sp/folders.md +532 -0
  142. package/docs/sp/forms.md +22 -0
  143. package/docs/sp/groupSiteManager.md +40 -0
  144. package/docs/sp/hubsites.md +140 -0
  145. package/docs/sp/items.md +601 -0
  146. package/docs/sp/lists.md +572 -0
  147. package/docs/sp/navigation.md +171 -0
  148. package/docs/sp/permissions.md +82 -0
  149. package/docs/sp/profiles.md +407 -0
  150. package/docs/sp/publishing-sitepageservice.md +16 -0
  151. package/docs/sp/recycle-bin.md +72 -0
  152. package/docs/sp/regional-settings.md +108 -0
  153. package/docs/sp/related-items.md +136 -0
  154. package/docs/sp/search.md +207 -0
  155. package/docs/sp/security.md +196 -0
  156. package/docs/sp/sharing.md +273 -0
  157. package/docs/sp/site-designs.md +117 -0
  158. package/docs/sp/site-groups.md +144 -0
  159. package/docs/sp/site-scripts.md +123 -0
  160. package/docs/sp/site-users.md +211 -0
  161. package/docs/sp/sites.md +269 -0
  162. package/docs/sp/social.md +182 -0
  163. package/docs/sp/sp-utilities-utility.md +159 -0
  164. package/docs/sp/subscriptions.md +79 -0
  165. package/docs/sp/taxonomy.md +470 -0
  166. package/docs/sp/tenant-properties.md +55 -0
  167. package/docs/sp/user-custom-actions.md +95 -0
  168. package/docs/sp/views.md +226 -0
  169. package/docs/sp/webs.md +947 -0
  170. package/docs/sp-admin/index.md +139 -0
  171. package/docs/transition-guide.md +87 -0
  172. package/docs/v1/404.html +1611 -0
  173. package/docs/v1/assets/fonts/font-awesome.css +4 -0
  174. package/docs/v1/assets/fonts/material-icons.css +13 -0
  175. package/docs/v1/assets/fonts/specimen/FontAwesome.ttf +0 -0
  176. package/docs/v1/assets/fonts/specimen/FontAwesome.woff +0 -0
  177. package/docs/v1/assets/fonts/specimen/FontAwesome.woff2 +0 -0
  178. package/docs/v1/assets/fonts/specimen/MaterialIcons-Regular.ttf +0 -0
  179. package/docs/v1/assets/fonts/specimen/MaterialIcons-Regular.woff +0 -0
  180. package/docs/v1/assets/fonts/specimen/MaterialIcons-Regular.woff2 +0 -0
  181. package/docs/v1/assets/images/favicon.png +0 -0
  182. package/docs/v1/assets/images/icons/bitbucket.1b09e088.svg +20 -0
  183. package/docs/v1/assets/images/icons/github.f0b8504a.svg +18 -0
  184. package/docs/v1/assets/images/icons/gitlab.6dd19c00.svg +38 -0
  185. package/docs/v1/assets/javascripts/application.583bbe55.js +1 -0
  186. package/docs/v1/assets/javascripts/lunr/lunr.da.js +1 -0
  187. package/docs/v1/assets/javascripts/lunr/lunr.de.js +1 -0
  188. package/docs/v1/assets/javascripts/lunr/lunr.du.js +1 -0
  189. package/docs/v1/assets/javascripts/lunr/lunr.es.js +1 -0
  190. package/docs/v1/assets/javascripts/lunr/lunr.fi.js +1 -0
  191. package/docs/v1/assets/javascripts/lunr/lunr.fr.js +1 -0
  192. package/docs/v1/assets/javascripts/lunr/lunr.hu.js +1 -0
  193. package/docs/v1/assets/javascripts/lunr/lunr.it.js +1 -0
  194. package/docs/v1/assets/javascripts/lunr/lunr.jp.js +1 -0
  195. package/docs/v1/assets/javascripts/lunr/lunr.multi.js +1 -0
  196. package/docs/v1/assets/javascripts/lunr/lunr.no.js +1 -0
  197. package/docs/v1/assets/javascripts/lunr/lunr.pt.js +1 -0
  198. package/docs/v1/assets/javascripts/lunr/lunr.ro.js +1 -0
  199. package/docs/v1/assets/javascripts/lunr/lunr.ru.js +1 -0
  200. package/docs/v1/assets/javascripts/lunr/lunr.stemmer.support.js +1 -0
  201. package/docs/v1/assets/javascripts/lunr/lunr.sv.js +1 -0
  202. package/docs/v1/assets/javascripts/lunr/lunr.tr.js +1 -0
  203. package/docs/v1/assets/javascripts/lunr/tinyseg.js +1 -0
  204. package/docs/v1/assets/javascripts/modernizr.1aa3b519.js +1 -0
  205. package/docs/v1/assets/stylesheets/application-palette.22915126.css +1176 -0
  206. package/docs/v1/assets/stylesheets/application.451f80e5.css +2552 -0
  207. package/docs/v1/common/docs/adalclient/index.html +1994 -0
  208. package/docs/v1/common/docs/collections/index.html +1786 -0
  209. package/docs/v1/common/docs/custom-httpclientimpl/index.html +1798 -0
  210. package/docs/v1/common/docs/index.html +1787 -0
  211. package/docs/v1/common/docs/libconfig/index.html +1930 -0
  212. package/docs/v1/common/docs/netutil/index.html +1860 -0
  213. package/docs/v1/common/docs/storage/index.html +1850 -0
  214. package/docs/v1/common/docs/util/index.html +2058 -0
  215. package/docs/v1/config-store/docs/configuration/index.html +1730 -0
  216. package/docs/v1/config-store/docs/index.html +1761 -0
  217. package/docs/v1/config-store/docs/providers/index.html +1782 -0
  218. package/docs/v1/documentation/SPFx-On-Premesis-2016/index.html +1720 -0
  219. package/docs/v1/documentation/beta-versions/index.html +1742 -0
  220. package/docs/v1/documentation/css/extra.css +33 -0
  221. package/docs/v1/documentation/debugging/index.html +2098 -0
  222. package/docs/v1/documentation/deployment/index.html +1972 -0
  223. package/docs/v1/documentation/documentation/index.html +1760 -0
  224. package/docs/v1/documentation/getting-started/index.html +2280 -0
  225. package/docs/v1/documentation/getting-started-dev/index.html +1799 -0
  226. package/docs/v1/documentation/gulp-commands/index.html +2100 -0
  227. package/docs/v1/documentation/img/Logo.png +0 -0
  228. package/docs/v1/documentation/img/PnPJS_FluentAPI.gif +0 -0
  229. package/docs/v1/documentation/img/SPFx-On-Premesis-2016-1.png +0 -0
  230. package/docs/v1/documentation/img/office365-header-icon.png +0 -0
  231. package/docs/v1/documentation/img/pnpjs-common-uml.svg +220 -0
  232. package/docs/v1/documentation/img/pnpjs-config-store-uml.svg +56 -0
  233. package/docs/v1/documentation/img/pnpjs-graph-uml.svg +602 -0
  234. package/docs/v1/documentation/img/pnpjs-logging-uml.svg +59 -0
  235. package/docs/v1/documentation/img/pnpjs-nodejs-uml.svg +85 -0
  236. package/docs/v1/documentation/img/pnpjs-odata-uml.svg +253 -0
  237. package/docs/v1/documentation/img/pnpjs-sp-addinhelpers-uml.svg +48 -0
  238. package/docs/v1/documentation/img/pnpjs-sp-clientsvc-uml.svg +167 -0
  239. package/docs/v1/documentation/img/pnpjs-sp-taxonomy-uml.svg +458 -0
  240. package/docs/v1/documentation/img/pnpjs-sp-uml.svg +2833 -0
  241. package/docs/v1/documentation/package-structure/index.html +1875 -0
  242. package/docs/v1/documentation/packages/index.html +1741 -0
  243. package/docs/v1/documentation/polyfill/index.html +1877 -0
  244. package/docs/v1/documentation/theme/main.html +5 -0
  245. package/docs/v1/documentation/transition-guide/index.html +1977 -0
  246. package/docs/v1/graph/docs/contacts/index.html +2080 -0
  247. package/docs/v1/graph/docs/directoryobjects/index.html +1865 -0
  248. package/docs/v1/graph/docs/index.html +1858 -0
  249. package/docs/v1/graph/docs/insights/index.html +1698 -0
  250. package/docs/v1/graph/docs/invitations/index.html +1742 -0
  251. package/docs/v1/graph/docs/onedrive/index.html +2086 -0
  252. package/docs/v1/graph/docs/people/index.html +1664 -0
  253. package/docs/v1/graph/docs/planner/index.html +2097 -0
  254. package/docs/v1/graph/docs/security/index.html +1692 -0
  255. package/docs/v1/graph/docs/sites/index.html +2043 -0
  256. package/docs/v1/graph/docs/subscriptions/index.html +1835 -0
  257. package/docs/v1/graph/docs/teams/index.html +2097 -0
  258. package/docs/v1/index.html +1889 -0
  259. package/docs/v1/logging/docs/index.html +2045 -0
  260. package/docs/v1/nodejs/docs/adal-certificate-fetch-client/index.html +1676 -0
  261. package/docs/v1/nodejs/docs/adal-fetch-client/index.html +1713 -0
  262. package/docs/v1/nodejs/docs/bearer-token-fetch-client/index.html +1712 -0
  263. package/docs/v1/nodejs/docs/index.html +1764 -0
  264. package/docs/v1/nodejs/docs/provider-hosted-app/index.html +1725 -0
  265. package/docs/v1/nodejs/docs/proxy/index.html +1699 -0
  266. package/docs/v1/nodejs/docs/sp-fetch-client/index.html +1895 -0
  267. package/docs/v1/odata/docs/caching/index.html +1988 -0
  268. package/docs/v1/odata/docs/core/index.html +1829 -0
  269. package/docs/v1/odata/docs/index.html +1781 -0
  270. package/docs/v1/odata/docs/odata-batch/index.html +1755 -0
  271. package/docs/v1/odata/docs/parsers/index.html +1862 -0
  272. package/docs/v1/odata/docs/pipeline/index.html +1811 -0
  273. package/docs/v1/odata/docs/queryable/index.html +1967 -0
  274. package/docs/v1/pnpjs/docs/index.html +1814 -0
  275. package/docs/v1/search/search_index.json +1 -0
  276. package/docs/v1/sitemap.xml +428 -0
  277. package/docs/v1/sitemap.xml.gz +0 -0
  278. package/docs/v1/sp/docs/alias-parameters/index.html +1830 -0
  279. package/docs/v1/sp/docs/alm/index.html +1920 -0
  280. package/docs/v1/sp/docs/attachments/index.html +1998 -0
  281. package/docs/v1/sp/docs/client-side-pages/index.html +2031 -0
  282. package/docs/v1/sp/docs/comments-likes/index.html +1958 -0
  283. package/docs/v1/sp/docs/content-types/index.html +1758 -0
  284. package/docs/v1/sp/docs/entity-merging/index.html +1838 -0
  285. package/docs/v1/sp/docs/features/index.html +1824 -0
  286. package/docs/v1/sp/docs/fields/index.html +2031 -0
  287. package/docs/v1/sp/docs/files/index.html +2178 -0
  288. package/docs/v1/sp/docs/index.html +1894 -0
  289. package/docs/v1/sp/docs/items/index.html +2362 -0
  290. package/docs/v1/sp/docs/navigation-service/index.html +1791 -0
  291. package/docs/v1/sp/docs/permissions/index.html +1860 -0
  292. package/docs/v1/sp/docs/profiles/index.html +1794 -0
  293. package/docs/v1/sp/docs/related-items/index.html +1886 -0
  294. package/docs/v1/sp/docs/search/index.html +1830 -0
  295. package/docs/v1/sp/docs/sharing/index.html +2058 -0
  296. package/docs/v1/sp/docs/sitedesigns/index.html +1851 -0
  297. package/docs/v1/sp/docs/sites/index.html +2186 -0
  298. package/docs/v1/sp/docs/social/index.html +2011 -0
  299. package/docs/v1/sp/docs/sp-utilities-utility/index.html +2061 -0
  300. package/docs/v1/sp/docs/tenant-properties/index.html +1795 -0
  301. package/docs/v1/sp/docs/views/index.html +1869 -0
  302. package/docs/v1/sp/docs/webs/index.html +1972 -0
  303. package/docs/v1/sp-addinhelpers/docs/index.html +1771 -0
  304. package/docs/v1/sp-addinhelpers/docs/sp-request-executor-client/index.html +1760 -0
  305. package/docs/v1/sp-addinhelpers/docs/sp-rest-addin/index.html +1711 -0
  306. package/docs/v1/sp-clientsvc/docs/index.html +1736 -0
  307. package/docs/v1/sp-taxonomy/docs/index.html +1887 -0
  308. package/docs/v1/sp-taxonomy/docs/labels/index.html +1827 -0
  309. package/docs/v1/sp-taxonomy/docs/term-groups/index.html +1875 -0
  310. package/docs/v1/sp-taxonomy/docs/term-sets/index.html +1946 -0
  311. package/docs/v1/sp-taxonomy/docs/term-stores/index.html +2111 -0
  312. package/docs/v1/sp-taxonomy/docs/terms/index.html +2036 -0
  313. package/docs/v1/sp-taxonomy/docs/utilities/index.html +1783 -0
  314. package/docs/v2/404.html +2108 -0
  315. package/docs/v2/SPFx-on-premises/index.html +2278 -0
  316. package/docs/v2/_theme/main.html +5 -0
  317. package/docs/v2/adaljsclient/adalclient/index.html +15 -0
  318. package/docs/v2/adaljsclient/index.html +15 -0
  319. package/docs/v2/assets/images/favicon.png +0 -0
  320. package/docs/v2/assets/javascripts/bundle.9554a270.min.js +2 -0
  321. package/docs/v2/assets/javascripts/bundle.9554a270.min.js.map +1 -0
  322. package/docs/v2/assets/javascripts/lunr/min/lunr.ar.min.js +1 -0
  323. package/docs/v2/assets/javascripts/lunr/min/lunr.da.min.js +18 -0
  324. package/docs/v2/assets/javascripts/lunr/min/lunr.de.min.js +18 -0
  325. package/docs/v2/assets/javascripts/lunr/min/lunr.du.min.js +18 -0
  326. package/docs/v2/assets/javascripts/lunr/min/lunr.es.min.js +18 -0
  327. package/docs/v2/assets/javascripts/lunr/min/lunr.fi.min.js +18 -0
  328. package/docs/v2/assets/javascripts/lunr/min/lunr.fr.min.js +18 -0
  329. package/docs/v2/assets/javascripts/lunr/min/lunr.hu.min.js +18 -0
  330. package/docs/v2/assets/javascripts/lunr/min/lunr.it.min.js +18 -0
  331. package/docs/v2/assets/javascripts/lunr/min/lunr.ja.min.js +1 -0
  332. package/docs/v2/assets/javascripts/lunr/min/lunr.jp.min.js +1 -0
  333. package/docs/v2/assets/javascripts/lunr/min/lunr.multi.min.js +1 -0
  334. package/docs/v2/assets/javascripts/lunr/min/lunr.nl.min.js +18 -0
  335. package/docs/v2/assets/javascripts/lunr/min/lunr.no.min.js +18 -0
  336. package/docs/v2/assets/javascripts/lunr/min/lunr.pt.min.js +18 -0
  337. package/docs/v2/assets/javascripts/lunr/min/lunr.ro.min.js +18 -0
  338. package/docs/v2/assets/javascripts/lunr/min/lunr.ru.min.js +18 -0
  339. package/docs/v2/assets/javascripts/lunr/min/lunr.stemmer.support.min.js +1 -0
  340. package/docs/v2/assets/javascripts/lunr/min/lunr.sv.min.js +18 -0
  341. package/docs/v2/assets/javascripts/lunr/min/lunr.tr.min.js +18 -0
  342. package/docs/v2/assets/javascripts/lunr/min/lunr.vi.min.js +1 -0
  343. package/docs/v2/assets/javascripts/lunr/tinyseg.min.js +1 -0
  344. package/docs/v2/assets/javascripts/vendor.77e55a48.min.js +30 -0
  345. package/docs/v2/assets/javascripts/vendor.77e55a48.min.js.map +1 -0
  346. package/docs/v2/assets/javascripts/worker/search.4ac00218.min.js +59 -0
  347. package/docs/v2/assets/javascripts/worker/search.4ac00218.min.js.map +1 -0
  348. package/docs/v2/assets/stylesheets/main.38780c08.min.css +3 -0
  349. package/docs/v2/assets/stylesheets/main.38780c08.min.css.map +1 -0
  350. package/docs/v2/assets/stylesheets/palette.3f72e892.min.css +3 -0
  351. package/docs/v2/assets/stylesheets/palette.3f72e892.min.css.map +1 -0
  352. package/docs/v2/authentication/adaljsclient/index.html +2510 -0
  353. package/docs/v2/authentication/bearertokenclient/index.html +2251 -0
  354. package/docs/v2/authentication/client-spa/index.html +2206 -0
  355. package/docs/v2/authentication/client-spfx/index.html +2397 -0
  356. package/docs/v2/authentication/index.html +2307 -0
  357. package/docs/v2/authentication/lambdaclient/index.html +2304 -0
  358. package/docs/v2/authentication/msaljsclient/index.html +2413 -0
  359. package/docs/v2/authentication/server-nodejs/index.html +2404 -0
  360. package/docs/v2/authentication/sp-app-registration/index.html +2273 -0
  361. package/docs/v2/common/collections/index.html +2277 -0
  362. package/docs/v2/common/custom-httpclientimpl/index.html +2300 -0
  363. package/docs/v2/common/index.html +2262 -0
  364. package/docs/v2/common/libconfig/index.html +2413 -0
  365. package/docs/v2/common/netutil/index.html +2350 -0
  366. package/docs/v2/common/storage/index.html +2339 -0
  367. package/docs/v2/common/util/index.html +2638 -0
  368. package/docs/v2/concepts/configuration/index.html +2685 -0
  369. package/docs/v2/concepts/custom-bundle/index.html +2279 -0
  370. package/docs/v2/concepts/error-handling/index.html +2539 -0
  371. package/docs/v2/concepts/ie11-mode/index.html +2278 -0
  372. package/docs/v2/concepts/invokable/index.html +2254 -0
  373. package/docs/v2/concepts/polyfill/index.html +2401 -0
  374. package/docs/v2/concepts/selective-imports/index.html +2360 -0
  375. package/docs/v2/concepts/settings/index.html +2551 -0
  376. package/docs/v2/config-store/configuration/index.html +2226 -0
  377. package/docs/v2/config-store/index.html +2239 -0
  378. package/docs/v2/config-store/providers/index.html +2275 -0
  379. package/docs/v2/contributing/debug-tests/index.html +2323 -0
  380. package/docs/v2/contributing/debugging/index.html +2514 -0
  381. package/docs/v2/contributing/documentation/index.html +2291 -0
  382. package/docs/v2/contributing/extending-the-library/index.html +2521 -0
  383. package/docs/v2/contributing/index.html +2270 -0
  384. package/docs/v2/contributing/local-debug-configuration/index.html +2284 -0
  385. package/docs/v2/contributing/pull-requests/index.html +2261 -0
  386. package/docs/v2/contributing/setup-dev-machine/index.html +2284 -0
  387. package/docs/v2/css/extra.css +33 -0
  388. package/docs/v2/debug-tests/index.html +15 -0
  389. package/docs/v2/debugging/index.html +15 -0
  390. package/docs/v2/documentation/index.html +15 -0
  391. package/docs/v2/getting-started/index.html +2789 -0
  392. package/docs/v2/getting-started-dev/index.html +15 -0
  393. package/docs/v2/graph/calendars/index.html +2569 -0
  394. package/docs/v2/graph/contacts/index.html +2673 -0
  395. package/docs/v2/graph/directoryobjects/index.html +2402 -0
  396. package/docs/v2/graph/groups/index.html +2488 -0
  397. package/docs/v2/graph/index.html +2333 -0
  398. package/docs/v2/graph/insights/index.html +2478 -0
  399. package/docs/v2/graph/invitations/index.html +2273 -0
  400. package/docs/v2/graph/onedrive/index.html +2617 -0
  401. package/docs/v2/graph/outlook/index.html +2363 -0
  402. package/docs/v2/graph/photos/index.html +2351 -0
  403. package/docs/v2/graph/planner/index.html +2628 -0
  404. package/docs/v2/graph/search/index.html +2264 -0
  405. package/docs/v2/graph/subscriptions/index.html +2333 -0
  406. package/docs/v2/graph/teams/index.html +2619 -0
  407. package/docs/v2/graph/users/index.html +2461 -0
  408. package/docs/v2/img/ConsoleListenerColors.png +0 -0
  409. package/docs/v2/img/Logo.png +0 -0
  410. package/docs/v2/img/PnPJS_FluentAPI.gif +0 -0
  411. package/docs/v2/img/SPFx-On-Premesis-2016-1.png +0 -0
  412. package/docs/v2/img/office365-header-icon.png +0 -0
  413. package/docs/v2/img/usage-2020-eoy.png +0 -0
  414. package/docs/v2/index.html +2410 -0
  415. package/docs/v2/logging/index.html +2622 -0
  416. package/docs/v2/news/2020-year-in-review/index.html +2525 -0
  417. package/docs/v2/nodejs/adal-fetch-client/index.html +2204 -0
  418. package/docs/v2/nodejs/bearer-token-fetch-client/index.html +2203 -0
  419. package/docs/v2/nodejs/index.html +2261 -0
  420. package/docs/v2/nodejs/provider-hosted-app/index.html +2220 -0
  421. package/docs/v2/nodejs/proxy/index.html +2238 -0
  422. package/docs/v2/nodejs/sp-extensions/index.html +2362 -0
  423. package/docs/v2/nodejs/sp-fetch-client/index.html +2294 -0
  424. package/docs/v2/nodejs-support/index.html +2398 -0
  425. package/docs/v2/npm-scripts/index.html +2521 -0
  426. package/docs/v2/odata/caching/index.html +2465 -0
  427. package/docs/v2/odata/core/index.html +2322 -0
  428. package/docs/v2/odata/debug/index.html +2358 -0
  429. package/docs/v2/odata/extensions/index.html +2581 -0
  430. package/docs/v2/odata/index.html +2259 -0
  431. package/docs/v2/odata/odata-batch/index.html +2250 -0
  432. package/docs/v2/odata/parsers/index.html +2355 -0
  433. package/docs/v2/odata/pipeline/index.html +2297 -0
  434. package/docs/v2/odata/queryable/index.html +2455 -0
  435. package/docs/v2/packages/index.html +2251 -0
  436. package/docs/v2/pnpjs/index.html +2281 -0
  437. package/docs/v2/search/search_index.json +1 -0
  438. package/docs/v2/sitemap.xml +483 -0
  439. package/docs/v2/sitemap.xml.gz +0 -0
  440. package/docs/v2/sp/alias-parameters/index.html +2330 -0
  441. package/docs/v2/sp/alm/index.html +2433 -0
  442. package/docs/v2/sp/attachments/index.html +2504 -0
  443. package/docs/v2/sp/clientside-pages/index.html +3477 -0
  444. package/docs/v2/sp/column-defaults/index.html +2540 -0
  445. package/docs/v2/sp/comments-likes/index.html +2646 -0
  446. package/docs/v2/sp/content-types/index.html +2462 -0
  447. package/docs/v2/sp/custom-irequestclient/index.html +2339 -0
  448. package/docs/v2/sp/entity-merging/index.html +2325 -0
  449. package/docs/v2/sp/features/index.html +2440 -0
  450. package/docs/v2/sp/fields/index.html +3103 -0
  451. package/docs/v2/sp/files/index.html +2949 -0
  452. package/docs/v2/sp/folders/index.html +2968 -0
  453. package/docs/v2/sp/forms/index.html +2289 -0
  454. package/docs/v2/sp/hubsites/index.html +2485 -0
  455. package/docs/v2/sp/index.html +2328 -0
  456. package/docs/v2/sp/items/index.html +2974 -0
  457. package/docs/v2/sp/lists/index.html +3387 -0
  458. package/docs/v2/sp/navigation/index.html +2535 -0
  459. package/docs/v2/sp/permissions/index.html +2338 -0
  460. package/docs/v2/sp/profiles/index.html +2806 -0
  461. package/docs/v2/sp/regional-settings/index.html +2394 -0
  462. package/docs/v2/sp/related-items/index.html +2417 -0
  463. package/docs/v2/sp/search/index.html +2474 -0
  464. package/docs/v2/sp/security/index.html +2432 -0
  465. package/docs/v2/sp/sharing/index.html +2589 -0
  466. package/docs/v2/sp/site-designs/index.html +2414 -0
  467. package/docs/v2/sp/site-groups/index.html +2504 -0
  468. package/docs/v2/sp/site-scripts/index.html +2433 -0
  469. package/docs/v2/sp/site-users/index.html +2641 -0
  470. package/docs/v2/sp/sites/index.html +2727 -0
  471. package/docs/v2/sp/social/index.html +2517 -0
  472. package/docs/v2/sp/sp-utilities-utility/index.html +2460 -0
  473. package/docs/v2/sp/subscriptions/index.html +2395 -0
  474. package/docs/v2/sp/taxonomy/index.html +2565 -0
  475. package/docs/v2/sp/tenant-properties/index.html +2286 -0
  476. package/docs/v2/sp/user-custom-actions/index.html +2424 -0
  477. package/docs/v2/sp/views/index.html +2652 -0
  478. package/docs/v2/sp/webs/index.html +4190 -0
  479. package/docs/v2/sp-addinhelpers/index.html +2274 -0
  480. package/docs/v2/sp-addinhelpers/sp-request-executor-client/index.html +2253 -0
  481. package/docs/v2/sp-addinhelpers/sp-rest-addin/index.html +2206 -0
  482. package/docs/v2/transition-guide/index.html +2435 -0
  483. package/mkdocs-requirements.txt +2 -0
  484. package/mkdocs.yml +188 -0
  485. package/package.json +96 -0
  486. package/packages/azidjsclient/index.ts +68 -0
  487. package/packages/azidjsclient/package.json +13 -0
  488. package/packages/azidjsclient/tsconfig.json +12 -0
  489. package/packages/core/behaviors/assign-from.ts +17 -0
  490. package/packages/core/behaviors/copy-from.ts +58 -0
  491. package/packages/core/extendable.ts +193 -0
  492. package/packages/core/index.ts +11 -0
  493. package/packages/core/moments.ts +117 -0
  494. package/packages/core/package.json +10 -0
  495. package/packages/core/storage.ts +274 -0
  496. package/packages/core/timeline.ts +387 -0
  497. package/packages/core/tsconfig.json +10 -0
  498. package/packages/core/util.ts +169 -0
  499. package/packages/graph/attachments/conversations.ts +14 -0
  500. package/packages/graph/attachments/index.ts +8 -0
  501. package/packages/graph/attachments/types.ts +37 -0
  502. package/packages/graph/batching.ts +408 -0
  503. package/packages/graph/behaviors/consistency-level.ts +17 -0
  504. package/packages/graph/behaviors/defaults.ts +41 -0
  505. package/packages/graph/behaviors/endpoint.ts +22 -0
  506. package/packages/graph/behaviors/graphbrowser.ts +38 -0
  507. package/packages/graph/behaviors/paged.ts +109 -0
  508. package/packages/graph/behaviors/spfx.ts +46 -0
  509. package/packages/graph/behaviors/telemetry.ts +19 -0
  510. package/packages/graph/bookings/funcs.ts +18 -0
  511. package/packages/graph/bookings/index.ts +62 -0
  512. package/packages/graph/bookings/types.ts +352 -0
  513. package/packages/graph/calendars/funcs.ts +58 -0
  514. package/packages/graph/calendars/groups.ts +19 -0
  515. package/packages/graph/calendars/index.ts +18 -0
  516. package/packages/graph/calendars/types.ts +73 -0
  517. package/packages/graph/calendars/users.ts +28 -0
  518. package/packages/graph/cloud-communications/index.ts +24 -0
  519. package/packages/graph/cloud-communications/types.ts +32 -0
  520. package/packages/graph/cloud-communications/users.ts +15 -0
  521. package/packages/graph/columns/addColumns.ts +28 -0
  522. package/packages/graph/columns/content-types.ts +44 -0
  523. package/packages/graph/columns/index.ts +14 -0
  524. package/packages/graph/columns/lists.ts +33 -0
  525. package/packages/graph/columns/sites.ts +32 -0
  526. package/packages/graph/columns/types.ts +24 -0
  527. package/packages/graph/contacts/index.ts +14 -0
  528. package/packages/graph/contacts/types.ts +126 -0
  529. package/packages/graph/contacts/users.ts +17 -0
  530. package/packages/graph/content-types/index.ts +11 -0
  531. package/packages/graph/content-types/lists.ts +44 -0
  532. package/packages/graph/content-types/sites.ts +70 -0
  533. package/packages/graph/content-types/types.ts +112 -0
  534. package/packages/graph/conversations/groups.ts +20 -0
  535. package/packages/graph/conversations/index.ts +19 -0
  536. package/packages/graph/conversations/types.ts +147 -0
  537. package/packages/graph/decorators.ts +164 -0
  538. package/packages/graph/directory-objects/index.ts +24 -0
  539. package/packages/graph/directory-objects/types.ts +94 -0
  540. package/packages/graph/fi.ts +46 -0
  541. package/packages/graph/graphqueryable.ts +193 -0
  542. package/packages/graph/groups/index.ts +25 -0
  543. package/packages/graph/groups/types.ts +130 -0
  544. package/packages/graph/index.ts +21 -0
  545. package/packages/graph/insights/index.ts +20 -0
  546. package/packages/graph/insights/types.ts +105 -0
  547. package/packages/graph/insights/users.ts +14 -0
  548. package/packages/graph/invitations/index.ts +22 -0
  549. package/packages/graph/invitations/types.ts +41 -0
  550. package/packages/graph/lists/drive.ts +21 -0
  551. package/packages/graph/lists/index.ts +10 -0
  552. package/packages/graph/lists/sites.ts +16 -0
  553. package/packages/graph/lists/types.ts +47 -0
  554. package/packages/graph/members/groups.ts +17 -0
  555. package/packages/graph/members/index.ts +8 -0
  556. package/packages/graph/members/types.ts +40 -0
  557. package/packages/graph/messages/index.ts +14 -0
  558. package/packages/graph/messages/types.ts +46 -0
  559. package/packages/graph/messages/users.ts +27 -0
  560. package/packages/graph/onedrive/funcs.ts +40 -0
  561. package/packages/graph/onedrive/groups.ts +33 -0
  562. package/packages/graph/onedrive/index.ts +48 -0
  563. package/packages/graph/onedrive/sites.ts +35 -0
  564. package/packages/graph/onedrive/types.ts +482 -0
  565. package/packages/graph/onedrive/users.ts +56 -0
  566. package/packages/graph/onenote/index.ts +16 -0
  567. package/packages/graph/onenote/types.ts +119 -0
  568. package/packages/graph/onenote/users.ts +14 -0
  569. package/packages/graph/operations.ts +22 -0
  570. package/packages/graph/outlook/index.ts +11 -0
  571. package/packages/graph/outlook/types.ts +58 -0
  572. package/packages/graph/outlook/users.ts +14 -0
  573. package/packages/graph/package.json +16 -0
  574. package/packages/graph/photos/groups.ts +14 -0
  575. package/packages/graph/photos/index.ts +7 -0
  576. package/packages/graph/photos/types.ts +33 -0
  577. package/packages/graph/photos/users.ts +14 -0
  578. package/packages/graph/planner/groups.ts +14 -0
  579. package/packages/graph/planner/index.ts +42 -0
  580. package/packages/graph/planner/types.ts +213 -0
  581. package/packages/graph/planner/users.ts +14 -0
  582. package/packages/graph/post-install.cjs +20 -0
  583. package/packages/graph/presets/all.ts +42 -0
  584. package/packages/graph/search/index.ts +18 -0
  585. package/packages/graph/search/types.ts +20 -0
  586. package/packages/graph/shares/index.ts +23 -0
  587. package/packages/graph/shares/types.ts +47 -0
  588. package/packages/graph/sites/group.ts +14 -0
  589. package/packages/graph/sites/index.ts +25 -0
  590. package/packages/graph/sites/types.ts +45 -0
  591. package/packages/graph/subscriptions/index.ts +24 -0
  592. package/packages/graph/subscriptions/types.ts +59 -0
  593. package/packages/graph/teams/index.ts +68 -0
  594. package/packages/graph/teams/types.ts +333 -0
  595. package/packages/graph/teams/users.ts +14 -0
  596. package/packages/graph/tsconfig.json +16 -0
  597. package/packages/graph/users/index.ts +34 -0
  598. package/packages/graph/users/types.ts +56 -0
  599. package/packages/graph/utils/type.ts +3 -0
  600. package/packages/logging/index.ts +145 -0
  601. package/packages/logging/listeners.ts +134 -0
  602. package/packages/logging/package.json +10 -0
  603. package/packages/logging/tsconfig.json +7 -0
  604. package/packages/msaljsclient/index.ts +40 -0
  605. package/packages/msaljsclient/package.json +12 -0
  606. package/packages/msaljsclient/tsconfig.json +12 -0
  607. package/packages/nodejs/behaviors/fetch.ts +130 -0
  608. package/packages/nodejs/behaviors/graphdefault.ts +50 -0
  609. package/packages/nodejs/behaviors/msal.ts +24 -0
  610. package/packages/nodejs/behaviors/spdefault.ts +45 -0
  611. package/packages/nodejs/behaviors/stream-parse.ts +7 -0
  612. package/packages/nodejs/index.ts +33 -0
  613. package/packages/nodejs/package.json +17 -0
  614. package/packages/nodejs/sp-extensions/stream.ts +136 -0
  615. package/packages/nodejs/tsconfig.json +28 -0
  616. package/packages/queryable/add-prop.ts +18 -0
  617. package/packages/queryable/behaviors/bearer-token.ts +15 -0
  618. package/packages/queryable/behaviors/browser-fetch.ts +131 -0
  619. package/packages/queryable/behaviors/caching-pessimistic.ts +67 -0
  620. package/packages/queryable/behaviors/caching.ts +149 -0
  621. package/packages/queryable/behaviors/cancelable.ts +264 -0
  622. package/packages/queryable/behaviors/inject-headers.ts +23 -0
  623. package/packages/queryable/behaviors/parsers.ts +134 -0
  624. package/packages/queryable/behaviors/resolvers.ts +28 -0
  625. package/packages/queryable/behaviors/timeout.ts +24 -0
  626. package/packages/queryable/index.ts +19 -0
  627. package/packages/queryable/invokable.ts +42 -0
  628. package/packages/queryable/operations.ts +32 -0
  629. package/packages/queryable/package.json +11 -0
  630. package/packages/queryable/queryable-factory.ts +19 -0
  631. package/packages/queryable/queryable.ts +239 -0
  632. package/packages/queryable/request-builders.ts +20 -0
  633. package/packages/queryable/tsconfig.json +11 -0
  634. package/packages/readme.md +21 -0
  635. package/packages/sp/appcatalog/index.ts +35 -0
  636. package/packages/sp/appcatalog/types.ts +176 -0
  637. package/packages/sp/appcatalog/web.ts +19 -0
  638. package/packages/sp/attachments/index.ts +11 -0
  639. package/packages/sp/attachments/item.ts +17 -0
  640. package/packages/sp/attachments/types.ts +95 -0
  641. package/packages/sp/batching.ts +483 -0
  642. package/packages/sp/behaviors/defaults.ts +38 -0
  643. package/packages/sp/behaviors/request-digest.ts +78 -0
  644. package/packages/sp/behaviors/spbrowser.ts +40 -0
  645. package/packages/sp/behaviors/spfx.ts +83 -0
  646. package/packages/sp/behaviors/telemetry.ts +35 -0
  647. package/packages/sp/clientside-pages/funcs.ts +27 -0
  648. package/packages/sp/clientside-pages/index.ts +27 -0
  649. package/packages/sp/clientside-pages/types.ts +1661 -0
  650. package/packages/sp/clientside-pages/web.ts +93 -0
  651. package/packages/sp/column-defaults/folder.ts +89 -0
  652. package/packages/sp/column-defaults/index.ts +8 -0
  653. package/packages/sp/column-defaults/list.ts +219 -0
  654. package/packages/sp/column-defaults/types.ts +19 -0
  655. package/packages/sp/comments/clientside-page.ts +120 -0
  656. package/packages/sp/comments/index.ts +14 -0
  657. package/packages/sp/comments/item.ts +77 -0
  658. package/packages/sp/comments/types.ts +160 -0
  659. package/packages/sp/content-types/index.ts +17 -0
  660. package/packages/sp/content-types/item.ts +17 -0
  661. package/packages/sp/content-types/list.ts +17 -0
  662. package/packages/sp/content-types/types.ts +181 -0
  663. package/packages/sp/content-types/web.ts +17 -0
  664. package/packages/sp/context-info/index.ts +40 -0
  665. package/packages/sp/decorators.ts +18 -0
  666. package/packages/sp/favorites/index.ts +32 -0
  667. package/packages/sp/favorites/types.ts +187 -0
  668. package/packages/sp/features/index.ts +11 -0
  669. package/packages/sp/features/site.ts +17 -0
  670. package/packages/sp/features/types.ts +73 -0
  671. package/packages/sp/features/web.ts +17 -0
  672. package/packages/sp/fi.ts +46 -0
  673. package/packages/sp/fields/index.ts +22 -0
  674. package/packages/sp/fields/list.ts +17 -0
  675. package/packages/sp/fields/types.ts +648 -0
  676. package/packages/sp/fields/web.ts +23 -0
  677. package/packages/sp/files/folder.ts +17 -0
  678. package/packages/sp/files/index.ts +25 -0
  679. package/packages/sp/files/item.ts +17 -0
  680. package/packages/sp/files/readable-file.ts +40 -0
  681. package/packages/sp/files/types.ts +771 -0
  682. package/packages/sp/files/web.ts +46 -0
  683. package/packages/sp/folders/index.ts +19 -0
  684. package/packages/sp/folders/item.ts +16 -0
  685. package/packages/sp/folders/list.ts +17 -0
  686. package/packages/sp/folders/types.ts +439 -0
  687. package/packages/sp/folders/web.ts +50 -0
  688. package/packages/sp/forms/index.ts +9 -0
  689. package/packages/sp/forms/list.ts +14 -0
  690. package/packages/sp/forms/types.ts +41 -0
  691. package/packages/sp/groupsitemanager/index.ts +18 -0
  692. package/packages/sp/groupsitemanager/types.ts +433 -0
  693. package/packages/sp/hubsites/index.ts +31 -0
  694. package/packages/sp/hubsites/site.ts +43 -0
  695. package/packages/sp/hubsites/types.ts +71 -0
  696. package/packages/sp/hubsites/web.ts +38 -0
  697. package/packages/sp/index.ts +24 -0
  698. package/packages/sp/items/get-all.ts +52 -0
  699. package/packages/sp/items/index.ts +18 -0
  700. package/packages/sp/items/list.ts +14 -0
  701. package/packages/sp/items/types.ts +405 -0
  702. package/packages/sp/lists/index.ts +23 -0
  703. package/packages/sp/lists/types.ts +851 -0
  704. package/packages/sp/lists/web.ts +68 -0
  705. package/packages/sp/navigation/index.ts +35 -0
  706. package/packages/sp/navigation/types.ts +243 -0
  707. package/packages/sp/navigation/web.ts +19 -0
  708. package/packages/sp/operations.ts +33 -0
  709. package/packages/sp/package.json +15 -0
  710. package/packages/sp/post-install.cjs +20 -0
  711. package/packages/sp/presets/all.ts +75 -0
  712. package/packages/sp/profiles/index.ts +30 -0
  713. package/packages/sp/profiles/types.ts +595 -0
  714. package/packages/sp/publishing-sitepageservice/index.ts +22 -0
  715. package/packages/sp/publishing-sitepageservice/types.ts +18 -0
  716. package/packages/sp/recycle-bin/index.ts +36 -0
  717. package/packages/sp/recycle-bin/types.ts +113 -0
  718. package/packages/sp/regional-settings/content-type.ts +11 -0
  719. package/packages/sp/regional-settings/field.ts +11 -0
  720. package/packages/sp/regional-settings/funcs.ts +10 -0
  721. package/packages/sp/regional-settings/index.ts +18 -0
  722. package/packages/sp/regional-settings/list.ts +11 -0
  723. package/packages/sp/regional-settings/types.ts +159 -0
  724. package/packages/sp/regional-settings/user-custom-actions.ts +11 -0
  725. package/packages/sp/regional-settings/web.ts +21 -0
  726. package/packages/sp/related-items/index.ts +7 -0
  727. package/packages/sp/related-items/types.ts +194 -0
  728. package/packages/sp/related-items/web.ts +22 -0
  729. package/packages/sp/search/index.ts +48 -0
  730. package/packages/sp/search/query.ts +254 -0
  731. package/packages/sp/search/suggest.ts +130 -0
  732. package/packages/sp/search/types.ts +480 -0
  733. package/packages/sp/security/funcs.ts +94 -0
  734. package/packages/sp/security/index.ts +21 -0
  735. package/packages/sp/security/item.ts +29 -0
  736. package/packages/sp/security/list.ts +29 -0
  737. package/packages/sp/security/types.ts +440 -0
  738. package/packages/sp/security/web.ts +34 -0
  739. package/packages/sp/sharing/file.ts +75 -0
  740. package/packages/sp/sharing/folder.ts +69 -0
  741. package/packages/sp/sharing/funcs.ts +258 -0
  742. package/packages/sp/sharing/index.ts +27 -0
  743. package/packages/sp/sharing/item.ts +53 -0
  744. package/packages/sp/sharing/types.ts +626 -0
  745. package/packages/sp/sharing/web.ts +109 -0
  746. package/packages/sp/site-designs/index.ts +29 -0
  747. package/packages/sp/site-designs/types.ts +456 -0
  748. package/packages/sp/site-designs/web.ts +41 -0
  749. package/packages/sp/site-groups/index.ts +11 -0
  750. package/packages/sp/site-groups/types.ts +133 -0
  751. package/packages/sp/site-groups/web.ts +73 -0
  752. package/packages/sp/site-scripts/index.ts +27 -0
  753. package/packages/sp/site-scripts/list.ts +27 -0
  754. package/packages/sp/site-scripts/types.ts +243 -0
  755. package/packages/sp/site-scripts/web.ts +24 -0
  756. package/packages/sp/site-users/index.ts +12 -0
  757. package/packages/sp/site-users/types.ts +195 -0
  758. package/packages/sp/site-users/web.ts +56 -0
  759. package/packages/sp/sites/index.ts +26 -0
  760. package/packages/sp/sites/types.ts +422 -0
  761. package/packages/sp/social/index.ts +33 -0
  762. package/packages/sp/social/types.ts +381 -0
  763. package/packages/sp/spqueryable.ts +244 -0
  764. package/packages/sp/sputilities/index.ts +23 -0
  765. package/packages/sp/sputilities/types.ts +197 -0
  766. package/packages/sp/subscriptions/index.ts +10 -0
  767. package/packages/sp/subscriptions/list.ts +18 -0
  768. package/packages/sp/subscriptions/types.ts +107 -0
  769. package/packages/sp/taxonomy/index.ts +50 -0
  770. package/packages/sp/taxonomy/types.ts +508 -0
  771. package/packages/sp/tsconfig.json +16 -0
  772. package/packages/sp/types.ts +283 -0
  773. package/packages/sp/user-custom-actions/index.ts +15 -0
  774. package/packages/sp/user-custom-actions/list.ts +18 -0
  775. package/packages/sp/user-custom-actions/site.ts +18 -0
  776. package/packages/sp/user-custom-actions/types.ts +133 -0
  777. package/packages/sp/user-custom-actions/web.ts +21 -0
  778. package/packages/sp/utils/encode-path-str.ts +29 -0
  779. package/packages/sp/utils/extract-web-url.ts +21 -0
  780. package/packages/sp/utils/file-names.ts +35 -0
  781. package/packages/sp/utils/metadata.ts +5 -0
  782. package/packages/sp/utils/odata-url-from.ts +42 -0
  783. package/packages/sp/utils/to-resource-path.ts +9 -0
  784. package/packages/sp/views/index.ts +14 -0
  785. package/packages/sp/views/list.ts +33 -0
  786. package/packages/sp/views/types.ts +210 -0
  787. package/packages/sp/webparts/file.ts +21 -0
  788. package/packages/sp/webparts/index.ts +11 -0
  789. package/packages/sp/webparts/types.ts +141 -0
  790. package/packages/sp/webs/index.ts +32 -0
  791. package/packages/sp/webs/types.ts +350 -0
  792. package/packages/sp-admin/index.ts +46 -0
  793. package/packages/sp-admin/office-tenant.ts +567 -0
  794. package/packages/sp-admin/package.json +13 -0
  795. package/packages/sp-admin/site-properties.ts +45 -0
  796. package/packages/sp-admin/tenant.ts +595 -0
  797. package/packages/sp-admin/tsconfig.json +20 -0
  798. package/packages/sp-admin/types.ts +1679 -0
  799. package/packages/tsconfig-watch.json +9 -0
  800. package/packages/tsconfig.json +37 -0
  801. package/pre-install.cjs +1 -0
  802. package/samples/custom-bundle-webpack/index.ts +33 -0
  803. package/samples/custom-bundle-webpack/package-lock.json +4601 -0
  804. package/samples/custom-bundle-webpack/package.json +18 -0
  805. package/samples/custom-bundle-webpack/readme.md +102 -0
  806. package/samples/custom-bundle-webpack/tsconfig.json +12 -0
  807. package/samples/custom-bundle-webpack/webpack.config.js +27 -0
  808. package/samples/nodejs-app/.vscode/launch.json +27 -0
  809. package/samples/nodejs-app/.vscode/settings.json +10 -0
  810. package/samples/nodejs-app/.vscode/tasks.json +22 -0
  811. package/samples/nodejs-app/index.ts +63 -0
  812. package/samples/nodejs-app/package-lock.json +259 -0
  813. package/samples/nodejs-app/package.json +21 -0
  814. package/samples/nodejs-app/readme.md +140 -0
  815. package/samples/nodejs-app/tsconfig.json +14 -0
  816. package/samples/nodejs-commonjs/package-lock.json +702 -0
  817. package/samples/nodejs-commonjs/package.json +21 -0
  818. package/samples/nodejs-commonjs/readme.md +58 -0
  819. package/samples/nodejs-commonjs/src/index.ts +23 -0
  820. package/samples/nodejs-commonjs/src/settings.ts +35 -0
  821. package/samples/nodejs-commonjs/tsconfig.json +35 -0
  822. package/samples/project-preset/README.md +73 -0
  823. package/samples/project-preset/package-lock.json +21097 -0
  824. package/samples/project-preset/package.json +29 -0
  825. package/samples/project-preset/teams/4530a515-8ba7-45bb-9a27-be06b33c59d4_color.png +0 -0
  826. package/samples/project-preset/teams/4530a515-8ba7-45bb-9a27-be06b33c59d4_outline.png +0 -0
  827. package/samples/readme.md +16 -0
  828. package/settings.example.js +57 -0
  829. package/test/args.ts +107 -0
  830. package/test/clean-subsite.ts +36 -0
  831. package/test/core/assumptions.ts +99 -0
  832. package/test/core/storage.ts +60 -0
  833. package/test/core/timeline.ts +205 -0
  834. package/test/core/util.ts +205 -0
  835. package/test/graph/assets/testconvert.docx +0 -0
  836. package/test/graph/batch.ts +125 -0
  837. package/test/graph/calendars.ts +234 -0
  838. package/test/graph/columns.ts +247 -0
  839. package/test/graph/contacts.ts +254 -0
  840. package/test/graph/content-types.ts +206 -0
  841. package/test/graph/directoryobjects.ts +115 -0
  842. package/test/graph/groups.ts +130 -0
  843. package/test/graph/lists.ts +72 -0
  844. package/test/graph/onedrive.ts +365 -0
  845. package/test/graph/outlook.ts +95 -0
  846. package/test/graph/paging.ts +91 -0
  847. package/test/graph/planner.ts +160 -0
  848. package/test/graph/querable.ts +97 -0
  849. package/test/graph/search.ts +4 -0
  850. package/test/graph/shares.ts +26 -0
  851. package/test/graph/sites.ts +40 -0
  852. package/test/graph/teams.ts +76 -0
  853. package/test/graph/utilities/getTestingGraphSPSite.ts +27 -0
  854. package/test/graph/utilities/getValidUser.ts +37 -0
  855. package/test/load-settings.ts +103 -0
  856. package/test/logging/logging.ts +86 -0
  857. package/test/mocha-root-hooks.ts +227 -0
  858. package/test/nodejs/sp-extensions.ts +86 -0
  859. package/test/pnp-test.ts +60 -0
  860. package/test/queryable/add-prop.ts +24 -0
  861. package/test/queryable/behaviors.ts +188 -0
  862. package/test/queryable/invokable.ts +35 -0
  863. package/test/queryable/queryable.ts +118 -0
  864. package/test/sp/alias.ts +46 -0
  865. package/test/sp/appcatalog.ts +142 -0
  866. package/test/sp/assets/helloworld.sppkg +0 -0
  867. package/test/sp/assets/sample_file.jpg +0 -0
  868. package/test/sp/attachments.ts +134 -0
  869. package/test/sp/batch.ts +362 -0
  870. package/test/sp/clientside-pages.ts +426 -0
  871. package/test/sp/column-defaults.ts +225 -0
  872. package/test/sp/comments.ts +202 -0
  873. package/test/sp/content-types.ts +68 -0
  874. package/test/sp/favorites.ts +2 -0
  875. package/test/sp/features.ts +201 -0
  876. package/test/sp/fields.ts +396 -0
  877. package/test/sp/files.ts +338 -0
  878. package/test/sp/folders.ts +242 -0
  879. package/test/sp/forms.ts +22 -0
  880. package/test/sp/groupsitemanager.ts +88 -0
  881. package/test/sp/hubsites.ts +41 -0
  882. package/test/sp/items.ts +179 -0
  883. package/test/sp/lists.ts +319 -0
  884. package/test/sp/navigation.ts +167 -0
  885. package/test/sp/profiles.ts +2 -0
  886. package/test/sp/query-escaping.ts +94 -0
  887. package/test/sp/recycle-bin.ts +1 -0
  888. package/test/sp/regional-settings.ts +58 -0
  889. package/test/sp/related-items.ts +94 -0
  890. package/test/sp/search.ts +39 -0
  891. package/test/sp/security.ts +90 -0
  892. package/test/sp/sharing.ts +313 -0
  893. package/test/sp/site-designs.ts +224 -0
  894. package/test/sp/site-groups.ts +98 -0
  895. package/test/sp/site-scripts.ts +162 -0
  896. package/test/sp/site-users.ts +93 -0
  897. package/test/sp/sites.ts +156 -0
  898. package/test/sp/social.ts +2 -0
  899. package/test/sp/spfx.ts +52 -0
  900. package/test/sp/sputilities.ts +78 -0
  901. package/test/sp/subscriptions.ts +64 -0
  902. package/test/sp/taxonomy.ts +178 -0
  903. package/test/sp/user-custom-actions.ts +31 -0
  904. package/test/sp/views.ts +117 -0
  905. package/test/sp/webparts.ts +38 -0
  906. package/test/sp/webs.ts +249 -0
  907. package/test/test-invokable-props.ts +35 -0
  908. package/test/test-props.ts +90 -0
  909. package/test/test-recording.ts +171 -0
  910. package/test/tsconfig.json +18 -0
  911. package/tools/buildsystem/package-lock.json +4404 -0
  912. package/tools/buildsystem/package.json +56 -0
  913. package/tools/buildsystem/readme.md +23 -0
  914. package/tools/config.js +34 -0
  915. package/tools/local-module-resolver/cjs.ts +33 -0
  916. package/tools/local-module-resolver/esm-debug.ts +2 -0
  917. package/tools/local-module-resolver/esm-test.ts +2 -0
  918. package/tools/local-module-resolver/esm.ts +112 -0
  919. package/tools/local-module-resolver/readme.md +8 -0
  920. package/tsconfig.buildsystem.json +17 -0
  921. package/tsconfig.json +42 -0
package/docs/v2/sp/lists/index.html ADDED
@@ -0,0 +1,3387 @@
1
+
2
+ <!doctype html>
3
+ <html lang="en" class="no-js">
4
+ <head>
5
+
6
+ <meta charset="utf-8">
7
+ <meta name="viewport" content="width=device-width,initial-scale=1">
8
+
9
+
10
+ <link rel="canonical" href="https://pnp.github.io/pnpjs/sp/lists/">
11
+
12
+
13
+ <link rel="shortcut icon" href="../../assets/images/favicon.png">
14
+ <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-6.0.2">
15
+
16
+
17
+
18
+ <title>Lists - PnP/PnPjs</title>
19
+
20
+
21
+
22
+ <link rel="stylesheet" href="../../assets/stylesheets/main.38780c08.min.css">
23
+
24
+
25
+ <link rel="stylesheet" href="../../assets/stylesheets/palette.3f72e892.min.css">
26
+
27
+
28
+
29
+ <meta name="theme-color" content="#2094f3">
30
+
31
+
32
+
33
+
34
+
35
+
36
+
37
+ <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
38
+ <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
39
+ <style>body,input{font-family:"Roboto",-apple-system,BlinkMacSystemFont,Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono",SFMono-Regular,Consolas,Menlo,monospace}</style>
40
+
41
+
42
+
43
+
44
+ <link rel="stylesheet" href="../../css/extra.css">
45
+
46
+
47
+ <img src="https://telemetry.sharepointpnp.com/@pnp/pnpjs/ghpages/pnpjs/sp/lists/" alt="spacer" width="1" height="1" />
48
+
49
+
50
+ </head>
51
+
52
+
53
+
54
+
55
+
56
+
57
+
58
+ <body dir="ltr" data-md-color-scheme="" data-md-color-primary="blue" data-md-color-accent="">
59
+
60
+
61
+ <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
62
+ <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
63
+ <label class="md-overlay" for="__drawer"></label>
64
+ <div data-md-component="skip">
65
+
66
+
67
+ <a href="#pnpsplists" class="md-skip">
68
+ Skip to content
69
+ </a>
70
+
71
+ </div>
72
+ <div data-md-component="announce">
73
+
74
+ </div>
75
+
76
+ <header class="md-header" data-md-component="header">
77
+ <nav class="md-header-nav md-grid" aria-label="Header">
78
+ <a href="https://pnp.github.io/pnpjs/" title="PnP/PnPjs" class="md-header-nav__button md-logo" aria-label="PnP/PnPjs">
79
+
80
+ <img src="../../img/Logo.png" alt="logo">
81
+
82
+ </a>
83
+ <label class="md-header-nav__button md-icon" for="__drawer">
84
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
85
+ </label>
86
+ <div class="md-header-nav__title" data-md-component="header-title">
87
+
88
+ <div class="md-header-nav__ellipsis">
89
+ <span class="md-header-nav__topic md-ellipsis">
90
+ PnP/PnPjs
91
+ </span>
92
+ <span class="md-header-nav__topic md-ellipsis">
93
+
94
+ Lists
95
+
96
+ </span>
97
+ </div>
98
+
99
+ </div>
100
+
101
+ <label class="md-header-nav__button md-icon" for="__search">
102
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
103
+ </label>
104
+
105
+ <div class="md-search" data-md-component="search" role="dialog">
106
+ <label class="md-search__overlay" for="__search"></label>
107
+ <div class="md-search__inner" role="search">
108
+ <form class="md-search__form" name="search">
109
+ <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active">
110
+ <label class="md-search__icon md-icon" for="__search">
111
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
112
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
113
+ </label>
114
+ <button type="reset" class="md-search__icon md-icon" aria-label="Clear" data-md-component="search-reset" tabindex="-1">
115
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
116
+ </button>
117
+ </form>
118
+ <div class="md-search__output">
119
+ <div class="md-search__scrollwrap" data-md-scrollfix>
120
+ <div class="md-search-result" data-md-component="search-result">
121
+ <div class="md-search-result__meta">
122
+ Initializing search
123
+ </div>
124
+ <ol class="md-search-result__list"></ol>
125
+ </div>
126
+ </div>
127
+ </div>
128
+ </div>
129
+ </div>
130
+
131
+
132
+ <div class="md-header-nav__source">
133
+
134
+ <a href="https://github.com/pnp/pnpjs/" title="Go to repository" class="md-source">
135
+ <div class="md-source__icon md-icon">
136
+
137
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 00-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 01-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 000 40.81l195.61 195.6a28.86 28.86 0 0040.8 0l194.69-194.69a28.86 28.86 0 000-40.81z"/></svg>
138
+ </div>
139
+ <div class="md-source__repository">
140
+ GitHub
141
+ </div>
142
+ </a>
143
+ </div>
144
+
145
+ </nav>
146
+ </header>
147
+
148
+ <div class="md-container" data-md-component="container">
149
+
150
+
151
+
152
+
153
+ <main class="md-main" data-md-component="main">
154
+ <div class="md-main__inner md-grid">
155
+
156
+
157
+ <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
158
+ <div class="md-sidebar__scrollwrap">
159
+ <div class="md-sidebar__inner">
160
+ <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
161
+ <label class="md-nav__title" for="__drawer">
162
+ <a href="https://pnp.github.io/pnpjs/" title="PnP/PnPjs" class="md-nav__button md-logo" aria-label="PnP/PnPjs">
163
+
164
+ <img src="../../img/Logo.png" alt="logo">
165
+
166
+ </a>
167
+ PnP/PnPjs
168
+ </label>
169
+
170
+ <div class="md-nav__source">
171
+
172
+ <a href="https://github.com/pnp/pnpjs/" title="Go to repository" class="md-source">
173
+ <div class="md-source__icon md-icon">
174
+
175
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 00-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 01-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 000 40.81l195.61 195.6a28.86 28.86 0 0040.8 0l194.69-194.69a28.86 28.86 0 000-40.81z"/></svg>
176
+ </div>
177
+ <div class="md-source__repository">
178
+ GitHub
179
+ </div>
180
+ </a>
181
+ </div>
182
+
183
+ <ul class="md-nav__list" data-md-scrollfix>
184
+
185
+
186
+
187
+
188
+
189
+
190
+ <li class="md-nav__item">
191
+ <a href="../.." class="md-nav__link">
192
+ Home
193
+ </a>
194
+ </li>
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+ <li class="md-nav__item">
203
+ <a href="../../getting-started/" class="md-nav__link">
204
+ Getting Started
205
+ </a>
206
+ </li>
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+ <li class="md-nav__item">
215
+ <a href="../../news/2020-year-in-review/" class="md-nav__link">
216
+ 2020 Year In Review
217
+ </a>
218
+ </li>
219
+
220
+
221
+
222
+
223
+
224
+
225
+
226
+ <li class="md-nav__item md-nav__item--nested">
227
+
228
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
229
+
230
+ <label class="md-nav__link" for="nav-4">
231
+ General
232
+ <span class="md-nav__icon md-icon"></span>
233
+ </label>
234
+ <nav class="md-nav" aria-label="General" data-md-level="1">
235
+ <label class="md-nav__title" for="nav-4">
236
+ <span class="md-nav__icon md-icon"></span>
237
+ General
238
+ </label>
239
+ <ul class="md-nav__list" data-md-scrollfix>
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+ <li class="md-nav__item">
248
+ <a href="../../getting-started/" class="md-nav__link">
249
+ Getting Started
250
+ </a>
251
+ </li>
252
+
253
+
254
+
255
+
256
+
257
+
258
+
259
+ <li class="md-nav__item">
260
+ <a href="../../transition-guide/" class="md-nav__link">
261
+ Transition Guide
262
+ </a>
263
+ </li>
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+ <li class="md-nav__item">
272
+ <a href="../../npm-scripts/" class="md-nav__link">
273
+ Npm Scripts
274
+ </a>
275
+ </li>
276
+
277
+
278
+
279
+
280
+
281
+
282
+
283
+ <li class="md-nav__item">
284
+ <a href="../../SPFx-on-premises/" class="md-nav__link">
285
+ SPFx On-Premises
286
+ </a>
287
+ </li>
288
+
289
+
290
+
291
+
292
+
293
+
294
+
295
+ <li class="md-nav__item">
296
+ <a href="../../nodejs-support/" class="md-nav__link">
297
+ Working in Nodejs
298
+ </a>
299
+ </li>
300
+
301
+
302
+ </ul>
303
+ </nav>
304
+ </li>
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+ <li class="md-nav__item md-nav__item--nested">
313
+
314
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
315
+
316
+ <label class="md-nav__link" for="nav-5">
317
+ Library Concepts
318
+ <span class="md-nav__icon md-icon"></span>
319
+ </label>
320
+ <nav class="md-nav" aria-label="Library Concepts" data-md-level="1">
321
+ <label class="md-nav__title" for="nav-5">
322
+ <span class="md-nav__icon md-icon"></span>
323
+ Library Concepts
324
+ </label>
325
+ <ul class="md-nav__list" data-md-scrollfix>
326
+
327
+
328
+
329
+
330
+
331
+
332
+
333
+ <li class="md-nav__item">
334
+ <a href="../../concepts/configuration/" class="md-nav__link">
335
+ Configuration
336
+ </a>
337
+ </li>
338
+
339
+
340
+
341
+
342
+
343
+
344
+
345
+ <li class="md-nav__item">
346
+ <a href="../../concepts/selective-imports/" class="md-nav__link">
347
+ Selective Imports
348
+ </a>
349
+ </li>
350
+
351
+
352
+
353
+
354
+
355
+
356
+
357
+ <li class="md-nav__item">
358
+ <a href="../../concepts/custom-bundle/" class="md-nav__link">
359
+ Custom Bundle
360
+ </a>
361
+ </li>
362
+
363
+
364
+
365
+
366
+
367
+
368
+
369
+ <li class="md-nav__item">
370
+ <a href="../../concepts/ie11-mode/" class="md-nav__link">
371
+ IE11 Mode
372
+ </a>
373
+ </li>
374
+
375
+
376
+
377
+
378
+
379
+
380
+
381
+ <li class="md-nav__item">
382
+ <a href="../../concepts/invokable/" class="md-nav__link">
383
+ Invokables
384
+ </a>
385
+ </li>
386
+
387
+
388
+
389
+
390
+
391
+
392
+
393
+ <li class="md-nav__item">
394
+ <a href="../../concepts/polyfill/" class="md-nav__link">
395
+ Polyfills
396
+ </a>
397
+ </li>
398
+
399
+
400
+
401
+
402
+
403
+
404
+
405
+ <li class="md-nav__item">
406
+ <a href="../../concepts/settings/" class="md-nav__link">
407
+ Settings
408
+ </a>
409
+ </li>
410
+
411
+
412
+
413
+
414
+
415
+
416
+
417
+ <li class="md-nav__item">
418
+ <a href="../../concepts/error-handling/" class="md-nav__link">
419
+ Error Handling
420
+ </a>
421
+ </li>
422
+
423
+
424
+
425
+
426
+
427
+
428
+
429
+ <li class="md-nav__item md-nav__item--nested">
430
+
431
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-5-9" type="checkbox" id="nav-5-9">
432
+
433
+ <label class="md-nav__link" for="nav-5-9">
434
+ Authentication
435
+ <span class="md-nav__icon md-icon"></span>
436
+ </label>
437
+ <nav class="md-nav" aria-label="Authentication" data-md-level="2">
438
+ <label class="md-nav__title" for="nav-5-9">
439
+ <span class="md-nav__icon md-icon"></span>
440
+ Authentication
441
+ </label>
442
+ <ul class="md-nav__list" data-md-scrollfix>
443
+
444
+
445
+
446
+
447
+
448
+
449
+
450
+ <li class="md-nav__item">
451
+ <a href="../../authentication/" class="md-nav__link">
452
+ Getting Started
453
+ </a>
454
+ </li>
455
+
456
+
457
+
458
+
459
+
460
+
461
+
462
+ <li class="md-nav__item">
463
+ <a href="../../authentication/client-spfx/" class="md-nav__link">
464
+ SPFx Auth
465
+ </a>
466
+ </li>
467
+
468
+
469
+
470
+
471
+
472
+
473
+
474
+ <li class="md-nav__item">
475
+ <a href="../../authentication/msaljsclient/" class="md-nav__link">
476
+ MSAL Client
477
+ </a>
478
+ </li>
479
+
480
+
481
+
482
+
483
+
484
+
485
+
486
+ <li class="md-nav__item">
487
+ <a href="../../authentication/adaljsclient/" class="md-nav__link">
488
+ ADAL Client
489
+ </a>
490
+ </li>
491
+
492
+
493
+
494
+
495
+
496
+
497
+
498
+ <li class="md-nav__item">
499
+ <a href="../../authentication/client-spa/" class="md-nav__link">
500
+ SPA Auth
501
+ </a>
502
+ </li>
503
+
504
+
505
+
506
+
507
+
508
+
509
+
510
+ <li class="md-nav__item">
511
+ <a href="../../authentication/server-nodejs/" class="md-nav__link">
512
+ NodeJS Auth
513
+ </a>
514
+ </li>
515
+
516
+
517
+
518
+
519
+
520
+
521
+
522
+ <li class="md-nav__item">
523
+ <a href="../../authentication/sp-app-registration/" class="md-nav__link">
524
+ SP App Reg
525
+ </a>
526
+ </li>
527
+
528
+
529
+
530
+
531
+
532
+
533
+
534
+ <li class="md-nav__item">
535
+ <a href="../../authentication/bearertokenclient/" class="md-nav__link">
536
+ Bearer Token Client
537
+ </a>
538
+ </li>
539
+
540
+
541
+
542
+
543
+
544
+
545
+
546
+ <li class="md-nav__item">
547
+ <a href="../../authentication/lambdaclient/" class="md-nav__link">
548
+ Lambda Token Client
549
+ </a>
550
+ </li>
551
+
552
+
553
+ </ul>
554
+ </nav>
555
+ </li>
556
+
557
+
558
+ </ul>
559
+ </nav>
560
+ </li>
561
+
562
+
563
+
564
+
565
+
566
+
567
+
568
+
569
+
570
+ <li class="md-nav__item md-nav__item--active md-nav__item--nested">
571
+
572
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6" checked>
573
+
574
+ <label class="md-nav__link" for="nav-6">
575
+ Packages
576
+ <span class="md-nav__icon md-icon"></span>
577
+ </label>
578
+ <nav class="md-nav" aria-label="Packages" data-md-level="1">
579
+ <label class="md-nav__title" for="nav-6">
580
+ <span class="md-nav__icon md-icon"></span>
581
+ Packages
582
+ </label>
583
+ <ul class="md-nav__list" data-md-scrollfix>
584
+
585
+
586
+
587
+
588
+
589
+
590
+
591
+ <li class="md-nav__item">
592
+ <a href="../../packages/" class="md-nav__link">
593
+ Packages
594
+ </a>
595
+ </li>
596
+
597
+
598
+
599
+
600
+
601
+
602
+
603
+ <li class="md-nav__item md-nav__item--nested">
604
+
605
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-6-2" type="checkbox" id="nav-6-2">
606
+
607
+ <label class="md-nav__link" for="nav-6-2">
608
+ common
609
+ <span class="md-nav__icon md-icon"></span>
610
+ </label>
611
+ <nav class="md-nav" aria-label="common" data-md-level="2">
612
+ <label class="md-nav__title" for="nav-6-2">
613
+ <span class="md-nav__icon md-icon"></span>
614
+ common
615
+ </label>
616
+ <ul class="md-nav__list" data-md-scrollfix>
617
+
618
+
619
+
620
+
621
+
622
+
623
+
624
+ <li class="md-nav__item">
625
+ <a href="../../common/" class="md-nav__link">
626
+ common
627
+ </a>
628
+ </li>
629
+
630
+
631
+
632
+
633
+
634
+
635
+
636
+ <li class="md-nav__item">
637
+ <a href="../../common/collections/" class="md-nav__link">
638
+ collections
639
+ </a>
640
+ </li>
641
+
642
+
643
+
644
+
645
+
646
+
647
+
648
+ <li class="md-nav__item">
649
+ <a href="../../common/custom-httpclientimpl/" class="md-nav__link">
650
+ Custom HttpClientImpl
651
+ </a>
652
+ </li>
653
+
654
+
655
+
656
+
657
+
658
+
659
+
660
+ <li class="md-nav__item">
661
+ <a href="../../common/libconfig/" class="md-nav__link">
662
+ libconfig
663
+ </a>
664
+ </li>
665
+
666
+
667
+
668
+
669
+
670
+
671
+
672
+ <li class="md-nav__item">
673
+ <a href="../../common/netutil/" class="md-nav__link">
674
+ netutil
675
+ </a>
676
+ </li>
677
+
678
+
679
+
680
+
681
+
682
+
683
+
684
+ <li class="md-nav__item">
685
+ <a href="../../common/storage/" class="md-nav__link">
686
+ storage
687
+ </a>
688
+ </li>
689
+
690
+
691
+
692
+
693
+
694
+
695
+
696
+ <li class="md-nav__item">
697
+ <a href="../../common/util/" class="md-nav__link">
698
+ util
699
+ </a>
700
+ </li>
701
+
702
+
703
+ </ul>
704
+ </nav>
705
+ </li>
706
+
707
+
708
+
709
+
710
+
711
+
712
+
713
+ <li class="md-nav__item md-nav__item--nested">
714
+
715
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-6-3" type="checkbox" id="nav-6-3">
716
+
717
+ <label class="md-nav__link" for="nav-6-3">
718
+ config-store
719
+ <span class="md-nav__icon md-icon"></span>
720
+ </label>
721
+ <nav class="md-nav" aria-label="config-store" data-md-level="2">
722
+ <label class="md-nav__title" for="nav-6-3">
723
+ <span class="md-nav__icon md-icon"></span>
724
+ config-store
725
+ </label>
726
+ <ul class="md-nav__list" data-md-scrollfix>
727
+
728
+
729
+
730
+
731
+
732
+
733
+
734
+ <li class="md-nav__item">
735
+ <a href="../../config-store/" class="md-nav__link">
736
+ config-store
737
+ </a>
738
+ </li>
739
+
740
+
741
+
742
+
743
+
744
+
745
+
746
+ <li class="md-nav__item">
747
+ <a href="../../config-store/configuration/" class="md-nav__link">
748
+ configuration
749
+ </a>
750
+ </li>
751
+
752
+
753
+
754
+
755
+
756
+
757
+
758
+ <li class="md-nav__item">
759
+ <a href="../../config-store/providers/" class="md-nav__link">
760
+ providers
761
+ </a>
762
+ </li>
763
+
764
+
765
+ </ul>
766
+ </nav>
767
+ </li>
768
+
769
+
770
+
771
+
772
+
773
+
774
+
775
+ <li class="md-nav__item md-nav__item--nested">
776
+
777
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-6-4" type="checkbox" id="nav-6-4">
778
+
779
+ <label class="md-nav__link" for="nav-6-4">
780
+ graph
781
+ <span class="md-nav__icon md-icon"></span>
782
+ </label>
783
+ <nav class="md-nav" aria-label="graph" data-md-level="2">
784
+ <label class="md-nav__title" for="nav-6-4">
785
+ <span class="md-nav__icon md-icon"></span>
786
+ graph
787
+ </label>
788
+ <ul class="md-nav__list" data-md-scrollfix>
789
+
790
+
791
+
792
+
793
+
794
+
795
+
796
+ <li class="md-nav__item">
797
+ <a href="../../graph/" class="md-nav__link">
798
+ graph
799
+ </a>
800
+ </li>
801
+
802
+
803
+
804
+
805
+
806
+
807
+
808
+ <li class="md-nav__item">
809
+ <a href="../../graph/groups/" class="md-nav__link">
810
+ groups
811
+ </a>
812
+ </li>
813
+
814
+
815
+
816
+
817
+
818
+
819
+
820
+ <li class="md-nav__item">
821
+ <a href="../../graph/insights/" class="md-nav__link">
822
+ insights
823
+ </a>
824
+ </li>
825
+
826
+
827
+
828
+
829
+
830
+
831
+
832
+ <li class="md-nav__item">
833
+ <a href="../../graph/contacts/" class="md-nav__link">
834
+ contacts
835
+ </a>
836
+ </li>
837
+
838
+
839
+
840
+
841
+
842
+
843
+
844
+ <li class="md-nav__item">
845
+ <a href="../../graph/calendars/" class="md-nav__link">
846
+ calendars
847
+ </a>
848
+ </li>
849
+
850
+
851
+
852
+
853
+
854
+
855
+
856
+ <li class="md-nav__item">
857
+ <a href="../../graph/directoryobjects/" class="md-nav__link">
858
+ directory objects
859
+ </a>
860
+ </li>
861
+
862
+
863
+
864
+
865
+
866
+
867
+
868
+ <li class="md-nav__item">
869
+ <a href="../../graph/invitations/" class="md-nav__link">
870
+ invitations
871
+ </a>
872
+ </li>
873
+
874
+
875
+
876
+
877
+
878
+
879
+
880
+ <li class="md-nav__item">
881
+ <a href="../../graph/onedrive/" class="md-nav__link">
882
+ onedrive
883
+ </a>
884
+ </li>
885
+
886
+
887
+
888
+
889
+
890
+
891
+
892
+ <li class="md-nav__item">
893
+ <a href="../../graph/outlook/" class="md-nav__link">
894
+ outlook
895
+ </a>
896
+ </li>
897
+
898
+
899
+
900
+
901
+
902
+
903
+
904
+ <li class="md-nav__item">
905
+ <a href="../../graph/photos/" class="md-nav__link">
906
+ photos
907
+ </a>
908
+ </li>
909
+
910
+
911
+
912
+
913
+
914
+
915
+
916
+ <li class="md-nav__item">
917
+ <a href="../../graph/planner/" class="md-nav__link">
918
+ planner
919
+ </a>
920
+ </li>
921
+
922
+
923
+
924
+
925
+
926
+
927
+
928
+ <li class="md-nav__item">
929
+ <a href="../../graph/search/" class="md-nav__link">
930
+ search
931
+ </a>
932
+ </li>
933
+
934
+
935
+
936
+
937
+
938
+
939
+
940
+ <li class="md-nav__item">
941
+ <a href="../../graph/subscriptions/" class="md-nav__link">
942
+ subscriptions
943
+ </a>
944
+ </li>
945
+
946
+
947
+
948
+
949
+
950
+
951
+
952
+ <li class="md-nav__item">
953
+ <a href="../../graph/teams/" class="md-nav__link">
954
+ teams
955
+ </a>
956
+ </li>
957
+
958
+
959
+
960
+
961
+
962
+
963
+
964
+ <li class="md-nav__item">
965
+ <a href="../../graph/users/" class="md-nav__link">
966
+ users
967
+ </a>
968
+ </li>
969
+
970
+
971
+ </ul>
972
+ </nav>
973
+ </li>
974
+
975
+
976
+
977
+
978
+
979
+
980
+
981
+ <li class="md-nav__item">
982
+ <a href="../../logging/" class="md-nav__link">
983
+ logging
984
+ </a>
985
+ </li>
986
+
987
+
988
+
989
+
990
+
991
+
992
+
993
+ <li class="md-nav__item md-nav__item--nested">
994
+
995
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-6-6" type="checkbox" id="nav-6-6">
996
+
997
+ <label class="md-nav__link" for="nav-6-6">
998
+ nodejs
999
+ <span class="md-nav__icon md-icon"></span>
1000
+ </label>
1001
+ <nav class="md-nav" aria-label="nodejs" data-md-level="2">
1002
+ <label class="md-nav__title" for="nav-6-6">
1003
+ <span class="md-nav__icon md-icon"></span>
1004
+ nodejs
1005
+ </label>
1006
+ <ul class="md-nav__list" data-md-scrollfix>
1007
+
1008
+
1009
+
1010
+
1011
+
1012
+
1013
+
1014
+ <li class="md-nav__item">
1015
+ <a href="../../nodejs/" class="md-nav__link">
1016
+ nodejs
1017
+ </a>
1018
+ </li>
1019
+
1020
+
1021
+
1022
+
1023
+
1024
+
1025
+
1026
+ <li class="md-nav__item">
1027
+ <a href="../../nodejs/sp-fetch-client/" class="md-nav__link">
1028
+ SPFetchClient
1029
+ </a>
1030
+ </li>
1031
+
1032
+
1033
+
1034
+
1035
+
1036
+
1037
+
1038
+ <li class="md-nav__item">
1039
+ <a href="../../nodejs/adal-fetch-client/" class="md-nav__link">
1040
+ AdalFetchClient
1041
+ </a>
1042
+ </li>
1043
+
1044
+
1045
+
1046
+
1047
+
1048
+
1049
+
1050
+ <li class="md-nav__item">
1051
+ <a href="../../nodejs/bearer-token-fetch-client/" class="md-nav__link">
1052
+ BearerTokenFetchClient
1053
+ </a>
1054
+ </li>
1055
+
1056
+
1057
+
1058
+
1059
+
1060
+
1061
+
1062
+ <li class="md-nav__item">
1063
+ <a href="../../nodejs/provider-hosted-app/" class="md-nav__link">
1064
+ ProviderHostedRequestContext
1065
+ </a>
1066
+ </li>
1067
+
1068
+
1069
+
1070
+
1071
+
1072
+
1073
+
1074
+ <li class="md-nav__item">
1075
+ <a href="../../nodejs/sp-extensions/" class="md-nav__link">
1076
+ sp Extensions
1077
+ </a>
1078
+ </li>
1079
+
1080
+
1081
+
1082
+
1083
+
1084
+
1085
+
1086
+ <li class="md-nav__item">
1087
+ <a href="../../nodejs/proxy/" class="md-nav__link">
1088
+ proxy
1089
+ </a>
1090
+ </li>
1091
+
1092
+
1093
+ </ul>
1094
+ </nav>
1095
+ </li>
1096
+
1097
+
1098
+
1099
+
1100
+
1101
+
1102
+
1103
+ <li class="md-nav__item md-nav__item--nested">
1104
+
1105
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-6-7" type="checkbox" id="nav-6-7">
1106
+
1107
+ <label class="md-nav__link" for="nav-6-7">
1108
+ odata
1109
+ <span class="md-nav__icon md-icon"></span>
1110
+ </label>
1111
+ <nav class="md-nav" aria-label="odata" data-md-level="2">
1112
+ <label class="md-nav__title" for="nav-6-7">
1113
+ <span class="md-nav__icon md-icon"></span>
1114
+ odata
1115
+ </label>
1116
+ <ul class="md-nav__list" data-md-scrollfix>
1117
+
1118
+
1119
+
1120
+
1121
+
1122
+
1123
+
1124
+ <li class="md-nav__item">
1125
+ <a href="../../odata/" class="md-nav__link">
1126
+ odata
1127
+ </a>
1128
+ </li>
1129
+
1130
+
1131
+
1132
+
1133
+
1134
+
1135
+
1136
+ <li class="md-nav__item">
1137
+ <a href="../../odata/caching/" class="md-nav__link">
1138
+ caching
1139
+ </a>
1140
+ </li>
1141
+
1142
+
1143
+
1144
+
1145
+
1146
+
1147
+
1148
+ <li class="md-nav__item">
1149
+ <a href="../../odata/core/" class="md-nav__link">
1150
+ core
1151
+ </a>
1152
+ </li>
1153
+
1154
+
1155
+
1156
+
1157
+
1158
+
1159
+
1160
+ <li class="md-nav__item">
1161
+ <a href="../../odata/odata-batch/" class="md-nav__link">
1162
+ OData Batching
1163
+ </a>
1164
+ </li>
1165
+
1166
+
1167
+
1168
+
1169
+
1170
+
1171
+
1172
+ <li class="md-nav__item">
1173
+ <a href="../../odata/extensions/" class="md-nav__link">
1174
+ Extending an OData library
1175
+ </a>
1176
+ </li>
1177
+
1178
+
1179
+
1180
+
1181
+
1182
+
1183
+
1184
+ <li class="md-nav__item">
1185
+ <a href="../../odata/debug/" class="md-nav__link">
1186
+ Debugging Proxy Objects
1187
+ </a>
1188
+ </li>
1189
+
1190
+
1191
+
1192
+
1193
+
1194
+
1195
+
1196
+ <li class="md-nav__item">
1197
+ <a href="../../odata/parsers/" class="md-nav__link">
1198
+ Parsers
1199
+ </a>
1200
+ </li>
1201
+
1202
+
1203
+
1204
+
1205
+
1206
+
1207
+
1208
+ <li class="md-nav__item">
1209
+ <a href="../../odata/pipeline/" class="md-nav__link">
1210
+ Pipeline
1211
+ </a>
1212
+ </li>
1213
+
1214
+
1215
+
1216
+
1217
+
1218
+
1219
+
1220
+ <li class="md-nav__item">
1221
+ <a href="../../odata/queryable/" class="md-nav__link">
1222
+ Queryable
1223
+ </a>
1224
+ </li>
1225
+
1226
+
1227
+ </ul>
1228
+ </nav>
1229
+ </li>
1230
+
1231
+
1232
+
1233
+
1234
+
1235
+
1236
+
1237
+ <li class="md-nav__item md-nav__item--nested">
1238
+
1239
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-6-8" type="checkbox" id="nav-6-8">
1240
+
1241
+ <label class="md-nav__link" for="nav-6-8">
1242
+ pnpjs
1243
+ <span class="md-nav__icon md-icon"></span>
1244
+ </label>
1245
+ <nav class="md-nav" aria-label="pnpjs" data-md-level="2">
1246
+ <label class="md-nav__title" for="nav-6-8">
1247
+ <span class="md-nav__icon md-icon"></span>
1248
+ pnpjs
1249
+ </label>
1250
+ <ul class="md-nav__list" data-md-scrollfix>
1251
+
1252
+
1253
+
1254
+
1255
+
1256
+
1257
+
1258
+ <li class="md-nav__item">
1259
+ <a href="../../pnpjs/" class="md-nav__link">
1260
+ pnpjs
1261
+ </a>
1262
+ </li>
1263
+
1264
+
1265
+ </ul>
1266
+ </nav>
1267
+ </li>
1268
+
1269
+
1270
+
1271
+
1272
+
1273
+
1274
+
1275
+
1276
+
1277
+ <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1278
+
1279
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-6-9" type="checkbox" id="nav-6-9" checked>
1280
+
1281
+ <label class="md-nav__link" for="nav-6-9">
1282
+ sp
1283
+ <span class="md-nav__icon md-icon"></span>
1284
+ </label>
1285
+ <nav class="md-nav" aria-label="sp" data-md-level="2">
1286
+ <label class="md-nav__title" for="nav-6-9">
1287
+ <span class="md-nav__icon md-icon"></span>
1288
+ sp
1289
+ </label>
1290
+ <ul class="md-nav__list" data-md-scrollfix>
1291
+
1292
+
1293
+
1294
+
1295
+
1296
+
1297
+
1298
+ <li class="md-nav__item">
1299
+ <a href="../" class="md-nav__link">
1300
+ sp
1301
+ </a>
1302
+ </li>
1303
+
1304
+
1305
+
1306
+
1307
+
1308
+
1309
+
1310
+ <li class="md-nav__item">
1311
+ <a href="../alias-parameters/" class="md-nav__link">
1312
+ Alias Parameters
1313
+ </a>
1314
+ </li>
1315
+
1316
+
1317
+
1318
+
1319
+
1320
+
1321
+
1322
+ <li class="md-nav__item">
1323
+ <a href="../alm/" class="md-nav__link">
1324
+ ALM api
1325
+ </a>
1326
+ </li>
1327
+
1328
+
1329
+
1330
+
1331
+
1332
+
1333
+
1334
+ <li class="md-nav__item">
1335
+ <a href="../attachments/" class="md-nav__link">
1336
+ Attachments
1337
+ </a>
1338
+ </li>
1339
+
1340
+
1341
+
1342
+
1343
+
1344
+
1345
+
1346
+ <li class="md-nav__item">
1347
+ <a href="../clientside-pages/" class="md-nav__link">
1348
+ Client-side Pages
1349
+ </a>
1350
+ </li>
1351
+
1352
+
1353
+
1354
+
1355
+
1356
+
1357
+
1358
+ <li class="md-nav__item">
1359
+ <a href="../column-defaults/" class="md-nav__link">
1360
+ Column Defaults
1361
+ </a>
1362
+ </li>
1363
+
1364
+
1365
+
1366
+
1367
+
1368
+
1369
+
1370
+ <li class="md-nav__item">
1371
+ <a href="../comments-likes/" class="md-nav__link">
1372
+ Comments and Likes
1373
+ </a>
1374
+ </li>
1375
+
1376
+
1377
+
1378
+
1379
+
1380
+
1381
+
1382
+ <li class="md-nav__item">
1383
+ <a href="../content-types/" class="md-nav__link">
1384
+ Content Types
1385
+ </a>
1386
+ </li>
1387
+
1388
+
1389
+
1390
+
1391
+
1392
+
1393
+
1394
+ <li class="md-nav__item">
1395
+ <a href="../entity-merging/" class="md-nav__link">
1396
+ Entity Merging
1397
+ </a>
1398
+ </li>
1399
+
1400
+
1401
+
1402
+
1403
+
1404
+
1405
+
1406
+ <li class="md-nav__item">
1407
+ <a href="../features/" class="md-nav__link">
1408
+ Features
1409
+ </a>
1410
+ </li>
1411
+
1412
+
1413
+
1414
+
1415
+
1416
+
1417
+
1418
+ <li class="md-nav__item">
1419
+ <a href="../fields/" class="md-nav__link">
1420
+ Fields
1421
+ </a>
1422
+ </li>
1423
+
1424
+
1425
+
1426
+
1427
+
1428
+
1429
+
1430
+ <li class="md-nav__item">
1431
+ <a href="../files/" class="md-nav__link">
1432
+ Files
1433
+ </a>
1434
+ </li>
1435
+
1436
+
1437
+
1438
+
1439
+
1440
+
1441
+
1442
+ <li class="md-nav__item">
1443
+ <a href="../folders/" class="md-nav__link">
1444
+ Folders
1445
+ </a>
1446
+ </li>
1447
+
1448
+
1449
+
1450
+
1451
+
1452
+
1453
+
1454
+ <li class="md-nav__item">
1455
+ <a href="../forms/" class="md-nav__link">
1456
+ Forms
1457
+ </a>
1458
+ </li>
1459
+
1460
+
1461
+
1462
+
1463
+
1464
+
1465
+
1466
+ <li class="md-nav__item">
1467
+ <a href="../hubsites/" class="md-nav__link">
1468
+ Hubsites
1469
+ </a>
1470
+ </li>
1471
+
1472
+
1473
+
1474
+
1475
+
1476
+
1477
+
1478
+ <li class="md-nav__item">
1479
+ <a href="../items/" class="md-nav__link">
1480
+ List Items
1481
+ </a>
1482
+ </li>
1483
+
1484
+
1485
+
1486
+
1487
+
1488
+
1489
+
1490
+
1491
+
1492
+ <li class="md-nav__item md-nav__item--active">
1493
+
1494
+ <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
1495
+
1496
+
1497
+
1498
+
1499
+ <label class="md-nav__link md-nav__link--active" for="__toc">
1500
+ Lists
1501
+ <span class="md-nav__icon md-icon"></span>
1502
+ </label>
1503
+
1504
+ <a href="./" class="md-nav__link md-nav__link--active">
1505
+ Lists
1506
+ </a>
1507
+
1508
+
1509
+ <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1510
+
1511
+
1512
+
1513
+
1514
+
1515
+ <label class="md-nav__title" for="__toc">
1516
+ <span class="md-nav__icon md-icon"></span>
1517
+ Table of contents
1518
+ </label>
1519
+ <ul class="md-nav__list" data-md-scrollfix>
1520
+
1521
+ <li class="md-nav__item">
1522
+ <a href="#ilists" class="md-nav__link">
1523
+ ILists
1524
+ </a>
1525
+
1526
+ <nav class="md-nav" aria-label="ILists">
1527
+ <ul class="md-nav__list">
1528
+
1529
+ <li class="md-nav__item">
1530
+ <a href="#get-list-by-id" class="md-nav__link">
1531
+ Get List by Id
1532
+ </a>
1533
+
1534
+ </li>
1535
+
1536
+ <li class="md-nav__item">
1537
+ <a href="#get-list-by-title" class="md-nav__link">
1538
+ Get List by Title
1539
+ </a>
1540
+
1541
+ </li>
1542
+
1543
+ <li class="md-nav__item">
1544
+ <a href="#add-list" class="md-nav__link">
1545
+ Add List
1546
+ </a>
1547
+
1548
+ </li>
1549
+
1550
+ <li class="md-nav__item">
1551
+ <a href="#ensure-that-a-list-exists-by-title" class="md-nav__link">
1552
+ Ensure that a List exists (by title)
1553
+ </a>
1554
+
1555
+ </li>
1556
+
1557
+ <li class="md-nav__item">
1558
+ <a href="#ensure-site-assets-library-exist" class="md-nav__link">
1559
+ Ensure Site Assets Library exist
1560
+ </a>
1561
+
1562
+ </li>
1563
+
1564
+ <li class="md-nav__item">
1565
+ <a href="#ensure-site-pages-library-exist" class="md-nav__link">
1566
+ Ensure Site Pages Library exist
1567
+ </a>
1568
+
1569
+ </li>
1570
+
1571
+ </ul>
1572
+ </nav>
1573
+
1574
+ </li>
1575
+
1576
+ <li class="md-nav__item">
1577
+ <a href="#ilist" class="md-nav__link">
1578
+ IList
1579
+ </a>
1580
+
1581
+ <nav class="md-nav" aria-label="IList">
1582
+ <ul class="md-nav__list">
1583
+
1584
+ <li class="md-nav__item">
1585
+ <a href="#update-a-list" class="md-nav__link">
1586
+ Update a list
1587
+ </a>
1588
+
1589
+ </li>
1590
+
1591
+ <li class="md-nav__item">
1592
+ <a href="#get-changes-on-a-list" class="md-nav__link">
1593
+ Get changes on a list
1594
+ </a>
1595
+
1596
+ </li>
1597
+
1598
+ <li class="md-nav__item">
1599
+ <a href="#get-list-items-using-a-caml-query" class="md-nav__link">
1600
+ Get list items using a CAML Query
1601
+ </a>
1602
+
1603
+ </li>
1604
+
1605
+ <li class="md-nav__item">
1606
+ <a href="#get-list-items-changes-using-a-token" class="md-nav__link">
1607
+ Get list items changes using a Token
1608
+ </a>
1609
+
1610
+ </li>
1611
+
1612
+ <li class="md-nav__item">
1613
+ <a href="#recycle-a-list" class="md-nav__link">
1614
+ Recycle a list
1615
+ </a>
1616
+
1617
+ </li>
1618
+
1619
+ <li class="md-nav__item">
1620
+ <a href="#render-list-data" class="md-nav__link">
1621
+ Render list data
1622
+ </a>
1623
+
1624
+ </li>
1625
+
1626
+ <li class="md-nav__item">
1627
+ <a href="#render-list-data-as-stream" class="md-nav__link">
1628
+ Render list data as stream
1629
+ </a>
1630
+
1631
+ </li>
1632
+
1633
+ <li class="md-nav__item">
1634
+ <a href="#reserve-list-item-id-for-idempotent-list-item-creation" class="md-nav__link">
1635
+ Reserve list item Id for idempotent list item creation
1636
+ </a>
1637
+
1638
+ </li>
1639
+
1640
+ <li class="md-nav__item">
1641
+ <a href="#get-list-item-entity-type-name" class="md-nav__link">
1642
+ Get list item entity type name
1643
+ </a>
1644
+
1645
+ </li>
1646
+
1647
+ <li class="md-nav__item">
1648
+ <a href="#add-a-list-item-using-path-folder-validation-and-set-field-values" class="md-nav__link">
1649
+ Add a list item using path (folder), validation and set field values
1650
+ </a>
1651
+
1652
+ </li>
1653
+
1654
+ </ul>
1655
+ </nav>
1656
+
1657
+ </li>
1658
+
1659
+ <li class="md-nav__item">
1660
+ <a href="#content-types-imports" class="md-nav__link">
1661
+ content-types imports
1662
+ </a>
1663
+
1664
+ <nav class="md-nav" aria-label="content-types imports">
1665
+ <ul class="md-nav__list">
1666
+
1667
+ <li class="md-nav__item">
1668
+ <a href="#contenttypes" class="md-nav__link">
1669
+ contentTypes
1670
+ </a>
1671
+
1672
+ </li>
1673
+
1674
+ </ul>
1675
+ </nav>
1676
+
1677
+ </li>
1678
+
1679
+ <li class="md-nav__item">
1680
+ <a href="#fields-imports" class="md-nav__link">
1681
+ fields imports
1682
+ </a>
1683
+
1684
+ <nav class="md-nav" aria-label="fields imports">
1685
+ <ul class="md-nav__list">
1686
+
1687
+ <li class="md-nav__item">
1688
+ <a href="#fields" class="md-nav__link">
1689
+ fields
1690
+ </a>
1691
+
1692
+ </li>
1693
+
1694
+ </ul>
1695
+ </nav>
1696
+
1697
+ </li>
1698
+
1699
+ <li class="md-nav__item">
1700
+ <a href="#folders-imports" class="md-nav__link">
1701
+ folders imports
1702
+ </a>
1703
+
1704
+ <nav class="md-nav" aria-label="folders imports">
1705
+ <ul class="md-nav__list">
1706
+
1707
+ <li class="md-nav__item">
1708
+ <a href="#folders" class="md-nav__link">
1709
+ folders
1710
+ </a>
1711
+
1712
+ </li>
1713
+
1714
+ </ul>
1715
+ </nav>
1716
+
1717
+ </li>
1718
+
1719
+ <li class="md-nav__item">
1720
+ <a href="#forms-imports" class="md-nav__link">
1721
+ forms imports
1722
+ </a>
1723
+
1724
+ <nav class="md-nav" aria-label="forms imports">
1725
+ <ul class="md-nav__list">
1726
+
1727
+ <li class="md-nav__item">
1728
+ <a href="#forms" class="md-nav__link">
1729
+ forms
1730
+ </a>
1731
+
1732
+ </li>
1733
+
1734
+ </ul>
1735
+ </nav>
1736
+
1737
+ </li>
1738
+
1739
+ <li class="md-nav__item">
1740
+ <a href="#items-imports" class="md-nav__link">
1741
+ items imports
1742
+ </a>
1743
+
1744
+ <nav class="md-nav" aria-label="items imports">
1745
+ <ul class="md-nav__list">
1746
+
1747
+ <li class="md-nav__item">
1748
+ <a href="#items" class="md-nav__link">
1749
+ items
1750
+ </a>
1751
+
1752
+ </li>
1753
+
1754
+ </ul>
1755
+ </nav>
1756
+
1757
+ </li>
1758
+
1759
+ <li class="md-nav__item">
1760
+ <a href="#views-imports" class="md-nav__link">
1761
+ views imports
1762
+ </a>
1763
+
1764
+ <nav class="md-nav" aria-label="views imports">
1765
+ <ul class="md-nav__list">
1766
+
1767
+ <li class="md-nav__item">
1768
+ <a href="#views" class="md-nav__link">
1769
+ views
1770
+ </a>
1771
+
1772
+ </li>
1773
+
1774
+ </ul>
1775
+ </nav>
1776
+
1777
+ </li>
1778
+
1779
+ <li class="md-nav__item">
1780
+ <a href="#security-imports" class="md-nav__link">
1781
+ security imports
1782
+ </a>
1783
+
1784
+ </li>
1785
+
1786
+ <li class="md-nav__item">
1787
+ <a href="#subscriptions-imports" class="md-nav__link">
1788
+ subscriptions imports
1789
+ </a>
1790
+
1791
+ <nav class="md-nav" aria-label="subscriptions imports">
1792
+ <ul class="md-nav__list">
1793
+
1794
+ <li class="md-nav__item">
1795
+ <a href="#subscriptions" class="md-nav__link">
1796
+ subscriptions
1797
+ </a>
1798
+
1799
+ </li>
1800
+
1801
+ </ul>
1802
+ </nav>
1803
+
1804
+ </li>
1805
+
1806
+ <li class="md-nav__item">
1807
+ <a href="#user-custom-actions-imports" class="md-nav__link">
1808
+ user-custom-actions imports
1809
+ </a>
1810
+
1811
+ </li>
1812
+
1813
+ <li class="md-nav__item">
1814
+ <a href="#usercustomactions" class="md-nav__link">
1815
+ userCustomActions
1816
+ </a>
1817
+
1818
+ <nav class="md-nav" aria-label="userCustomActions">
1819
+ <ul class="md-nav__list">
1820
+
1821
+ <li class="md-nav__item">
1822
+ <a href="#getparentinfos" class="md-nav__link">
1823
+ getParentInfos
1824
+ </a>
1825
+
1826
+ </li>
1827
+
1828
+ </ul>
1829
+ </nav>
1830
+
1831
+ </li>
1832
+
1833
+ </ul>
1834
+
1835
+ </nav>
1836
+
1837
+ </li>
1838
+
1839
+
1840
+
1841
+
1842
+
1843
+
1844
+
1845
+ <li class="md-nav__item">
1846
+ <a href="../navigation/" class="md-nav__link">
1847
+ Navigation
1848
+ </a>
1849
+ </li>
1850
+
1851
+
1852
+
1853
+
1854
+
1855
+
1856
+
1857
+ <li class="md-nav__item">
1858
+ <a href="../permissions/" class="md-nav__link">
1859
+ Permissions
1860
+ </a>
1861
+ </li>
1862
+
1863
+
1864
+
1865
+
1866
+
1867
+
1868
+
1869
+ <li class="md-nav__item">
1870
+ <a href="../profiles/" class="md-nav__link">
1871
+ Profiles
1872
+ </a>
1873
+ </li>
1874
+
1875
+
1876
+
1877
+
1878
+
1879
+
1880
+
1881
+ <li class="md-nav__item">
1882
+ <a href="../regional-settings/" class="md-nav__link">
1883
+ Regional Settings
1884
+ </a>
1885
+ </li>
1886
+
1887
+
1888
+
1889
+
1890
+
1891
+
1892
+
1893
+ <li class="md-nav__item">
1894
+ <a href="../related-items/" class="md-nav__link">
1895
+ Related Items
1896
+ </a>
1897
+ </li>
1898
+
1899
+
1900
+
1901
+
1902
+
1903
+
1904
+
1905
+ <li class="md-nav__item">
1906
+ <a href="../search/" class="md-nav__link">
1907
+ Search
1908
+ </a>
1909
+ </li>
1910
+
1911
+
1912
+
1913
+
1914
+
1915
+
1916
+
1917
+ <li class="md-nav__item">
1918
+ <a href="../security/" class="md-nav__link">
1919
+ Security
1920
+ </a>
1921
+ </li>
1922
+
1923
+
1924
+
1925
+
1926
+
1927
+
1928
+
1929
+ <li class="md-nav__item">
1930
+ <a href="../sharing/" class="md-nav__link">
1931
+ Sharing
1932
+ </a>
1933
+ </li>
1934
+
1935
+
1936
+
1937
+
1938
+
1939
+
1940
+
1941
+ <li class="md-nav__item">
1942
+ <a href="../site-designs/" class="md-nav__link">
1943
+ Site Designs
1944
+ </a>
1945
+ </li>
1946
+
1947
+
1948
+
1949
+
1950
+
1951
+
1952
+
1953
+ <li class="md-nav__item">
1954
+ <a href="../site-groups/" class="md-nav__link">
1955
+ Site Groups
1956
+ </a>
1957
+ </li>
1958
+
1959
+
1960
+
1961
+
1962
+
1963
+
1964
+
1965
+ <li class="md-nav__item">
1966
+ <a href="../site-scripts/" class="md-nav__link">
1967
+ Site Scripts
1968
+ </a>
1969
+ </li>
1970
+
1971
+
1972
+
1973
+
1974
+
1975
+
1976
+
1977
+ <li class="md-nav__item">
1978
+ <a href="../site-users/" class="md-nav__link">
1979
+ Site Users
1980
+ </a>
1981
+ </li>
1982
+
1983
+
1984
+
1985
+
1986
+
1987
+
1988
+
1989
+ <li class="md-nav__item">
1990
+ <a href="../sites/" class="md-nav__link">
1991
+ Sites
1992
+ </a>
1993
+ </li>
1994
+
1995
+
1996
+
1997
+
1998
+
1999
+
2000
+
2001
+ <li class="md-nav__item">
2002
+ <a href="../social/" class="md-nav__link">
2003
+ Social
2004
+ </a>
2005
+ </li>
2006
+
2007
+
2008
+
2009
+
2010
+
2011
+
2012
+
2013
+ <li class="md-nav__item">
2014
+ <a href="../sp-utilities-utility/" class="md-nav__link">
2015
+ SP.Utilities.Utility
2016
+ </a>
2017
+ </li>
2018
+
2019
+
2020
+
2021
+
2022
+
2023
+
2024
+
2025
+ <li class="md-nav__item">
2026
+ <a href="../subscriptions/" class="md-nav__link">
2027
+ Subscriptions
2028
+ </a>
2029
+ </li>
2030
+
2031
+
2032
+
2033
+
2034
+
2035
+
2036
+
2037
+ <li class="md-nav__item">
2038
+ <a href="../taxonomy/" class="md-nav__link">
2039
+ Taxonomy
2040
+ </a>
2041
+ </li>
2042
+
2043
+
2044
+
2045
+
2046
+
2047
+
2048
+
2049
+ <li class="md-nav__item">
2050
+ <a href="../tenant-properties/" class="md-nav__link">
2051
+ Tenant Properties
2052
+ </a>
2053
+ </li>
2054
+
2055
+
2056
+
2057
+
2058
+
2059
+
2060
+
2061
+ <li class="md-nav__item">
2062
+ <a href="../user-custom-actions/" class="md-nav__link">
2063
+ User custom actions
2064
+ </a>
2065
+ </li>
2066
+
2067
+
2068
+
2069
+
2070
+
2071
+
2072
+
2073
+ <li class="md-nav__item">
2074
+ <a href="../views/" class="md-nav__link">
2075
+ Views
2076
+ </a>
2077
+ </li>
2078
+
2079
+
2080
+
2081
+
2082
+
2083
+
2084
+
2085
+ <li class="md-nav__item">
2086
+ <a href="../webs/" class="md-nav__link">
2087
+ Webs
2088
+ </a>
2089
+ </li>
2090
+
2091
+
2092
+
2093
+
2094
+
2095
+
2096
+
2097
+ <li class="md-nav__item">
2098
+ <a href="../custom-irequestclient/" class="md-nav__link">
2099
+ Custom Request Client
2100
+ </a>
2101
+ </li>
2102
+
2103
+
2104
+ </ul>
2105
+ </nav>
2106
+ </li>
2107
+
2108
+
2109
+
2110
+
2111
+
2112
+
2113
+
2114
+ <li class="md-nav__item md-nav__item--nested">
2115
+
2116
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-6-10" type="checkbox" id="nav-6-10">
2117
+
2118
+ <label class="md-nav__link" for="nav-6-10">
2119
+ sp-addinhelpers
2120
+ <span class="md-nav__icon md-icon"></span>
2121
+ </label>
2122
+ <nav class="md-nav" aria-label="sp-addinhelpers" data-md-level="2">
2123
+ <label class="md-nav__title" for="nav-6-10">
2124
+ <span class="md-nav__icon md-icon"></span>
2125
+ sp-addinhelpers
2126
+ </label>
2127
+ <ul class="md-nav__list" data-md-scrollfix>
2128
+
2129
+
2130
+
2131
+
2132
+
2133
+
2134
+
2135
+ <li class="md-nav__item">
2136
+ <a href="../../sp-addinhelpers/" class="md-nav__link">
2137
+ sp-addinhelpers
2138
+ </a>
2139
+ </li>
2140
+
2141
+
2142
+
2143
+
2144
+
2145
+
2146
+
2147
+ <li class="md-nav__item">
2148
+ <a href="../../sp-addinhelpers/sp-request-executor-client/" class="md-nav__link">
2149
+ SPRequestExecutorClient
2150
+ </a>
2151
+ </li>
2152
+
2153
+
2154
+
2155
+
2156
+
2157
+
2158
+
2159
+ <li class="md-nav__item">
2160
+ <a href="../../sp-addinhelpers/sp-rest-addin/" class="md-nav__link">
2161
+ SPRestAddIn
2162
+ </a>
2163
+ </li>
2164
+
2165
+
2166
+ </ul>
2167
+ </nav>
2168
+ </li>
2169
+
2170
+
2171
+ </ul>
2172
+ </nav>
2173
+ </li>
2174
+
2175
+
2176
+
2177
+
2178
+
2179
+
2180
+
2181
+ <li class="md-nav__item md-nav__item--nested">
2182
+
2183
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7">
2184
+
2185
+ <label class="md-nav__link" for="nav-7">
2186
+ Contributing
2187
+ <span class="md-nav__icon md-icon"></span>
2188
+ </label>
2189
+ <nav class="md-nav" aria-label="Contributing" data-md-level="1">
2190
+ <label class="md-nav__title" for="nav-7">
2191
+ <span class="md-nav__icon md-icon"></span>
2192
+ Contributing
2193
+ </label>
2194
+ <ul class="md-nav__list" data-md-scrollfix>
2195
+
2196
+
2197
+
2198
+
2199
+
2200
+
2201
+
2202
+ <li class="md-nav__item">
2203
+ <a href="../../contributing/" class="md-nav__link">
2204
+ Contributing
2205
+ </a>
2206
+ </li>
2207
+
2208
+
2209
+
2210
+
2211
+
2212
+
2213
+
2214
+ <li class="md-nav__item">
2215
+ <a href="../../contributing/setup-dev-machine/" class="md-nav__link">
2216
+ Setup Dev Machine
2217
+ </a>
2218
+ </li>
2219
+
2220
+
2221
+
2222
+
2223
+
2224
+
2225
+
2226
+ <li class="md-nav__item">
2227
+ <a href="../../contributing/local-debug-configuration/" class="md-nav__link">
2228
+ Local Debug Configuration
2229
+ </a>
2230
+ </li>
2231
+
2232
+
2233
+
2234
+
2235
+
2236
+
2237
+
2238
+ <li class="md-nav__item">
2239
+ <a href="../../contributing/debugging/" class="md-nav__link">
2240
+ Debugging
2241
+ </a>
2242
+ </li>
2243
+
2244
+
2245
+
2246
+
2247
+
2248
+
2249
+
2250
+ <li class="md-nav__item">
2251
+ <a href="../../contributing/extending-the-library/" class="md-nav__link">
2252
+ Extending the library
2253
+ </a>
2254
+ </li>
2255
+
2256
+
2257
+
2258
+
2259
+
2260
+
2261
+
2262
+ <li class="md-nav__item">
2263
+ <a href="../../contributing/debug-tests/" class="md-nav__link">
2264
+ Writing Tests
2265
+ </a>
2266
+ </li>
2267
+
2268
+
2269
+
2270
+
2271
+
2272
+
2273
+
2274
+ <li class="md-nav__item">
2275
+ <a href="../../contributing/documentation/" class="md-nav__link">
2276
+ Update Documentation
2277
+ </a>
2278
+ </li>
2279
+
2280
+
2281
+
2282
+
2283
+
2284
+
2285
+
2286
+ <li class="md-nav__item">
2287
+ <a href="../../contributing/pull-requests/" class="md-nav__link">
2288
+ Submit a Pull Request
2289
+ </a>
2290
+ </li>
2291
+
2292
+
2293
+ </ul>
2294
+ </nav>
2295
+ </li>
2296
+
2297
+
2298
+
2299
+
2300
+
2301
+
2302
+
2303
+ <li class="md-nav__item md-nav__item--nested">
2304
+
2305
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8">
2306
+
2307
+ <label class="md-nav__link" for="nav-8">
2308
+ Version 1 Docs
2309
+ <span class="md-nav__icon md-icon"></span>
2310
+ </label>
2311
+ <nav class="md-nav" aria-label="Version 1 Docs" data-md-level="1">
2312
+ <label class="md-nav__title" for="nav-8">
2313
+ <span class="md-nav__icon md-icon"></span>
2314
+ Version 1 Docs
2315
+ </label>
2316
+ <ul class="md-nav__list" data-md-scrollfix>
2317
+
2318
+
2319
+
2320
+
2321
+
2322
+
2323
+
2324
+ <li class="md-nav__item">
2325
+ <a href="../../v1/" class="md-nav__link">
2326
+ Home
2327
+ </a>
2328
+ </li>
2329
+
2330
+
2331
+ </ul>
2332
+ </nav>
2333
+ </li>
2334
+
2335
+
2336
+
2337
+
2338
+
2339
+
2340
+
2341
+ <li class="md-nav__item md-nav__item--nested">
2342
+
2343
+ <input class="md-nav__toggle md-toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9">
2344
+
2345
+ <label class="md-nav__link" for="nav-9">
2346
+ Version 2 Docs
2347
+ <span class="md-nav__icon md-icon"></span>
2348
+ </label>
2349
+ <nav class="md-nav" aria-label="Version 2 Docs" data-md-level="1">
2350
+ <label class="md-nav__title" for="nav-9">
2351
+ <span class="md-nav__icon md-icon"></span>
2352
+ Version 2 Docs
2353
+ </label>
2354
+ <ul class="md-nav__list" data-md-scrollfix>
2355
+
2356
+
2357
+
2358
+
2359
+
2360
+
2361
+
2362
+ <li class="md-nav__item">
2363
+ <a href="../../v2/index.html" class="md-nav__link">
2364
+ Home
2365
+ </a>
2366
+ </li>
2367
+
2368
+
2369
+ </ul>
2370
+ </nav>
2371
+ </li>
2372
+
2373
+
2374
+ </ul>
2375
+ </nav>
2376
+ </div>
2377
+ </div>
2378
+ </div>
2379
+
2380
+
2381
+ <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
2382
+ <div class="md-sidebar__scrollwrap">
2383
+ <div class="md-sidebar__inner">
2384
+
2385
+ <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
2386
+
2387
+
2388
+
2389
+
2390
+
2391
+ <label class="md-nav__title" for="__toc">
2392
+ <span class="md-nav__icon md-icon"></span>
2393
+ Table of contents
2394
+ </label>
2395
+ <ul class="md-nav__list" data-md-scrollfix>
2396
+
2397
+ <li class="md-nav__item">
2398
+ <a href="#ilists" class="md-nav__link">
2399
+ ILists
2400
+ </a>
2401
+
2402
+ <nav class="md-nav" aria-label="ILists">
2403
+ <ul class="md-nav__list">
2404
+
2405
+ <li class="md-nav__item">
2406
+ <a href="#get-list-by-id" class="md-nav__link">
2407
+ Get List by Id
2408
+ </a>
2409
+
2410
+ </li>
2411
+
2412
+ <li class="md-nav__item">
2413
+ <a href="#get-list-by-title" class="md-nav__link">
2414
+ Get List by Title
2415
+ </a>
2416
+
2417
+ </li>
2418
+
2419
+ <li class="md-nav__item">
2420
+ <a href="#add-list" class="md-nav__link">
2421
+ Add List
2422
+ </a>
2423
+
2424
+ </li>
2425
+
2426
+ <li class="md-nav__item">
2427
+ <a href="#ensure-that-a-list-exists-by-title" class="md-nav__link">
2428
+ Ensure that a List exists (by title)
2429
+ </a>
2430
+
2431
+ </li>
2432
+
2433
+ <li class="md-nav__item">
2434
+ <a href="#ensure-site-assets-library-exist" class="md-nav__link">
2435
+ Ensure Site Assets Library exist
2436
+ </a>
2437
+
2438
+ </li>
2439
+
2440
+ <li class="md-nav__item">
2441
+ <a href="#ensure-site-pages-library-exist" class="md-nav__link">
2442
+ Ensure Site Pages Library exist
2443
+ </a>
2444
+
2445
+ </li>
2446
+
2447
+ </ul>
2448
+ </nav>
2449
+
2450
+ </li>
2451
+
2452
+ <li class="md-nav__item">
2453
+ <a href="#ilist" class="md-nav__link">
2454
+ IList
2455
+ </a>
2456
+
2457
+ <nav class="md-nav" aria-label="IList">
2458
+ <ul class="md-nav__list">
2459
+
2460
+ <li class="md-nav__item">
2461
+ <a href="#update-a-list" class="md-nav__link">
2462
+ Update a list
2463
+ </a>
2464
+
2465
+ </li>
2466
+
2467
+ <li class="md-nav__item">
2468
+ <a href="#get-changes-on-a-list" class="md-nav__link">
2469
+ Get changes on a list
2470
+ </a>
2471
+
2472
+ </li>
2473
+
2474
+ <li class="md-nav__item">
2475
+ <a href="#get-list-items-using-a-caml-query" class="md-nav__link">
2476
+ Get list items using a CAML Query
2477
+ </a>
2478
+
2479
+ </li>
2480
+
2481
+ <li class="md-nav__item">
2482
+ <a href="#get-list-items-changes-using-a-token" class="md-nav__link">
2483
+ Get list items changes using a Token
2484
+ </a>
2485
+
2486
+ </li>
2487
+
2488
+ <li class="md-nav__item">
2489
+ <a href="#recycle-a-list" class="md-nav__link">
2490
+ Recycle a list
2491
+ </a>
2492
+
2493
+ </li>
2494
+
2495
+ <li class="md-nav__item">
2496
+ <a href="#render-list-data" class="md-nav__link">
2497
+ Render list data
2498
+ </a>
2499
+
2500
+ </li>
2501
+
2502
+ <li class="md-nav__item">
2503
+ <a href="#render-list-data-as-stream" class="md-nav__link">
2504
+ Render list data as stream
2505
+ </a>
2506
+
2507
+ </li>
2508
+
2509
+ <li class="md-nav__item">
2510
+ <a href="#reserve-list-item-id-for-idempotent-list-item-creation" class="md-nav__link">
2511
+ Reserve list item Id for idempotent list item creation
2512
+ </a>
2513
+
2514
+ </li>
2515
+
2516
+ <li class="md-nav__item">
2517
+ <a href="#get-list-item-entity-type-name" class="md-nav__link">
2518
+ Get list item entity type name
2519
+ </a>
2520
+
2521
+ </li>
2522
+
2523
+ <li class="md-nav__item">
2524
+ <a href="#add-a-list-item-using-path-folder-validation-and-set-field-values" class="md-nav__link">
2525
+ Add a list item using path (folder), validation and set field values
2526
+ </a>
2527
+
2528
+ </li>
2529
+
2530
+ </ul>
2531
+ </nav>
2532
+
2533
+ </li>
2534
+
2535
+ <li class="md-nav__item">
2536
+ <a href="#content-types-imports" class="md-nav__link">
2537
+ content-types imports
2538
+ </a>
2539
+
2540
+ <nav class="md-nav" aria-label="content-types imports">
2541
+ <ul class="md-nav__list">
2542
+
2543
+ <li class="md-nav__item">
2544
+ <a href="#contenttypes" class="md-nav__link">
2545
+ contentTypes
2546
+ </a>
2547
+
2548
+ </li>
2549
+
2550
+ </ul>
2551
+ </nav>
2552
+
2553
+ </li>
2554
+
2555
+ <li class="md-nav__item">
2556
+ <a href="#fields-imports" class="md-nav__link">
2557
+ fields imports
2558
+ </a>
2559
+
2560
+ <nav class="md-nav" aria-label="fields imports">
2561
+ <ul class="md-nav__list">
2562
+
2563
+ <li class="md-nav__item">
2564
+ <a href="#fields" class="md-nav__link">
2565
+ fields
2566
+ </a>
2567
+
2568
+ </li>
2569
+
2570
+ </ul>
2571
+ </nav>
2572
+
2573
+ </li>
2574
+
2575
+ <li class="md-nav__item">
2576
+ <a href="#folders-imports" class="md-nav__link">
2577
+ folders imports
2578
+ </a>
2579
+
2580
+ <nav class="md-nav" aria-label="folders imports">
2581
+ <ul class="md-nav__list">
2582
+
2583
+ <li class="md-nav__item">
2584
+ <a href="#folders" class="md-nav__link">
2585
+ folders
2586
+ </a>
2587
+
2588
+ </li>
2589
+
2590
+ </ul>
2591
+ </nav>
2592
+
2593
+ </li>
2594
+
2595
+ <li class="md-nav__item">
2596
+ <a href="#forms-imports" class="md-nav__link">
2597
+ forms imports
2598
+ </a>
2599
+
2600
+ <nav class="md-nav" aria-label="forms imports">
2601
+ <ul class="md-nav__list">
2602
+
2603
+ <li class="md-nav__item">
2604
+ <a href="#forms" class="md-nav__link">
2605
+ forms
2606
+ </a>
2607
+
2608
+ </li>
2609
+
2610
+ </ul>
2611
+ </nav>
2612
+
2613
+ </li>
2614
+
2615
+ <li class="md-nav__item">
2616
+ <a href="#items-imports" class="md-nav__link">
2617
+ items imports
2618
+ </a>
2619
+
2620
+ <nav class="md-nav" aria-label="items imports">
2621
+ <ul class="md-nav__list">
2622
+
2623
+ <li class="md-nav__item">
2624
+ <a href="#items" class="md-nav__link">
2625
+ items
2626
+ </a>
2627
+
2628
+ </li>
2629
+
2630
+ </ul>
2631
+ </nav>
2632
+
2633
+ </li>
2634
+
2635
+ <li class="md-nav__item">
2636
+ <a href="#views-imports" class="md-nav__link">
2637
+ views imports
2638
+ </a>
2639
+
2640
+ <nav class="md-nav" aria-label="views imports">
2641
+ <ul class="md-nav__list">
2642
+
2643
+ <li class="md-nav__item">
2644
+ <a href="#views" class="md-nav__link">
2645
+ views
2646
+ </a>
2647
+
2648
+ </li>
2649
+
2650
+ </ul>
2651
+ </nav>
2652
+
2653
+ </li>
2654
+
2655
+ <li class="md-nav__item">
2656
+ <a href="#security-imports" class="md-nav__link">
2657
+ security imports
2658
+ </a>
2659
+
2660
+ </li>
2661
+
2662
+ <li class="md-nav__item">
2663
+ <a href="#subscriptions-imports" class="md-nav__link">
2664
+ subscriptions imports
2665
+ </a>
2666
+
2667
+ <nav class="md-nav" aria-label="subscriptions imports">
2668
+ <ul class="md-nav__list">
2669
+
2670
+ <li class="md-nav__item">
2671
+ <a href="#subscriptions" class="md-nav__link">
2672
+ subscriptions
2673
+ </a>
2674
+
2675
+ </li>
2676
+
2677
+ </ul>
2678
+ </nav>
2679
+
2680
+ </li>
2681
+
2682
+ <li class="md-nav__item">
2683
+ <a href="#user-custom-actions-imports" class="md-nav__link">
2684
+ user-custom-actions imports
2685
+ </a>
2686
+
2687
+ </li>
2688
+
2689
+ <li class="md-nav__item">
2690
+ <a href="#usercustomactions" class="md-nav__link">
2691
+ userCustomActions
2692
+ </a>
2693
+
2694
+ <nav class="md-nav" aria-label="userCustomActions">
2695
+ <ul class="md-nav__list">
2696
+
2697
+ <li class="md-nav__item">
2698
+ <a href="#getparentinfos" class="md-nav__link">
2699
+ getParentInfos
2700
+ </a>
2701
+
2702
+ </li>
2703
+
2704
+ </ul>
2705
+ </nav>
2706
+
2707
+ </li>
2708
+
2709
+ </ul>
2710
+
2711
+ </nav>
2712
+ </div>
2713
+ </div>
2714
+ </div>
2715
+
2716
+
2717
+ <div class="md-content">
2718
+ <article class="md-content__inner md-typeset">
2719
+
2720
+
2721
+ <a href="https://github.com/pnp/pnpjs/tree/version-2/docs/sp/lists.md" title="Edit this page" class="md-content__button md-icon">
2722
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
2723
+ </a>
2724
+
2725
+
2726
+ <h1 id="pnpsplists">@pnp/sp/lists<a class="headerlink" href="#pnpsplists" title="Permanent link">&para;</a></h1>
2727
+ <p>Lists in SharePoint are collections of information built in a structural way using columns and rows. Columns for metadata, and rows representing each entry. Visually, it reminds us a lot of a database table or an Excel spreadsheet.</p>
2728
+ <h2 id="ilists">ILists<a class="headerlink" href="#ilists" title="Permanent link">&para;</a></h2>
2729
+ <p><a href="../../concepts/invokable/"><img alt="Invokable Banner" src="https://img.shields.io/badge/Invokable-informational.svg" /></a> <a href="../../concepts/selective-imports/"><img alt="Selective Imports Banner" src="https://img.shields.io/badge/Selective%20Imports-informational.svg" /></a> </p>
2730
+ <table>
2731
+ <thead>
2732
+ <tr>
2733
+ <th>Scenario</th>
2734
+ <th>Import Statement</th>
2735
+ </tr>
2736
+ </thead>
2737
+ <tbody>
2738
+ <tr>
2739
+ <td>Selective 1</td>
2740
+ <td>import { sp } from "@pnp/sp";<br />import { Webs, IWebs } from "@pnp/sp/webs"; <br />import { Lists, ILists } from "@pnp/sp/lists";</td>
2741
+ </tr>
2742
+ <tr>
2743
+ <td>Selective 2</td>
2744
+ <td>import { sp } from "@pnp/sp";<br />import "@pnp/sp/webs";<br />import "@pnp/sp/lists";</td>
2745
+ </tr>
2746
+ <tr>
2747
+ <td>Preset: All</td>
2748
+ <td>import { sp, Lists, ILists } from "@pnp/sp/presets/all";</td>
2749
+ </tr>
2750
+ <tr>
2751
+ <td>Preset: Core</td>
2752
+ <td>import { sp, Lists, ILists } from "@pnp/sp/presets/core";</td>
2753
+ </tr>
2754
+ </tbody>
2755
+ </table>
2756
+ <h3 id="get-list-by-id">Get List by Id<a class="headerlink" href="#get-list-by-id" title="Permanent link">&para;</a></h3>
2757
+ <p>Gets a list from the collection by id (guid). Note that the library will handle a guid formatted with curly braces (i.e. '{03b05ff4-d95d-45ed-841d-3855f77a2483}') as well as without curly braces (i.e. '03b05ff4-d95d-45ed-841d-3855f77a2483'). The Id parameter is also case insensitive.</p>
2758
+ <pre><code class="language-TypeScript">import { sp } from &quot;@pnp/sp&quot;;
2759
+ import &quot;@pnp/sp/webs&quot;;
2760
+ import &quot;@pnp/sp/lists&quot;;
2761
+
2762
+ // get the list by Id
2763
+ const list = sp.web.lists.getById(&quot;03b05ff4-d95d-45ed-841d-3855f77a2483&quot;);
2764
+
2765
+ // we can use this 'list' variable to execute more queries on the list:
2766
+ const r = await list.select(&quot;Title&quot;)();
2767
+
2768
+ // show the response from the server
2769
+ console.log(r.Title);
2770
+ </code></pre>
2771
+ <h3 id="get-list-by-title">Get List by Title<a class="headerlink" href="#get-list-by-title" title="Permanent link">&para;</a></h3>
2772
+ <p>You can also get a list from the collection by title.</p>
2773
+ <pre><code class="language-TypeScript">import { sp } from &quot;@pnp/sp&quot;;
2774
+ import &quot;@pnp/sp/webs&quot;;
2775
+ import &quot;@pnp/sp/lists&quot;;
2776
+
2777
+ // get the default document library 'Documents'
2778
+ const list = sp.web.lists.getByTitle(&quot;Documents&quot;);
2779
+
2780
+ // we can use this 'list' variable to run more queries on the list:
2781
+ const r = await list.select(&quot;Id&quot;)();
2782
+
2783
+ // log the list Id to console
2784
+ console.log(r.Id);
2785
+ </code></pre>
2786
+ <h3 id="add-list">Add List<a class="headerlink" href="#add-list" title="Permanent link">&para;</a></h3>
2787
+ <p>You can add a list to the web's list collection using the .add-method. To invoke this method in its most simple form, you can provide only a title as a parameter. This will result in a standard out of the box list with all default settings, and the title you provide.</p>
2788
+ <pre><code class="language-TypeScript">// create a new list, passing only the title
2789
+ const listAddResult = await sp.web.lists.add(&quot;My new list&quot;);
2790
+
2791
+ // we can work with the list created using the IListAddResult.list property:
2792
+ const r = await listAddResult.list.select(&quot;Title&quot;)();
2793
+
2794
+ // log newly created list title to console
2795
+ console.log(r.Title);
2796
+ });
2797
+ </code></pre>
2798
+ <p>You can also provide other (optional) parameters like description, template and enableContentTypes. If that is not enough for you, you can use the parameter named 'additionalSettings' which is just a TypedHash, meaning you can sent whatever properties you'd like in the body (provided that the property is supported by the SharePoint API). You can find a <a href="https://docs.microsoft.com/en-us/dotnet/api/microsoft.sharepoint.splisttemplatetype?view=sharepoint-server">listing of list template codes</a> in the official docs.</p>
2799
+ <pre><code class="language-TypeScript">// this will create a list with template 101 (Document library), content types enabled and show it on the quick launch (using additionalSettings)
2800
+ const listAddResult = await sp.web.lists.add(&quot;My Doc Library&quot;, &quot;This is a description of doc lib.&quot;, 101, true, { OnQuickLaunch: true });
2801
+
2802
+ // get the Id of the newly added document library
2803
+ const r = await listAddResult.list.select(&quot;Id&quot;)();
2804
+
2805
+ // log id to console
2806
+ console.log(r.Id);
2807
+ </code></pre>
2808
+ <h3 id="ensure-that-a-list-exists-by-title">Ensure that a List exists (by title)<a class="headerlink" href="#ensure-that-a-list-exists-by-title" title="Permanent link">&para;</a></h3>
2809
+ <p>Ensures that the specified list exists in the collection (note: this method not supported for batching). Just like with the add-method (see examples above) you can provide only the title, or any or all of the optional parameters desc, template, enableContentTypes and additionalSettings.</p>
2810
+ <pre><code class="language-TypeScript">// ensure that a list exists. If it doesn't it will be created with the provided title (the rest of the settings will be default):
2811
+ const listEnsureResult = await sp.web.lists.ensure(&quot;My List&quot;);
2812
+
2813
+ // check if the list was created, or if it already existed:
2814
+ if (listEnsureResult.created) {
2815
+ console.log(&quot;My List was created!&quot;);
2816
+ } else {
2817
+ console.log(&quot;My List already existed!&quot;);
2818
+ }
2819
+
2820
+ // work on the created/updated list
2821
+ const r = await listEnsureResult.list.select(&quot;Id&quot;)();
2822
+
2823
+ // log the Id
2824
+ console.log(r.Id);
2825
+ </code></pre>
2826
+ <p>If the list already exists, the other settings you provide will be used to update the existing list.</p>
2827
+ <pre><code class="language-TypeScript">// add a new list to the lists collection of the web
2828
+ sp.web.lists.add(&quot;My List 2&quot;).then(async () =&gt; {
2829
+
2830
+ // then call ensure on the created list with an updated description
2831
+ const listEnsureResult = await sp.web.lists.ensure(&quot;My List 2&quot;, &quot;Updated description&quot;);
2832
+
2833
+ // get the updated description
2834
+ const r = await listEnsureResult.list.select(&quot;Description&quot;)();
2835
+
2836
+ // log the updated description
2837
+ console.log(r.Description);
2838
+ });
2839
+ </code></pre>
2840
+ <h3 id="ensure-site-assets-library-exist">Ensure Site Assets Library exist<a class="headerlink" href="#ensure-site-assets-library-exist" title="Permanent link">&para;</a></h3>
2841
+ <p>Gets a list that is the default asset location for images or other files, which the users upload to their wiki pages.</p>
2842
+ <pre><code class="language-TypeScript">// get Site Assets library
2843
+ const siteAssetsList = await sp.web.lists.ensureSiteAssetsLibrary();
2844
+
2845
+ // get the Title
2846
+ const r = await siteAssetsList.select(&quot;Title&quot;)();
2847
+
2848
+ // log Title
2849
+ console.log(r.Title);
2850
+ </code></pre>
2851
+ <h3 id="ensure-site-pages-library-exist">Ensure Site Pages Library exist<a class="headerlink" href="#ensure-site-pages-library-exist" title="Permanent link">&para;</a></h3>
2852
+ <p>Gets a list that is the default location for wiki pages.</p>
2853
+ <pre><code class="language-TypeScript">// get Site Pages library
2854
+ const siteAssetsList = await sp.web.lists.ensureSitePagesLibrary();
2855
+
2856
+ // get the Title
2857
+ const r = await siteAssetsList.select(&quot;Title&quot;)();
2858
+
2859
+ // log Title
2860
+ console.log(r.Title);
2861
+ </code></pre>
2862
+ <h2 id="ilist">IList<a class="headerlink" href="#ilist" title="Permanent link">&para;</a></h2>
2863
+ <p><a href="../../concepts/invokable/"><img alt="Invokable Banner" src="https://img.shields.io/badge/Invokable-informational.svg" /></a> <a href="../../concepts/selective-imports/"><img alt="Selective Imports Banner" src="https://img.shields.io/badge/Selective%20Imports-informational.svg" /></a> </p>
2864
+ <table>
2865
+ <thead>
2866
+ <tr>
2867
+ <th>Scenario</th>
2868
+ <th>Import Statement</th>
2869
+ </tr>
2870
+ </thead>
2871
+ <tbody>
2872
+ <tr>
2873
+ <td>Selective 1</td>
2874
+ <td>import { sp } from "@pnp/sp";<br />import { List, IList } from "@pnp/sp/lists";</td>
2875
+ </tr>
2876
+ <tr>
2877
+ <td>Selective 2</td>
2878
+ <td>import { sp } from "@pnp/sp";<br />import "@pnp/sp/lists";</td>
2879
+ </tr>
2880
+ <tr>
2881
+ <td>Preset: All</td>
2882
+ <td>import { sp, List, IList } from "@pnp/sp/presets/all";</td>
2883
+ </tr>
2884
+ <tr>
2885
+ <td>Preset: Core</td>
2886
+ <td>import { sp, List, IList } from "@pnp/sp/presets/core";</td>
2887
+ </tr>
2888
+ </tbody>
2889
+ </table>
2890
+ <h3 id="update-a-list">Update a list<a class="headerlink" href="#update-a-list" title="Permanent link">&para;</a></h3>
2891
+ <p>Update an existing list with the provided properties. You can also provide an eTag value that will be used in the IF-Match header (default is "*")</p>
2892
+ <pre><code class="language-TypeScript">import { IListUpdateResult } from &quot;@pnp/sp/lists&quot;;
2893
+
2894
+ // create a TypedHash object with the properties to update
2895
+ const updateProperties = {
2896
+ Description: &quot;This list title and description has been updated using PnPjs.&quot;,
2897
+ Title: &quot;Updated title&quot;,
2898
+ };
2899
+
2900
+ // update the list with the properties above
2901
+ list.update(updateProperties).then(async (l: IListUpdateResult) =&gt; {
2902
+
2903
+ // get the updated title and description
2904
+ const r = await l.list.select(&quot;Title&quot;, &quot;Description&quot;)();
2905
+
2906
+ // log the updated properties to the console
2907
+ console.log(r.Title);
2908
+ console.log(r.Description);
2909
+ });
2910
+ </code></pre>
2911
+ <h3 id="get-changes-on-a-list">Get changes on a list<a class="headerlink" href="#get-changes-on-a-list" title="Permanent link">&para;</a></h3>
2912
+ <p>From the change log, you can get a collection of changes that have occurred within the list based on the specified query.</p>
2913
+ <pre><code class="language-TypeScript">import { sp, IChangeQuery } from &quot;@pnp/sp&quot;;
2914
+
2915
+ // build the changeQuery object, here we look att changes regarding Add, DeleteObject and Restore
2916
+ const changeQuery: IChangeQuery = {
2917
+ Add: true,
2918
+ ChangeTokenEnd: null,
2919
+ ChangeTokenStart: null,
2920
+ DeleteObject: true,
2921
+ Rename: true,
2922
+ Restore: true,
2923
+ };
2924
+
2925
+ // get list changes
2926
+ const r = await list.getChanges(changeQuery);
2927
+
2928
+ // log changes to console
2929
+ console.log(r);
2930
+ </code></pre>
2931
+ <h3 id="get-list-items-using-a-caml-query">Get list items using a CAML Query<a class="headerlink" href="#get-list-items-using-a-caml-query" title="Permanent link">&para;</a></h3>
2932
+ <p>You can get items from SharePoint using a CAML Query.</p>
2933
+ <pre><code class="language-TypeScript">import { ICamlQuery } from &quot;@pnp/sp/lists&quot;;
2934
+
2935
+ // build the caml query object (in this example, we include Title field and limit rows to 5)
2936
+ const caml: ICamlQuery = {
2937
+ ViewXml: &quot;&lt;View&gt;&lt;ViewFields&gt;&lt;FieldRef Name='Title' /&gt;&lt;/ViewFields&gt;&lt;RowLimit&gt;5&lt;/RowLimit&gt;&lt;/View&gt;&quot;,
2938
+ };
2939
+
2940
+ // get list items
2941
+ const r = await list.getItemsByCAMLQuery(caml);
2942
+
2943
+ // log resulting array to console
2944
+ console.log(r);
2945
+ </code></pre>
2946
+ <p>If you need to get and expand a lookup field, there is a spread array parameter on the getItemsByCAMLQuery. This means that you can provide multiple properties to this method depending on how many lookup fields you are working with on your list. Below is a minimal example showing how to expand one field (RoleAssignment)</p>
2947
+ <pre><code class="language-TypeScript">import { ICamlQuery } from &quot;@pnp/sp/lists&quot;;
2948
+
2949
+ // build the caml query object (in this example, we include Title field and limit rows to 5)
2950
+ const caml: ICamlQuery = {
2951
+ ViewXml: &quot;&lt;View&gt;&lt;ViewFields&gt;&lt;FieldRef Name='Title' /&gt;&lt;FieldRef Name='RoleAssignments' /&gt;&lt;/ViewFields&gt;&lt;RowLimit&gt;5&lt;/RowLimit&gt;&lt;/View&gt;&quot;,
2952
+ };
2953
+
2954
+ // get list items
2955
+ const r = await list.getItemsByCAMLQuery(caml, &quot;RoleAssignments&quot;);
2956
+
2957
+ // log resulting item array to console
2958
+ console.log(r);
2959
+ </code></pre>
2960
+ <h3 id="get-list-items-changes-using-a-token">Get list items changes using a Token<a class="headerlink" href="#get-list-items-changes-using-a-token" title="Permanent link">&para;</a></h3>
2961
+ <pre><code class="language-TypeScript">import { IChangeLogItemQuery } from &quot;@pnp/sp/lists&quot;;
2962
+
2963
+ // build the caml query object (in this example, we include Title field and limit rows to 5)
2964
+ const changeLogItemQuery: IChangeLogItemQuery = {
2965
+ Contains: `&lt;Contains&gt;&lt;FieldRef Name=&quot;Title&quot;/&gt;&lt;Value Type=&quot;Text&quot;&gt;Item16&lt;/Value&gt;&lt;/Contains&gt;`,
2966
+ QueryOptions: `&lt;QueryOptions&gt;
2967
+ &lt;IncludeMandatoryColumns&gt;FALSE&lt;/IncludeMandatoryColumns&gt;
2968
+ &lt;DateInUtc&gt;False&lt;/DateInUtc&gt;
2969
+ &lt;IncludePermissions&gt;TRUE&lt;/IncludePermissions&gt;
2970
+ &lt;IncludeAttachmentUrls&gt;FALSE&lt;/IncludeAttachmentUrls&gt;
2971
+ &lt;Folder&gt;My List&lt;/Folder&gt;&lt;/QueryOptions&gt;`,
2972
+ };
2973
+
2974
+ // get list items
2975
+ const r = await list.getListItemChangesSinceToken(changeLogItemQuery);
2976
+
2977
+ // log resulting XML to console
2978
+ console.log(r);
2979
+ </code></pre>
2980
+ <h3 id="recycle-a-list">Recycle a list<a class="headerlink" href="#recycle-a-list" title="Permanent link">&para;</a></h3>
2981
+ <p>Removes the list from the web's list collection and puts it in the recycle bin.</p>
2982
+ <pre><code class="language-TypeScript">await list.recycle();
2983
+ </code></pre>
2984
+ <h3 id="render-list-data">Render list data<a class="headerlink" href="#render-list-data" title="Permanent link">&para;</a></h3>
2985
+ <pre><code class="language-TypeScript">import { IRenderListData } from &quot;@pnp/sp/lists&quot;;
2986
+
2987
+ // render list data, top 5 items
2988
+ const r: IRenderListData = await list.renderListData(&quot;&lt;View&gt;&lt;RowLimit&gt;5&lt;/RowLimit&gt;&lt;/View&gt;&quot;);
2989
+
2990
+ // log array of items in response
2991
+ console.log(r.Row);
2992
+ </code></pre>
2993
+ <h3 id="render-list-data-as-stream">Render list data as stream<a class="headerlink" href="#render-list-data-as-stream" title="Permanent link">&para;</a></h3>
2994
+ <pre><code class="language-TypeScript">import { IRenderListDataParameters } from &quot;@pnp/sp/lists&quot;;
2995
+
2996
+ // setup parameters object
2997
+ const renderListDataParams: IRenderListDataParameters = {
2998
+ ViewXml: &quot;&lt;View&gt;&lt;RowLimit&gt;5&lt;/RowLimit&gt;&lt;/View&gt;&quot;,
2999
+ };
3000
+
3001
+ // render list data as stream
3002
+ const r = await list.renderListDataAsStream(renderListDataParams);
3003
+
3004
+ // log array of items in response
3005
+ console.log(r.Row);
3006
+ </code></pre>
3007
+ <h3 id="reserve-list-item-id-for-idempotent-list-item-creation">Reserve list item Id for idempotent list item creation<a class="headerlink" href="#reserve-list-item-id-for-idempotent-list-item-creation" title="Permanent link">&para;</a></h3>
3008
+ <pre><code class="language-TypeScript">const listItemId = await list.reserveListItemId();
3009
+
3010
+ // log id to console
3011
+ console.log(listItemId);
3012
+ </code></pre>
3013
+ <h3 id="get-list-item-entity-type-name">Get list item entity type name<a class="headerlink" href="#get-list-item-entity-type-name" title="Permanent link">&para;</a></h3>
3014
+ <pre><code class="language-TypeScript">const entityTypeFullName = await list.getListItemEntityTypeFullName();
3015
+
3016
+ // log entity type name
3017
+ console.log(entityTypeFullName);
3018
+ </code></pre>
3019
+ <h3 id="add-a-list-item-using-path-folder-validation-and-set-field-values">Add a list item using path (folder), validation and set field values<a class="headerlink" href="#add-a-list-item-using-path-folder-validation-and-set-field-values" title="Permanent link">&para;</a></h3>
3020
+ <pre><code class="language-TypeScript">const list = await sp.webs.lists.getByTitle(&quot;MyList&quot;).select(&quot;Title&quot;, &quot;ParentWebUrl&quot;)();
3021
+ const formValues: IListItemFormUpdateValue[] = [
3022
+ {
3023
+ FieldName: &quot;Title&quot;,
3024
+ FieldValue: title,
3025
+ },
3026
+ ];
3027
+
3028
+ list.addValidateUpdateItemUsingPath(formValues,`${list.ParentWebUrl}/Lists/${list.Title}/MyFolder`)
3029
+
3030
+ </code></pre>
3031
+ <h2 id="content-types-imports">content-types imports<a class="headerlink" href="#content-types-imports" title="Permanent link">&para;</a></h2>
3032
+ <table>
3033
+ <thead>
3034
+ <tr>
3035
+ <th>Scenario</th>
3036
+ <th>Import Statement</th>
3037
+ </tr>
3038
+ </thead>
3039
+ <tbody>
3040
+ <tr>
3041
+ <td>Selective 1</td>
3042
+ <td>import "@pnp/sp/content-types";</td>
3043
+ </tr>
3044
+ <tr>
3045
+ <td>Selective 2</td>
3046
+ <td>import "@pnp/sp/content-types/list";</td>
3047
+ </tr>
3048
+ <tr>
3049
+ <td>Preset: All</td>
3050
+ <td>import { sp } from "@pnp/sp/presets/all";</td>
3051
+ </tr>
3052
+ </tbody>
3053
+ </table>
3054
+ <h3 id="contenttypes">contentTypes<a class="headerlink" href="#contenttypes" title="Permanent link">&para;</a></h3>
3055
+ <p>Get all content types for a list</p>
3056
+ <pre><code class="language-TypeScript">const list = sp.web.lists.getByTitle(&quot;Documents&quot;);
3057
+ const r = await list.contentTypes();
3058
+ </code></pre>
3059
+ <h2 id="fields-imports">fields imports<a class="headerlink" href="#fields-imports" title="Permanent link">&para;</a></h2>
3060
+ <table>
3061
+ <thead>
3062
+ <tr>
3063
+ <th>Scenario</th>
3064
+ <th>Import Statement</th>
3065
+ </tr>
3066
+ </thead>
3067
+ <tbody>
3068
+ <tr>
3069
+ <td>Selective 1</td>
3070
+ <td>import "@pnp/sp/fields";</td>
3071
+ </tr>
3072
+ <tr>
3073
+ <td>Selective 2</td>
3074
+ <td>import "@pnp/sp/fields/list";</td>
3075
+ </tr>
3076
+ <tr>
3077
+ <td>Preset: All</td>
3078
+ <td>import { sp } from "@pnp/sp/presets/all";</td>
3079
+ </tr>
3080
+ </tbody>
3081
+ </table>
3082
+ <h3 id="fields">fields<a class="headerlink" href="#fields" title="Permanent link">&para;</a></h3>
3083
+ <p>Get all the fields for a list</p>
3084
+ <pre><code class="language-TypeScript">const list = sp.web.lists.getByTitle(&quot;Documents&quot;);
3085
+ const r = await list.fields();
3086
+ </code></pre>
3087
+ <p>Add a field to the site, then add the site field to a list</p>
3088
+ <pre><code class="language-TypeScript">const fld = await sp.site.rootWeb.fields.addText(&quot;MyField&quot;);
3089
+ await sp.web.lists.getByTitle(&quot;MyList&quot;).fields.createFieldAsXml(fld.data.SchemaXml);
3090
+ </code></pre>
3091
+ <h2 id="folders-imports">folders imports<a class="headerlink" href="#folders-imports" title="Permanent link">&para;</a></h2>
3092
+ <table>
3093
+ <thead>
3094
+ <tr>
3095
+ <th>Scenario</th>
3096
+ <th>Import Statement</th>
3097
+ </tr>
3098
+ </thead>
3099
+ <tbody>
3100
+ <tr>
3101
+ <td>Selective 1</td>
3102
+ <td>import "@pnp/sp/folders";</td>
3103
+ </tr>
3104
+ <tr>
3105
+ <td>Selective 2</td>
3106
+ <td>import "@pnp/sp/folders/list";</td>
3107
+ </tr>
3108
+ <tr>
3109
+ <td>Preset: All</td>
3110
+ <td>import { sp } from "@pnp/sp/presets/all";</td>
3111
+ </tr>
3112
+ </tbody>
3113
+ </table>
3114
+ <h3 id="folders">folders<a class="headerlink" href="#folders" title="Permanent link">&para;</a></h3>
3115
+ <p>Get the root folder of a list.</p>
3116
+ <pre><code class="language-TypeScript">const list = sp.web.lists.getByTitle(&quot;Documents&quot;);
3117
+ const r = await list.rootFolder();
3118
+ </code></pre>
3119
+ <h2 id="forms-imports">forms imports<a class="headerlink" href="#forms-imports" title="Permanent link">&para;</a></h2>
3120
+ <table>
3121
+ <thead>
3122
+ <tr>
3123
+ <th>Scenario</th>
3124
+ <th>Import Statement</th>
3125
+ </tr>
3126
+ </thead>
3127
+ <tbody>
3128
+ <tr>
3129
+ <td>Selective 1</td>
3130
+ <td>import "@pnp/sp/forms";</td>
3131
+ </tr>
3132
+ <tr>
3133
+ <td>Selective 2</td>
3134
+ <td>import "@pnp/sp/forms/list";</td>
3135
+ </tr>
3136
+ <tr>
3137
+ <td>Preset: All</td>
3138
+ <td>import { sp } from "@pnp/sp/presets/all";</td>
3139
+ </tr>
3140
+ </tbody>
3141
+ </table>
3142
+ <h3 id="forms">forms<a class="headerlink" href="#forms" title="Permanent link">&para;</a></h3>
3143
+ <pre><code class="language-TypeScript">const r = await list.forms();
3144
+ </code></pre>
3145
+ <h2 id="items-imports">items imports<a class="headerlink" href="#items-imports" title="Permanent link">&para;</a></h2>
3146
+ <table>
3147
+ <thead>
3148
+ <tr>
3149
+ <th>Scenario</th>
3150
+ <th>Import Statement</th>
3151
+ </tr>
3152
+ </thead>
3153
+ <tbody>
3154
+ <tr>
3155
+ <td>Selective 1</td>
3156
+ <td>import "@pnp/sp/items";</td>
3157
+ </tr>
3158
+ <tr>
3159
+ <td>Selective 2</td>
3160
+ <td>import "@pnp/sp/items/list";</td>
3161
+ </tr>
3162
+ <tr>
3163
+ <td>Preset: All</td>
3164
+ <td>import { sp } from "@pnp/sp/presets/all";</td>
3165
+ </tr>
3166
+ </tbody>
3167
+ </table>
3168
+ <h3 id="items">items<a class="headerlink" href="#items" title="Permanent link">&para;</a></h3>
3169
+ <p>Get a collection of list items.</p>
3170
+ <pre><code class="language-TypeScript">const r = await list.items();
3171
+ </code></pre>
3172
+ <h2 id="views-imports">views imports<a class="headerlink" href="#views-imports" title="Permanent link">&para;</a></h2>
3173
+ <table>
3174
+ <thead>
3175
+ <tr>
3176
+ <th>Scenario</th>
3177
+ <th>Import Statement</th>
3178
+ </tr>
3179
+ </thead>
3180
+ <tbody>
3181
+ <tr>
3182
+ <td>Selective 1</td>
3183
+ <td>import "@pnp/sp/views";</td>
3184
+ </tr>
3185
+ <tr>
3186
+ <td>Selective 2</td>
3187
+ <td>import "@pnp/sp/views/list";</td>
3188
+ </tr>
3189
+ <tr>
3190
+ <td>Preset: All</td>
3191
+ <td>import { sp } from "@pnp/sp/presets/all";</td>
3192
+ </tr>
3193
+ </tbody>
3194
+ </table>
3195
+ <h3 id="views">views<a class="headerlink" href="#views" title="Permanent link">&para;</a></h3>
3196
+ <p>Get the default view of the list</p>
3197
+ <pre><code class="language-TypeScript">const list = sp.web.lists.getByTitle(&quot;Documents&quot;);
3198
+ const views = await list.views();
3199
+ const defaultView = await list.defaultView();
3200
+ </code></pre>
3201
+ <p>Get a list view by Id</p>
3202
+ <pre><code class="language-TypeScript">const view = await list.getView(defaultView.Id).select(&quot;Title&quot;)();
3203
+ </code></pre>
3204
+ <h2 id="security-imports">security imports<a class="headerlink" href="#security-imports" title="Permanent link">&para;</a></h2>
3205
+ <p>To work with list security, you can import the list methods as follows:</p>
3206
+ <pre><code class="language-TypeScript">import &quot;@pnp/sp/security/list&quot;;
3207
+ </code></pre>
3208
+ <p>For more information on how to call security methods for lists, please refer to the <a href="../security/">@pnp/sp/security</a> documentation.</p>
3209
+ <h2 id="subscriptions-imports">subscriptions imports<a class="headerlink" href="#subscriptions-imports" title="Permanent link">&para;</a></h2>
3210
+ <table>
3211
+ <thead>
3212
+ <tr>
3213
+ <th>Scenario</th>
3214
+ <th>Import Statement</th>
3215
+ </tr>
3216
+ </thead>
3217
+ <tbody>
3218
+ <tr>
3219
+ <td>Selective 1</td>
3220
+ <td>import "@pnp/sp/subscriptions";</td>
3221
+ </tr>
3222
+ <tr>
3223
+ <td>Selective 2</td>
3224
+ <td>import "@pnp/sp/subscriptions/list";</td>
3225
+ </tr>
3226
+ <tr>
3227
+ <td>Preset: All</td>
3228
+ <td>import { sp } from "@pnp/sp/presets/all";</td>
3229
+ </tr>
3230
+ </tbody>
3231
+ </table>
3232
+ <h3 id="subscriptions">subscriptions<a class="headerlink" href="#subscriptions" title="Permanent link">&para;</a></h3>
3233
+ <p>Get all subscriptions on the list</p>
3234
+ <pre><code class="language-TypeScript">const list = sp.web.lists.getByTitle(&quot;Documents&quot;);
3235
+ const subscriptions = await list.subscriptions();
3236
+ </code></pre>
3237
+ <h2 id="user-custom-actions-imports">user-custom-actions imports<a class="headerlink" href="#user-custom-actions-imports" title="Permanent link">&para;</a></h2>
3238
+ <table>
3239
+ <thead>
3240
+ <tr>
3241
+ <th>Scenario</th>
3242
+ <th>Import Statement</th>
3243
+ </tr>
3244
+ </thead>
3245
+ <tbody>
3246
+ <tr>
3247
+ <td>Selective 1</td>
3248
+ <td>import "@pnp/sp/user-custom-actions";</td>
3249
+ </tr>
3250
+ <tr>
3251
+ <td>Selective 2</td>
3252
+ <td>import "@pnp/sp/user-custom-actions/web";</td>
3253
+ </tr>
3254
+ <tr>
3255
+ <td>Preset: All</td>
3256
+ <td>import { sp } from "@pnp/sp/presets/all";</td>
3257
+ </tr>
3258
+ </tbody>
3259
+ </table>
3260
+ <h2 id="usercustomactions">userCustomActions<a class="headerlink" href="#usercustomactions" title="Permanent link">&para;</a></h2>
3261
+ <p>Get a collection of the list's user custom actions.</p>
3262
+ <pre><code class="language-TypeScript">const list = sp.web.lists.getByTitle(&quot;Documents&quot;);
3263
+ const r = await list.userCustomActions();
3264
+ </code></pre>
3265
+ <h3 id="getparentinfos">getParentInfos<a class="headerlink" href="#getparentinfos" title="Permanent link">&para;</a></h3>
3266
+ <p><em>Added in 2.0.12</em></p>
3267
+ <p>Gets information about an list, including details about the parent list root folder, and parent web.</p>
3268
+ <pre><code class="language-TypeScript">import { sp } from &quot;@pnp/sp&quot;;
3269
+ import &quot;@pnp/sp/webs&quot;;
3270
+ import &quot;@pnp/sp/items&quot;;
3271
+
3272
+ const list = sp.web.lists.getByTitle(&quot;Documents&quot;);
3273
+ await list.getParentInfos();
3274
+ </code></pre>
3275
+
3276
+
3277
+
3278
+
3279
+
3280
+
3281
+
3282
+ </article>
3283
+ </div>
3284
+ </div>
3285
+ </main>
3286
+
3287
+
3288
+ <footer class="md-footer">
3289
+
3290
+ <div class="md-footer-nav">
3291
+ <nav class="md-footer-nav__inner md-grid" aria-label="Footer">
3292
+
3293
+ <a href="../items/" class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
3294
+ <div class="md-footer-nav__button md-icon">
3295
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
3296
+ </div>
3297
+ <div class="md-footer-nav__title">
3298
+ <div class="md-ellipsis">
3299
+ <span class="md-footer-nav__direction">
3300
+ Previous
3301
+ </span>
3302
+ List Items
3303
+ </div>
3304
+ </div>
3305
+ </a>
3306
+
3307
+
3308
+ <a href="../navigation/" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
3309
+ <div class="md-footer-nav__title">
3310
+ <div class="md-ellipsis">
3311
+ <span class="md-footer-nav__direction">
3312
+ Next
3313
+ </span>
3314
+ Navigation
3315
+ </div>
3316
+ </div>
3317
+ <div class="md-footer-nav__button md-icon">
3318
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
3319
+ </div>
3320
+ </a>
3321
+
3322
+ </nav>
3323
+ </div>
3324
+
3325
+ <div class="md-footer-meta md-typeset">
3326
+ <div class="md-footer-meta__inner md-grid">
3327
+ <div class="md-footer-copyright">
3328
+
3329
+ Made with
3330
+ <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
3331
+ Material for MkDocs
3332
+ </a>
3333
+ </div>
3334
+
3335
+ <div class="md-footer-social">
3336
+
3337
+
3338
+
3339
+
3340
+
3341
+
3342
+ <a href="https://twitter.com/m365pnpjs" target="_blank" rel="noopener" title="twitter.com" class="md-footer-social__link">
3343
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"/></svg>
3344
+ </a>
3345
+
3346
+
3347
+
3348
+
3349
+
3350
+
3351
+ <a href="http://aka.ms/sppnp-videos" target="_blank" rel="noopener" title="aka.ms" class="md-footer-social__link">
3352
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><path d="M549.655 124.083c-6.281-23.65-24.787-42.276-48.284-48.597C458.781 64 288 64 288 64S117.22 64 74.629 75.486c-23.497 6.322-42.003 24.947-48.284 48.597-11.412 42.867-11.412 132.305-11.412 132.305s0 89.438 11.412 132.305c6.281 23.65 24.787 41.5 48.284 47.821C117.22 448 288 448 288 448s170.78 0 213.371-11.486c23.497-6.321 42.003-24.171 48.284-47.821 11.412-42.867 11.412-132.305 11.412-132.305s0-89.438-11.412-132.305zm-317.51 213.508V175.185l142.739 81.205-142.739 81.201z"/></svg>
3353
+ </a>
3354
+
3355
+
3356
+
3357
+
3358
+
3359
+
3360
+ <a href="https://aka.ms/sppnp" target="_blank" rel="noopener" title="aka.ms" class="md-footer-social__link">
3361
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M0 32h214.6v214.6H0V32zm233.4 0H448v214.6H233.4V32zM0 265.4h214.6V480H0V265.4zm233.4 0H448V480H233.4V265.4z"/></svg>
3362
+ </a>
3363
+
3364
+ </div>
3365
+
3366
+ </div>
3367
+ </div>
3368
+ </footer>
3369
+
3370
+ </div>
3371
+
3372
+ <script src="../../assets/javascripts/vendor.77e55a48.min.js"></script>
3373
+ <script src="../../assets/javascripts/bundle.9554a270.min.js"></script><script id="__lang" type="application/json">{"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}</script>
3374
+
3375
+ <script>
3376
+ app = initialize({
3377
+ base: "../..",
3378
+ features: [],
3379
+ search: Object.assign({
3380
+ worker: "../../assets/javascripts/worker/search.4ac00218.min.js"
3381
+ }, typeof search !== "undefined" && search)
3382
+ })
3383
+ </script>
3384
+
3385
+
3386
+ </body>
3387
+ </html>