@salesforce/b2c-tooling-sdk 1.19.1 → 1.20.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (582) hide show
  1. package/data/guides/index.json +99 -2301
  2. package/data/help/index.json +9685 -0
  3. package/data/script-api/index.json +1 -528
  4. package/data/tooling/index.json +4 -4
  5. package/data/xsd/index.json +1 -1
  6. package/dist/esm/cli/base-command.js +5 -0
  7. package/dist/esm/cli/base-command.js.map +1 -1
  8. package/dist/esm/cli/oauth-command.js +6 -2
  9. package/dist/esm/cli/oauth-command.js.map +1 -1
  10. package/dist/esm/clients/index.d.ts +2 -0
  11. package/dist/esm/clients/index.js +1 -0
  12. package/dist/esm/clients/index.js.map +1 -1
  13. package/dist/esm/clients/middleware-registry.d.ts +1 -1
  14. package/dist/esm/clients/middleware-registry.js.map +1 -1
  15. package/dist/esm/clients/preferences.d.ts +83 -0
  16. package/dist/esm/clients/preferences.generated.d.ts +1651 -0
  17. package/dist/esm/clients/preferences.generated.js +6 -0
  18. package/dist/esm/clients/preferences.generated.js.map +1 -0
  19. package/dist/esm/clients/preferences.js +64 -0
  20. package/dist/esm/clients/preferences.js.map +1 -0
  21. package/dist/esm/config/dw-json.d.ts +2 -0
  22. package/dist/esm/config/dw-json.js.map +1 -1
  23. package/dist/esm/config/mapping.js +4 -0
  24. package/dist/esm/config/mapping.js.map +1 -1
  25. package/dist/esm/config/sources/dw-json-source.js +17 -4
  26. package/dist/esm/config/sources/dw-json-source.js.map +1 -1
  27. package/dist/esm/config/sources/env-source.js +2 -0
  28. package/dist/esm/config/sources/env-source.js.map +1 -1
  29. package/dist/esm/config/types.d.ts +14 -0
  30. package/dist/esm/discovery/patterns/storefront-next.js +6 -8
  31. package/dist/esm/discovery/patterns/storefront-next.js.map +1 -1
  32. package/dist/esm/docs/content-cache.d.ts +70 -0
  33. package/dist/esm/docs/content-cache.js +186 -0
  34. package/dist/esm/docs/content-cache.js.map +1 -0
  35. package/dist/esm/docs/index.d.ts +1 -0
  36. package/dist/esm/docs/index.js +2 -0
  37. package/dist/esm/docs/index.js.map +1 -1
  38. package/dist/esm/docs/search.js +34 -6
  39. package/dist/esm/docs/search.js.map +1 -1
  40. package/dist/esm/docs/types.d.ts +6 -1
  41. package/dist/esm/docs/types.js +1 -0
  42. package/dist/esm/docs/types.js.map +1 -1
  43. package/dist/esm/index.d.ts +2 -2
  44. package/dist/esm/index.js +1 -1
  45. package/dist/esm/index.js.map +1 -1
  46. package/dist/esm/operations/jobs/discover.d.ts +46 -0
  47. package/dist/esm/operations/jobs/discover.js +87 -0
  48. package/dist/esm/operations/jobs/discover.js.map +1 -0
  49. package/dist/esm/operations/jobs/index.d.ts +2 -0
  50. package/dist/esm/operations/jobs/index.js +2 -0
  51. package/dist/esm/operations/jobs/index.js.map +1 -1
  52. package/dist/esm/operations/jobs/run.js +4 -3
  53. package/dist/esm/operations/jobs/run.js.map +1 -1
  54. package/package.json +6 -3
  55. package/specs/preferences-v1.yaml +2095 -0
  56. package/data/script-api/TopLevel.APIException.md +0 -119
  57. package/data/script-api/TopLevel.Array.md +0 -732
  58. package/data/script-api/TopLevel.ArrayBuffer.md +0 -97
  59. package/data/script-api/TopLevel.BigInt.md +0 -154
  60. package/data/script-api/TopLevel.Boolean.md +0 -83
  61. package/data/script-api/TopLevel.ConversionError.md +0 -51
  62. package/data/script-api/TopLevel.DataView.md +0 -271
  63. package/data/script-api/TopLevel.Date.md +0 -688
  64. package/data/script-api/TopLevel.ES6Iterator.md +0 -47
  65. package/data/script-api/TopLevel.Error.md +0 -124
  66. package/data/script-api/TopLevel.EvalError.md +0 -47
  67. package/data/script-api/TopLevel.Fault.md +0 -133
  68. package/data/script-api/TopLevel.Float32Array.md +0 -186
  69. package/data/script-api/TopLevel.Float64Array.md +0 -186
  70. package/data/script-api/TopLevel.Function.md +0 -114
  71. package/data/script-api/TopLevel.Generator.md +0 -132
  72. package/data/script-api/TopLevel.IOError.md +0 -98
  73. package/data/script-api/TopLevel.Int16Array.md +0 -186
  74. package/data/script-api/TopLevel.Int32Array.md +0 -186
  75. package/data/script-api/TopLevel.Int8Array.md +0 -186
  76. package/data/script-api/TopLevel.InternalError.md +0 -47
  77. package/data/script-api/TopLevel.Iterable.md +0 -44
  78. package/data/script-api/TopLevel.Iterator.md +0 -89
  79. package/data/script-api/TopLevel.JSON.md +0 -173
  80. package/data/script-api/TopLevel.Map.md +0 -189
  81. package/data/script-api/TopLevel.Math.md +0 -948
  82. package/data/script-api/TopLevel.Module.md +0 -152
  83. package/data/script-api/TopLevel.Namespace.md +0 -152
  84. package/data/script-api/TopLevel.Number.md +0 -404
  85. package/data/script-api/TopLevel.Object.md +0 -472
  86. package/data/script-api/TopLevel.QName.md +0 -147
  87. package/data/script-api/TopLevel.RangeError.md +0 -47
  88. package/data/script-api/TopLevel.ReferenceError.md +0 -47
  89. package/data/script-api/TopLevel.RegExp.md +0 -155
  90. package/data/script-api/TopLevel.Set.md +0 -150
  91. package/data/script-api/TopLevel.StopIteration.md +0 -36
  92. package/data/script-api/TopLevel.String.md +0 -1060
  93. package/data/script-api/TopLevel.Symbol.md +0 -196
  94. package/data/script-api/TopLevel.SyntaxError.md +0 -47
  95. package/data/script-api/TopLevel.SystemError.md +0 -99
  96. package/data/script-api/TopLevel.TypeError.md +0 -47
  97. package/data/script-api/TopLevel.URIError.md +0 -47
  98. package/data/script-api/TopLevel.Uint16Array.md +0 -186
  99. package/data/script-api/TopLevel.Uint32Array.md +0 -186
  100. package/data/script-api/TopLevel.Uint8Array.md +0 -186
  101. package/data/script-api/TopLevel.Uint8ClampedArray.md +0 -186
  102. package/data/script-api/TopLevel.WeakMap.md +0 -135
  103. package/data/script-api/TopLevel.WeakSet.md +0 -96
  104. package/data/script-api/TopLevel.XML.md +0 -922
  105. package/data/script-api/TopLevel.XMLList.md +0 -418
  106. package/data/script-api/TopLevel.XMLStreamError.md +0 -115
  107. package/data/script-api/TopLevel.arguments.md +0 -56
  108. package/data/script-api/TopLevel.global.md +0 -539
  109. package/data/script-api/TopLevel.md +0 -58
  110. package/data/script-api/dw.alert.Alert.md +0 -175
  111. package/data/script-api/dw.alert.Alerts.md +0 -256
  112. package/data/script-api/dw.alert.md +0 -7
  113. package/data/script-api/dw.campaign.ABTest.md +0 -63
  114. package/data/script-api/dw.campaign.ABTestMgr.md +0 -76
  115. package/data/script-api/dw.campaign.ABTestSegment.md +0 -107
  116. package/data/script-api/dw.campaign.AmountDiscount.md +0 -70
  117. package/data/script-api/dw.campaign.ApproachingDiscount.md +0 -157
  118. package/data/script-api/dw.campaign.BonusChoiceDiscount.md +0 -190
  119. package/data/script-api/dw.campaign.BonusDiscount.md +0 -59
  120. package/data/script-api/dw.campaign.Campaign.md +0 -346
  121. package/data/script-api/dw.campaign.CampaignMgr.md +0 -436
  122. package/data/script-api/dw.campaign.CampaignStatusCodes.md +0 -103
  123. package/data/script-api/dw.campaign.Coupon.md +0 -324
  124. package/data/script-api/dw.campaign.CouponMgr.md +0 -137
  125. package/data/script-api/dw.campaign.CouponRedemption.md +0 -87
  126. package/data/script-api/dw.campaign.CouponStatusCodes.md +0 -130
  127. package/data/script-api/dw.campaign.Discount.md +0 -271
  128. package/data/script-api/dw.campaign.DiscountPlan.md +0 -322
  129. package/data/script-api/dw.campaign.FixedPriceDiscount.md +0 -74
  130. package/data/script-api/dw.campaign.FixedPriceShippingDiscount.md +0 -74
  131. package/data/script-api/dw.campaign.FreeDiscount.md +0 -24
  132. package/data/script-api/dw.campaign.FreeShippingDiscount.md +0 -24
  133. package/data/script-api/dw.campaign.PercentageDiscount.md +0 -74
  134. package/data/script-api/dw.campaign.PercentageOptionDiscount.md +0 -59
  135. package/data/script-api/dw.campaign.PriceBookPriceDiscount.md +0 -56
  136. package/data/script-api/dw.campaign.Promotion.md +0 -939
  137. package/data/script-api/dw.campaign.PromotionMgr.md +0 -478
  138. package/data/script-api/dw.campaign.PromotionPlan.md +0 -378
  139. package/data/script-api/dw.campaign.SlotContent.md +0 -131
  140. package/data/script-api/dw.campaign.SourceCodeGroup.md +0 -83
  141. package/data/script-api/dw.campaign.SourceCodeInfo.md +0 -167
  142. package/data/script-api/dw.campaign.SourceCodeStatusCodes.md +0 -61
  143. package/data/script-api/dw.campaign.TotalFixedPriceDiscount.md +0 -56
  144. package/data/script-api/dw.campaign.md +0 -36
  145. package/data/script-api/dw.catalog.Catalog.md +0 -158
  146. package/data/script-api/dw.catalog.CatalogMgr.md +0 -161
  147. package/data/script-api/dw.catalog.Category.md +0 -1212
  148. package/data/script-api/dw.catalog.CategoryAssignment.md +0 -179
  149. package/data/script-api/dw.catalog.CategoryLink.md +0 -142
  150. package/data/script-api/dw.catalog.PriceBook.md +0 -215
  151. package/data/script-api/dw.catalog.PriceBookMgr.md +0 -176
  152. package/data/script-api/dw.catalog.Product.md +0 -2492
  153. package/data/script-api/dw.catalog.ProductActiveData.md +0 -1244
  154. package/data/script-api/dw.catalog.ProductAttributeModel.md +0 -409
  155. package/data/script-api/dw.catalog.ProductAvailabilityLevels.md +0 -125
  156. package/data/script-api/dw.catalog.ProductAvailabilityModel.md +0 -516
  157. package/data/script-api/dw.catalog.ProductInventoryList.md +0 -136
  158. package/data/script-api/dw.catalog.ProductInventoryMgr.md +0 -132
  159. package/data/script-api/dw.catalog.ProductInventoryRecord.md +0 -638
  160. package/data/script-api/dw.catalog.ProductLink.md +0 -166
  161. package/data/script-api/dw.catalog.ProductMgr.md +0 -136
  162. package/data/script-api/dw.catalog.ProductOption.md +0 -189
  163. package/data/script-api/dw.catalog.ProductOptionModel.md +0 -209
  164. package/data/script-api/dw.catalog.ProductOptionValue.md +0 -132
  165. package/data/script-api/dw.catalog.ProductPriceInfo.md +0 -170
  166. package/data/script-api/dw.catalog.ProductPriceModel.md +0 -988
  167. package/data/script-api/dw.catalog.ProductPriceTable.md +0 -121
  168. package/data/script-api/dw.catalog.ProductSearchHit.md +0 -702
  169. package/data/script-api/dw.catalog.ProductSearchModel.md +0 -1894
  170. package/data/script-api/dw.catalog.ProductSearchRefinementDefinition.md +0 -99
  171. package/data/script-api/dw.catalog.ProductSearchRefinementValue.md +0 -80
  172. package/data/script-api/dw.catalog.ProductSearchRefinements.md +0 -265
  173. package/data/script-api/dw.catalog.ProductVariationAttribute.md +0 -107
  174. package/data/script-api/dw.catalog.ProductVariationAttributeValue.md +0 -215
  175. package/data/script-api/dw.catalog.ProductVariationModel.md +0 -1010
  176. package/data/script-api/dw.catalog.Recommendation.md +0 -327
  177. package/data/script-api/dw.catalog.SearchModel.md +0 -769
  178. package/data/script-api/dw.catalog.SearchRefinementDefinition.md +0 -145
  179. package/data/script-api/dw.catalog.SearchRefinementValue.md +0 -194
  180. package/data/script-api/dw.catalog.SearchRefinements.md +0 -238
  181. package/data/script-api/dw.catalog.SortingOption.md +0 -120
  182. package/data/script-api/dw.catalog.SortingRule.md +0 -53
  183. package/data/script-api/dw.catalog.Store.md +0 -484
  184. package/data/script-api/dw.catalog.StoreGroup.md +0 -95
  185. package/data/script-api/dw.catalog.StoreInventoryFilter.md +0 -112
  186. package/data/script-api/dw.catalog.StoreInventoryFilterValue.md +0 -111
  187. package/data/script-api/dw.catalog.StoreMgr.md +0 -223
  188. package/data/script-api/dw.catalog.Variant.md +0 -1000
  189. package/data/script-api/dw.catalog.VariationGroup.md +0 -869
  190. package/data/script-api/dw.catalog.md +0 -50
  191. package/data/script-api/dw.content.Content.md +0 -481
  192. package/data/script-api/dw.content.ContentMgr.md +0 -147
  193. package/data/script-api/dw.content.ContentSearchModel.md +0 -618
  194. package/data/script-api/dw.content.ContentSearchRefinementDefinition.md +0 -61
  195. package/data/script-api/dw.content.ContentSearchRefinementValue.md +0 -22
  196. package/data/script-api/dw.content.ContentSearchRefinements.md +0 -218
  197. package/data/script-api/dw.content.Folder.md +0 -432
  198. package/data/script-api/dw.content.Library.md +0 -124
  199. package/data/script-api/dw.content.MarkupText.md +0 -150
  200. package/data/script-api/dw.content.MediaFile.md +0 -367
  201. package/data/script-api/dw.content.md +0 -15
  202. package/data/script-api/dw.crypto.CertificateRef.md +0 -59
  203. package/data/script-api/dw.crypto.CertificateUtils.md +0 -162
  204. package/data/script-api/dw.crypto.Cipher.md +0 -1234
  205. package/data/script-api/dw.crypto.Encoding.md +0 -193
  206. package/data/script-api/dw.crypto.JWE.md +0 -245
  207. package/data/script-api/dw.crypto.JWEHeader.md +0 -147
  208. package/data/script-api/dw.crypto.JWS.md +0 -260
  209. package/data/script-api/dw.crypto.JWSHeader.md +0 -128
  210. package/data/script-api/dw.crypto.KeyRef.md +0 -77
  211. package/data/script-api/dw.crypto.Mac.md +0 -191
  212. package/data/script-api/dw.crypto.MessageDigest.md +0 -243
  213. package/data/script-api/dw.crypto.SecureRandom.md +0 -161
  214. package/data/script-api/dw.crypto.Signature.md +0 -241
  215. package/data/script-api/dw.crypto.WeakCipher.md +0 -725
  216. package/data/script-api/dw.crypto.WeakMac.md +0 -163
  217. package/data/script-api/dw.crypto.WeakMessageDigest.md +0 -220
  218. package/data/script-api/dw.crypto.WeakSignature.md +0 -208
  219. package/data/script-api/dw.crypto.X509Certificate.md +0 -180
  220. package/data/script-api/dw.crypto.md +0 -23
  221. package/data/script-api/dw.customer.AddressBook.md +0 -158
  222. package/data/script-api/dw.customer.AgentUserMgr.md +0 -94
  223. package/data/script-api/dw.customer.AgentUserStatusCodes.md +0 -164
  224. package/data/script-api/dw.customer.AuthenticationStatus.md +0 -157
  225. package/data/script-api/dw.customer.Credentials.md +0 -524
  226. package/data/script-api/dw.customer.Customer.md +0 -488
  227. package/data/script-api/dw.customer.CustomerActiveData.md +0 -563
  228. package/data/script-api/dw.customer.CustomerAddress.md +0 -666
  229. package/data/script-api/dw.customer.CustomerCDPData.md +0 -70
  230. package/data/script-api/dw.customer.CustomerContextMgr.md +0 -62
  231. package/data/script-api/dw.customer.CustomerGroup.md +0 -146
  232. package/data/script-api/dw.customer.CustomerList.md +0 -76
  233. package/data/script-api/dw.customer.CustomerMgr.md +0 -1046
  234. package/data/script-api/dw.customer.CustomerPasswordConstraints.md +0 -125
  235. package/data/script-api/dw.customer.CustomerPaymentInstrument.md +0 -161
  236. package/data/script-api/dw.customer.CustomerStatusCodes.md +0 -55
  237. package/data/script-api/dw.customer.EncryptedObject.md +0 -34
  238. package/data/script-api/dw.customer.ExternalProfile.md +0 -154
  239. package/data/script-api/dw.customer.OrderHistory.md +0 -167
  240. package/data/script-api/dw.customer.ProductList.md +0 -870
  241. package/data/script-api/dw.customer.ProductListItem.md +0 -469
  242. package/data/script-api/dw.customer.ProductListItemPurchase.md +0 -139
  243. package/data/script-api/dw.customer.ProductListMgr.md +0 -350
  244. package/data/script-api/dw.customer.ProductListRegistrant.md +0 -165
  245. package/data/script-api/dw.customer.Profile.md +0 -940
  246. package/data/script-api/dw.customer.Wallet.md +0 -136
  247. package/data/script-api/dw.customer.consent.ConsentStatusEntry.md +0 -92
  248. package/data/script-api/dw.customer.consent.MarketingConsentSubscription.md +0 -247
  249. package/data/script-api/dw.customer.consent.ShopperConsentErrorCodes.md +0 -74
  250. package/data/script-api/dw.customer.consent.ShopperConsentException.md +0 -63
  251. package/data/script-api/dw.customer.consent.ShopperConsentMgr.md +0 -152
  252. package/data/script-api/dw.customer.consent.md +0 -10
  253. package/data/script-api/dw.customer.md +0 -31
  254. package/data/script-api/dw.customer.oauth.OAuthAccessTokenResponse.md +0 -171
  255. package/data/script-api/dw.customer.oauth.OAuthFinalizedResponse.md +0 -75
  256. package/data/script-api/dw.customer.oauth.OAuthLoginFlowMgr.md +0 -165
  257. package/data/script-api/dw.customer.oauth.OAuthUserInfoResponse.md +0 -84
  258. package/data/script-api/dw.customer.oauth.md +0 -9
  259. package/data/script-api/dw.customer.shoppercontext.ShopperContext.md +0 -369
  260. package/data/script-api/dw.customer.shoppercontext.ShopperContextErrorCodes.md +0 -111
  261. package/data/script-api/dw.customer.shoppercontext.ShopperContextException.md +0 -77
  262. package/data/script-api/dw.customer.shoppercontext.ShopperContextMgr.md +0 -209
  263. package/data/script-api/dw.customer.shoppercontext.md +0 -9
  264. package/data/script-api/dw.experience.AspectAttributeValidationException.md +0 -25
  265. package/data/script-api/dw.experience.Component.md +0 -166
  266. package/data/script-api/dw.experience.ComponentRenderSettings.md +0 -130
  267. package/data/script-api/dw.experience.ComponentScriptContext.md +0 -148
  268. package/data/script-api/dw.experience.CustomEditor.md +0 -146
  269. package/data/script-api/dw.experience.CustomEditorResources.md +0 -100
  270. package/data/script-api/dw.experience.Page.md +0 -467
  271. package/data/script-api/dw.experience.PageMgr.md +0 -549
  272. package/data/script-api/dw.experience.PageScriptContext.md +0 -200
  273. package/data/script-api/dw.experience.Region.md +0 -119
  274. package/data/script-api/dw.experience.RegionRenderSettings.md +0 -207
  275. package/data/script-api/dw.experience.cms.CMSRecord.md +0 -125
  276. package/data/script-api/dw.experience.cms.md +0 -6
  277. package/data/script-api/dw.experience.image.FocalPoint.md +0 -71
  278. package/data/script-api/dw.experience.image.Image.md +0 -101
  279. package/data/script-api/dw.experience.image.ImageMetaData.md +0 -71
  280. package/data/script-api/dw.experience.image.md +0 -8
  281. package/data/script-api/dw.experience.md +0 -16
  282. package/data/script-api/dw.extensions.applepay.ApplePayHookResult.md +0 -254
  283. package/data/script-api/dw.extensions.applepay.ApplePayHooks.md +0 -572
  284. package/data/script-api/dw.extensions.applepay.md +0 -7
  285. package/data/script-api/dw.extensions.facebook.FacebookFeedHooks.md +0 -102
  286. package/data/script-api/dw.extensions.facebook.FacebookProduct.md +0 -1343
  287. package/data/script-api/dw.extensions.facebook.md +0 -7
  288. package/data/script-api/dw.extensions.paymentapi.PaymentApiHooks.md +0 -136
  289. package/data/script-api/dw.extensions.paymentapi.md +0 -6
  290. package/data/script-api/dw.extensions.paymentrequest.PaymentRequestHookResult.md +0 -149
  291. package/data/script-api/dw.extensions.paymentrequest.PaymentRequestHooks.md +0 -356
  292. package/data/script-api/dw.extensions.paymentrequest.md +0 -7
  293. package/data/script-api/dw.extensions.payments.SalesforceAdyenPaymentIntent.md +0 -134
  294. package/data/script-api/dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.md +0 -283
  295. package/data/script-api/dw.extensions.payments.SalesforceBancontactPaymentDetails.md +0 -88
  296. package/data/script-api/dw.extensions.payments.SalesforceCardPaymentDetails.md +0 -107
  297. package/data/script-api/dw.extensions.payments.SalesforceEpsPaymentDetails.md +0 -63
  298. package/data/script-api/dw.extensions.payments.SalesforceIdealPaymentDetails.md +0 -63
  299. package/data/script-api/dw.extensions.payments.SalesforceKlarnaPaymentDetails.md +0 -63
  300. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrder.md +0 -263
  301. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrderAddress.md +0 -171
  302. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrderPayer.md +0 -110
  303. package/data/script-api/dw.extensions.payments.SalesforcePayPalPaymentDetails.md +0 -88
  304. package/data/script-api/dw.extensions.payments.SalesforcePaymentDetails.md +0 -83
  305. package/data/script-api/dw.extensions.payments.SalesforcePaymentIntent.md +0 -273
  306. package/data/script-api/dw.extensions.payments.SalesforcePaymentMethod.md +0 -368
  307. package/data/script-api/dw.extensions.payments.SalesforcePaymentRequest.md +0 -1077
  308. package/data/script-api/dw.extensions.payments.SalesforcePaymentsHooks.md +0 -190
  309. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccount.md +0 -151
  310. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.md +0 -98
  311. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMgr.md +0 -989
  312. package/data/script-api/dw.extensions.payments.SalesforcePaymentsSiteConfiguration.md +0 -202
  313. package/data/script-api/dw.extensions.payments.SalesforcePaymentsZone.md +0 -393
  314. package/data/script-api/dw.extensions.payments.SalesforceSepaDebitPaymentDetails.md +0 -63
  315. package/data/script-api/dw.extensions.payments.SalesforceVenmoPaymentDetails.md +0 -88
  316. package/data/script-api/dw.extensions.payments.md +0 -28
  317. package/data/script-api/dw.extensions.pinterest.PinterestAvailability.md +0 -85
  318. package/data/script-api/dw.extensions.pinterest.PinterestFeedHooks.md +0 -118
  319. package/data/script-api/dw.extensions.pinterest.PinterestOrder.md +0 -263
  320. package/data/script-api/dw.extensions.pinterest.PinterestOrderHooks.md +0 -89
  321. package/data/script-api/dw.extensions.pinterest.PinterestProduct.md +0 -677
  322. package/data/script-api/dw.extensions.pinterest.md +0 -10
  323. package/data/script-api/dw.io.CSVStreamReader.md +0 -128
  324. package/data/script-api/dw.io.CSVStreamWriter.md +0 -92
  325. package/data/script-api/dw.io.File.md +0 -729
  326. package/data/script-api/dw.io.FileReader.md +0 -70
  327. package/data/script-api/dw.io.FileWriter.md +0 -159
  328. package/data/script-api/dw.io.InputStream.md +0 -35
  329. package/data/script-api/dw.io.OutputStream.md +0 -38
  330. package/data/script-api/dw.io.PrintWriter.md +0 -66
  331. package/data/script-api/dw.io.RandomAccessFileReader.md +0 -183
  332. package/data/script-api/dw.io.Reader.md +0 -284
  333. package/data/script-api/dw.io.StringWriter.md +0 -89
  334. package/data/script-api/dw.io.Writer.md +0 -96
  335. package/data/script-api/dw.io.XMLIndentingStreamWriter.md +0 -121
  336. package/data/script-api/dw.io.XMLStreamConstants.md +0 -172
  337. package/data/script-api/dw.io.XMLStreamReader.md +0 -1181
  338. package/data/script-api/dw.io.XMLStreamWriter.md +0 -478
  339. package/data/script-api/dw.io.md +0 -21
  340. package/data/script-api/dw.job.JobExecution.md +0 -111
  341. package/data/script-api/dw.job.JobStepExecution.md +0 -136
  342. package/data/script-api/dw.job.md +0 -7
  343. package/data/script-api/dw.net.FTPClient.md +0 -621
  344. package/data/script-api/dw.net.FTPFileInfo.md +0 -132
  345. package/data/script-api/dw.net.HTTPClient.md +0 -775
  346. package/data/script-api/dw.net.HTTPClientLoggingConfig.md +0 -363
  347. package/data/script-api/dw.net.HTTPRequestPart.md +0 -296
  348. package/data/script-api/dw.net.Mail.md +0 -487
  349. package/data/script-api/dw.net.SFTPClient.md +0 -535
  350. package/data/script-api/dw.net.SFTPFileInfo.md +0 -128
  351. package/data/script-api/dw.net.WebDAVClient.md +0 -762
  352. package/data/script-api/dw.net.WebDAVFileInfo.md +0 -163
  353. package/data/script-api/dw.net.md +0 -15
  354. package/data/script-api/dw.object.ActiveData.md +0 -86
  355. package/data/script-api/dw.object.CustomAttributes.md +0 -165
  356. package/data/script-api/dw.object.CustomObject.md +0 -82
  357. package/data/script-api/dw.object.CustomObjectMgr.md +0 -478
  358. package/data/script-api/dw.object.Extensible.md +0 -71
  359. package/data/script-api/dw.object.ExtensibleObject.md +0 -85
  360. package/data/script-api/dw.object.Note.md +0 -118
  361. package/data/script-api/dw.object.ObjectAttributeDefinition.md +0 -542
  362. package/data/script-api/dw.object.ObjectAttributeGroup.md +0 -160
  363. package/data/script-api/dw.object.ObjectAttributeValueDefinition.md +0 -78
  364. package/data/script-api/dw.object.ObjectTypeDefinition.md +0 -239
  365. package/data/script-api/dw.object.PersistentObject.md +0 -92
  366. package/data/script-api/dw.object.SimpleExtensible.md +0 -53
  367. package/data/script-api/dw.object.SystemObjectMgr.md +0 -520
  368. package/data/script-api/dw.object.md +0 -19
  369. package/data/script-api/dw.order.AbstractItem.md +0 -220
  370. package/data/script-api/dw.order.AbstractItemCtnr.md +0 -219
  371. package/data/script-api/dw.order.Appeasement.md +0 -398
  372. package/data/script-api/dw.order.AppeasementItem.md +0 -104
  373. package/data/script-api/dw.order.Basket.md +0 -868
  374. package/data/script-api/dw.order.BasketMgr.md +0 -673
  375. package/data/script-api/dw.order.BonusDiscountLineItem.md +0 -309
  376. package/data/script-api/dw.order.CouponLineItem.md +0 -289
  377. package/data/script-api/dw.order.CreateAgentBasketLimitExceededException.md +0 -35
  378. package/data/script-api/dw.order.CreateBasketFromOrderException.md +0 -54
  379. package/data/script-api/dw.order.CreateCouponLineItemException.md +0 -67
  380. package/data/script-api/dw.order.CreateOrderException.md +0 -23
  381. package/data/script-api/dw.order.CreateTemporaryBasketLimitExceededException.md +0 -35
  382. package/data/script-api/dw.order.GiftCertificate.md +0 -530
  383. package/data/script-api/dw.order.GiftCertificateLineItem.md +0 -292
  384. package/data/script-api/dw.order.GiftCertificateMgr.md +0 -228
  385. package/data/script-api/dw.order.GiftCertificateStatusCodes.md +0 -108
  386. package/data/script-api/dw.order.Invoice.md +0 -571
  387. package/data/script-api/dw.order.InvoiceItem.md +0 -199
  388. package/data/script-api/dw.order.LineItem.md +0 -577
  389. package/data/script-api/dw.order.LineItemCtnr.md +0 -2429
  390. package/data/script-api/dw.order.LineItemTax.md +0 -142
  391. package/data/script-api/dw.order.Order.md +0 -2770
  392. package/data/script-api/dw.order.OrderAddress.md +0 -624
  393. package/data/script-api/dw.order.OrderItem.md +0 -613
  394. package/data/script-api/dw.order.OrderMgr.md +0 -1502
  395. package/data/script-api/dw.order.OrderPaymentInstrument.md +0 -231
  396. package/data/script-api/dw.order.OrderProcessStatusCodes.md +0 -146
  397. package/data/script-api/dw.order.PaymentCard.md +0 -220
  398. package/data/script-api/dw.order.PaymentInstrument.md +0 -1416
  399. package/data/script-api/dw.order.PaymentMethod.md +0 -257
  400. package/data/script-api/dw.order.PaymentMgr.md +0 -138
  401. package/data/script-api/dw.order.PaymentProcessor.md +0 -106
  402. package/data/script-api/dw.order.PaymentStatusCodes.md +0 -70
  403. package/data/script-api/dw.order.PaymentTransaction.md +0 -291
  404. package/data/script-api/dw.order.PriceAdjustment.md +0 -745
  405. package/data/script-api/dw.order.PriceAdjustmentLimitTypes.md +0 -61
  406. package/data/script-api/dw.order.ProductLineItem.md +0 -1749
  407. package/data/script-api/dw.order.ProductShippingCost.md +0 -101
  408. package/data/script-api/dw.order.ProductShippingLineItem.md +0 -336
  409. package/data/script-api/dw.order.ProductShippingModel.md +0 -143
  410. package/data/script-api/dw.order.Return.md +0 -396
  411. package/data/script-api/dw.order.ReturnCase.md +0 -463
  412. package/data/script-api/dw.order.ReturnCaseItem.md +0 -372
  413. package/data/script-api/dw.order.ReturnItem.md +0 -335
  414. package/data/script-api/dw.order.Shipment.md +0 -1132
  415. package/data/script-api/dw.order.ShipmentShippingCost.md +0 -54
  416. package/data/script-api/dw.order.ShipmentShippingModel.md +0 -203
  417. package/data/script-api/dw.order.ShippingLineItem.md +0 -315
  418. package/data/script-api/dw.order.ShippingLocation.md +0 -313
  419. package/data/script-api/dw.order.ShippingMethod.md +0 -251
  420. package/data/script-api/dw.order.ShippingMgr.md +0 -173
  421. package/data/script-api/dw.order.ShippingOrder.md +0 -630
  422. package/data/script-api/dw.order.ShippingOrderItem.md +0 -425
  423. package/data/script-api/dw.order.SumItem.md +0 -158
  424. package/data/script-api/dw.order.TaxGroup.md +0 -128
  425. package/data/script-api/dw.order.TaxItem.md +0 -74
  426. package/data/script-api/dw.order.TaxMgr.md +0 -314
  427. package/data/script-api/dw.order.TrackingInfo.md +0 -261
  428. package/data/script-api/dw.order.TrackingRef.md +0 -108
  429. package/data/script-api/dw.order.hooks.BasketMergeHooks.md +0 -87
  430. package/data/script-api/dw.order.hooks.CalculateHooks.md +0 -139
  431. package/data/script-api/dw.order.hooks.CheckoutHooks.md +0 -88
  432. package/data/script-api/dw.order.hooks.OrderHooks.md +0 -96
  433. package/data/script-api/dw.order.hooks.PaymentHooks.md +0 -325
  434. package/data/script-api/dw.order.hooks.ReturnHooks.md +0 -395
  435. package/data/script-api/dw.order.hooks.ShippingOrderHooks.md +0 -426
  436. package/data/script-api/dw.order.hooks.TaxHooks.md +0 -495
  437. package/data/script-api/dw.order.hooks.md +0 -13
  438. package/data/script-api/dw.order.md +0 -65
  439. package/data/script-api/dw.rpc.SOAPUtil.md +0 -736
  440. package/data/script-api/dw.rpc.Stub.md +0 -373
  441. package/data/script-api/dw.rpc.WebReference.md +0 -133
  442. package/data/script-api/dw.rpc.md +0 -8
  443. package/data/script-api/dw.sitemap.SitemapFile.md +0 -137
  444. package/data/script-api/dw.sitemap.SitemapMgr.md +0 -165
  445. package/data/script-api/dw.sitemap.md +0 -7
  446. package/data/script-api/dw.suggest.BrandSuggestions.md +0 -34
  447. package/data/script-api/dw.suggest.CategorySuggestions.md +0 -76
  448. package/data/script-api/dw.suggest.ContentSuggestions.md +0 -76
  449. package/data/script-api/dw.suggest.CustomSuggestions.md +0 -34
  450. package/data/script-api/dw.suggest.ProductSuggestions.md +0 -76
  451. package/data/script-api/dw.suggest.SearchPhraseSuggestions.md +0 -126
  452. package/data/script-api/dw.suggest.SuggestModel.md +0 -471
  453. package/data/script-api/dw.suggest.SuggestedCategory.md +0 -51
  454. package/data/script-api/dw.suggest.SuggestedContent.md +0 -51
  455. package/data/script-api/dw.suggest.SuggestedPhrase.md +0 -70
  456. package/data/script-api/dw.suggest.SuggestedProduct.md +0 -55
  457. package/data/script-api/dw.suggest.SuggestedTerm.md +0 -143
  458. package/data/script-api/dw.suggest.SuggestedTerms.md +0 -144
  459. package/data/script-api/dw.suggest.Suggestions.md +0 -206
  460. package/data/script-api/dw.suggest.md +0 -19
  461. package/data/script-api/dw.svc.FTPService.md +0 -140
  462. package/data/script-api/dw.svc.FTPServiceDefinition.md +0 -97
  463. package/data/script-api/dw.svc.HTTPFormService.md +0 -32
  464. package/data/script-api/dw.svc.HTTPFormServiceDefinition.md +0 -36
  465. package/data/script-api/dw.svc.HTTPService.md +0 -370
  466. package/data/script-api/dw.svc.HTTPServiceDefinition.md +0 -290
  467. package/data/script-api/dw.svc.LocalServiceRegistry.md +0 -63
  468. package/data/script-api/dw.svc.Result.md +0 -320
  469. package/data/script-api/dw.svc.SOAPService.md +0 -104
  470. package/data/script-api/dw.svc.SOAPServiceDefinition.md +0 -32
  471. package/data/script-api/dw.svc.Service.md +0 -276
  472. package/data/script-api/dw.svc.ServiceCallback.md +0 -282
  473. package/data/script-api/dw.svc.ServiceConfig.md +0 -114
  474. package/data/script-api/dw.svc.ServiceCredential.md +0 -162
  475. package/data/script-api/dw.svc.ServiceDefinition.md +0 -211
  476. package/data/script-api/dw.svc.ServiceProfile.md +0 -152
  477. package/data/script-api/dw.svc.ServiceRegistry.md +0 -118
  478. package/data/script-api/dw.svc.md +0 -22
  479. package/data/script-api/dw.system.AgentUserStatusCodes.md +0 -41
  480. package/data/script-api/dw.system.Cache.md +0 -126
  481. package/data/script-api/dw.system.CacheMgr.md +0 -70
  482. package/data/script-api/dw.system.HookMgr.md +0 -78
  483. package/data/script-api/dw.system.InternalObject.md +0 -47
  484. package/data/script-api/dw.system.JobProcessMonitor.md +0 -103
  485. package/data/script-api/dw.system.Log.md +0 -198
  486. package/data/script-api/dw.system.LogNDC.md +0 -75
  487. package/data/script-api/dw.system.Logger.md +0 -216
  488. package/data/script-api/dw.system.OrganizationPreferences.md +0 -53
  489. package/data/script-api/dw.system.Pipeline.md +0 -94
  490. package/data/script-api/dw.system.PipelineDictionary.md +0 -42
  491. package/data/script-api/dw.system.RESTErrorResponse.md +0 -102
  492. package/data/script-api/dw.system.RESTResponseMgr.md +0 -243
  493. package/data/script-api/dw.system.RESTSuccessResponse.md +0 -62
  494. package/data/script-api/dw.system.RemoteInclude.md +0 -146
  495. package/data/script-api/dw.system.Request.md +0 -785
  496. package/data/script-api/dw.system.RequestHooks.md +0 -112
  497. package/data/script-api/dw.system.Response.md +0 -612
  498. package/data/script-api/dw.system.SearchStatus.md +0 -187
  499. package/data/script-api/dw.system.Session.md +0 -469
  500. package/data/script-api/dw.system.Site.md +0 -570
  501. package/data/script-api/dw.system.SitePreferences.md +0 -90
  502. package/data/script-api/dw.system.Status.md +0 -330
  503. package/data/script-api/dw.system.StatusItem.md +0 -273
  504. package/data/script-api/dw.system.System.md +0 -224
  505. package/data/script-api/dw.system.Transaction.md +0 -107
  506. package/data/script-api/dw.system.md +0 -32
  507. package/data/script-api/dw.template.ISML.md +0 -127
  508. package/data/script-api/dw.template.Velocity.md +0 -168
  509. package/data/script-api/dw.template.md +0 -7
  510. package/data/script-api/dw.util.ArrayList.md +0 -99
  511. package/data/script-api/dw.util.Assert.md +0 -370
  512. package/data/script-api/dw.util.BigInteger.md +0 -283
  513. package/data/script-api/dw.util.Bytes.md +0 -278
  514. package/data/script-api/dw.util.Calendar.md +0 -1051
  515. package/data/script-api/dw.util.Collection.md +0 -272
  516. package/data/script-api/dw.util.Currency.md +0 -147
  517. package/data/script-api/dw.util.DateUtils.md +0 -82
  518. package/data/script-api/dw.util.Decimal.md +0 -386
  519. package/data/script-api/dw.util.FilteringCollection.md +0 -140
  520. package/data/script-api/dw.util.Geolocation.md +0 -293
  521. package/data/script-api/dw.util.HashMap.md +0 -50
  522. package/data/script-api/dw.util.HashSet.md +0 -65
  523. package/data/script-api/dw.util.Iterator.md +0 -86
  524. package/data/script-api/dw.util.LinkedHashMap.md +0 -52
  525. package/data/script-api/dw.util.LinkedHashSet.md +0 -68
  526. package/data/script-api/dw.util.List.md +0 -429
  527. package/data/script-api/dw.util.Locale.md +0 -277
  528. package/data/script-api/dw.util.Map.md +0 -251
  529. package/data/script-api/dw.util.MapEntry.md +0 -68
  530. package/data/script-api/dw.util.MappingKey.md +0 -96
  531. package/data/script-api/dw.util.MappingMgr.md +0 -113
  532. package/data/script-api/dw.util.PropertyComparator.md +0 -122
  533. package/data/script-api/dw.util.SecureEncoder.md +0 -582
  534. package/data/script-api/dw.util.SecureFilter.md +0 -572
  535. package/data/script-api/dw.util.SeekableIterator.md +0 -187
  536. package/data/script-api/dw.util.Set.md +0 -39
  537. package/data/script-api/dw.util.SortedMap.md +0 -148
  538. package/data/script-api/dw.util.SortedSet.md +0 -173
  539. package/data/script-api/dw.util.StringUtils.md +0 -655
  540. package/data/script-api/dw.util.Template.md +0 -141
  541. package/data/script-api/dw.util.UUIDUtils.md +0 -34
  542. package/data/script-api/dw.util.md +0 -37
  543. package/data/script-api/dw.value.EnumValue.md +0 -105
  544. package/data/script-api/dw.value.MimeEncodedText.md +0 -131
  545. package/data/script-api/dw.value.Money.md +0 -526
  546. package/data/script-api/dw.value.Quantity.md +0 -299
  547. package/data/script-api/dw.value.md +0 -9
  548. package/data/script-api/dw.web.CSRFProtection.md +0 -105
  549. package/data/script-api/dw.web.ClickStream.md +0 -177
  550. package/data/script-api/dw.web.ClickStreamEntry.md +0 -255
  551. package/data/script-api/dw.web.Cookie.md +0 -431
  552. package/data/script-api/dw.web.Cookies.md +0 -59
  553. package/data/script-api/dw.web.Form.md +0 -84
  554. package/data/script-api/dw.web.FormAction.md +0 -195
  555. package/data/script-api/dw.web.FormElement.md +0 -211
  556. package/data/script-api/dw.web.FormElementValidationResult.md +0 -170
  557. package/data/script-api/dw.web.FormField.md +0 -642
  558. package/data/script-api/dw.web.FormFieldOption.md +0 -211
  559. package/data/script-api/dw.web.FormFieldOptions.md +0 -49
  560. package/data/script-api/dw.web.FormGroup.md +0 -222
  561. package/data/script-api/dw.web.FormList.md +0 -134
  562. package/data/script-api/dw.web.FormListItem.md +0 -57
  563. package/data/script-api/dw.web.Forms.md +0 -25
  564. package/data/script-api/dw.web.HttpParameter.md +0 -462
  565. package/data/script-api/dw.web.HttpParameterMap.md +0 -194
  566. package/data/script-api/dw.web.LoopIterator.md +0 -231
  567. package/data/script-api/dw.web.PageMetaData.md +0 -197
  568. package/data/script-api/dw.web.PageMetaTag.md +0 -173
  569. package/data/script-api/dw.web.PagingModel.md +0 -407
  570. package/data/script-api/dw.web.Resource.md +0 -147
  571. package/data/script-api/dw.web.URL.md +0 -174
  572. package/data/script-api/dw.web.URLAction.md +0 -95
  573. package/data/script-api/dw.web.URLParameter.md +0 -52
  574. package/data/script-api/dw.web.URLRedirect.md +0 -72
  575. package/data/script-api/dw.web.URLRedirectMgr.md +0 -86
  576. package/data/script-api/dw.web.URLUtils.md +0 -1357
  577. package/data/script-api/dw.web.md +0 -34
  578. package/data/script-api/dw.ws.Port.md +0 -126
  579. package/data/script-api/dw.ws.WSUtil.md +0 -728
  580. package/data/script-api/dw.ws.WebReference2.md +0 -137
  581. package/data/script-api/dw.ws.md +0 -8
  582. package/data/script-api/index.md +0 -40
@@ -1,97 +0,0 @@
1
- <!-- prettier-ignore-start -->
2
- # Class ArrayBuffer
3
-
4
- - [TopLevel.Object](TopLevel.Object.md)
5
- - [TopLevel.ArrayBuffer](TopLevel.ArrayBuffer.md)
6
-
7
- The ArrayBuffer represents a generic array of bytes with fixed length.
8
-
9
- To access and manipulate content, use [DataView](TopLevel.DataView.md) or a typed array.
10
-
11
-
12
- **API Version:**
13
- :::note
14
- Available from version 21.2.
15
- :::
16
-
17
- ## Property Summary
18
-
19
- | Property | Description |
20
- | --- | --- |
21
- | [byteLength](#bytelength): [Number](TopLevel.Number.md) | The number of bytes in the array buffer. |
22
-
23
- ## Constructor Summary
24
-
25
- | Constructor | Description |
26
- | --- | --- |
27
- | [ArrayBuffer](#arraybuffer)() | Creates an empty array buffer. |
28
- | [ArrayBuffer](#arraybuffernumber)([Number](TopLevel.Number.md)) | Creates an array buffer with the given number of bytes. |
29
-
30
- ## Method Summary
31
-
32
- | Method | Description |
33
- | --- | --- |
34
- | static [isView](TopLevel.ArrayBuffer.md#isviewobject)([Object](TopLevel.Object.md)) | Returns if the given object is one of the views for an ArrayBuffer, such as a typed array or a [DataView](TopLevel.DataView.md). |
35
- | [slice](TopLevel.ArrayBuffer.md#slicenumber-number)([Number](TopLevel.Number.md), [Number](TopLevel.Number.md)) | Returns a new array buffer with a copy of the data of this buffer. |
36
-
37
- ### Methods inherited from class Object
38
-
39
- [assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
40
- ## Property Details
41
-
42
- ### byteLength
43
- - byteLength: [Number](TopLevel.Number.md)
44
- - : The number of bytes in the array buffer.
45
-
46
-
47
- ---
48
-
49
- ## Constructor Details
50
-
51
- ### ArrayBuffer()
52
- - ArrayBuffer()
53
- - : Creates an empty array buffer.
54
-
55
-
56
- ---
57
-
58
- ### ArrayBuffer(Number)
59
- - ArrayBuffer(byteLength: [Number](TopLevel.Number.md))
60
- - : Creates an array buffer with the given number of bytes.
61
-
62
- **Parameters:**
63
- - byteLength - The number of bytes.
64
-
65
-
66
- ---
67
-
68
- ## Method Details
69
-
70
- ### isView(Object)
71
- - static isView(object: [Object](TopLevel.Object.md)): [Boolean](TopLevel.Boolean.md)
72
- - : Returns if the given object is one of the views for an ArrayBuffer, such as a typed array or a [DataView](TopLevel.DataView.md).
73
-
74
- **Parameters:**
75
- - object - The object to check.
76
-
77
- **Returns:**
78
- - `true` if the passed object is a view to an array buffer else return false.
79
-
80
-
81
- ---
82
-
83
- ### slice(Number, Number)
84
- - slice(begin: [Number](TopLevel.Number.md), end: [Number](TopLevel.Number.md)): [ArrayBuffer](TopLevel.ArrayBuffer.md)
85
- - : Returns a new array buffer with a copy of the data of this buffer.
86
-
87
- **Parameters:**
88
- - begin - Optional. The first included element.
89
- - end - Optional. The index of the end. This element is not included.
90
-
91
- **Returns:**
92
- - The new array object.
93
-
94
-
95
- ---
96
-
97
- <!-- prettier-ignore-end -->
@@ -1,154 +0,0 @@
1
- <!-- prettier-ignore-start -->
2
- # Class BigInt
3
-
4
- - [TopLevel.Object](TopLevel.Object.md)
5
- - [TopLevel.BigInt](TopLevel.BigInt.md)
6
-
7
- A BigInt object is a wrapper for a primitive `bigint` value.
8
- `bigint` values can be numbers too large to be stored as `number` values.
9
-
10
-
11
- A `bigint` literal in code is an integer number with an appended `n`.
12
-
13
-
14
- Example:
15
-
16
- ```
17
- var hugeNumber = 1245678901234567890n;
18
- var hugeNumberObject = BigInt( hugeNumber );
19
- ```
20
-
21
-
22
- **API Version:**
23
- :::note
24
- Available from version 22.7.
25
- :::
26
-
27
- ## Constructor Summary
28
-
29
- | Constructor | Description |
30
- | --- | --- |
31
- | [BigInt](#bigint)() | Constructs a BigInt with value 0. |
32
- | [BigInt](#bigintbigint)([BigInt](TopLevel.BigInt.md)) | Constructs a new BigInt using the specified BigInt. |
33
- | [BigInt](#bigintstring)([String](TopLevel.String.md)) | Constructs a BigInt using the specified value. |
34
-
35
- ## Method Summary
36
-
37
- | Method | Description |
38
- | --- | --- |
39
- | static [asIntN](TopLevel.BigInt.md#asintnnumber-bigint)([Number](TopLevel.Number.md), [BigInt](TopLevel.BigInt.md)) | Clamps the given BigInt value to a signed integer with a given precision. |
40
- | static [asUintN](TopLevel.BigInt.md#asuintnnumber-bigint)([Number](TopLevel.Number.md), [BigInt](TopLevel.BigInt.md)) | Clamps the given BigInt value to an unsigned integer with a given precision. |
41
- | [toLocaleString](TopLevel.BigInt.md#tolocalestring)() | Converts this BigInt to a String using local number formatting conventions. |
42
- | [toString](TopLevel.BigInt.md#tostring)() | A String representation of this BigInt. |
43
- | [toString](TopLevel.BigInt.md#tostringnumber)([Number](TopLevel.Number.md)) | Converts the BigInt into a string using the specified radix (base). |
44
-
45
- ### Methods inherited from class Object
46
-
47
- [assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
48
- ## Constructor Details
49
-
50
- ### BigInt()
51
- - BigInt()
52
- - : Constructs a BigInt with value 0.
53
-
54
-
55
- ---
56
-
57
- ### BigInt(BigInt)
58
- - BigInt(value: [BigInt](TopLevel.BigInt.md))
59
- - : Constructs a new BigInt using the specified BigInt.
60
-
61
- **Parameters:**
62
- - value - the BigInt to use.
63
-
64
-
65
- ---
66
-
67
- ### BigInt(String)
68
- - BigInt(value: [String](TopLevel.String.md))
69
- - : Constructs a BigInt using the specified value.
70
-
71
-
72
- Beside decimal numbers also binary, octal and hexadecimal numbers are supported:
73
-
74
- ```
75
- var decimal = BigInt( "12" );
76
- var binary = BigInt( "0b1100" );
77
- var octal = BigInt( "0o14" );
78
- var hex = BigInt( "0xC" );
79
- ```
80
-
81
-
82
- **Parameters:**
83
- - value - the value to use when creating the BigInt.
84
-
85
-
86
- ---
87
-
88
- ## Method Details
89
-
90
- ### asIntN(Number, BigInt)
91
- - static asIntN(bits: [Number](TopLevel.Number.md), value: [BigInt](TopLevel.BigInt.md)): [BigInt](TopLevel.BigInt.md)
92
- - : Clamps the given BigInt value to a signed integer with a given precision.
93
-
94
- **Parameters:**
95
- - bits - Number of bits required for resulting integer.
96
- - value - The value to be clamped to the given number of bits.
97
-
98
- **Returns:**
99
- - The `value` modulo 2`bits`, as a signed integer.
100
-
101
-
102
- ---
103
-
104
- ### asUintN(Number, BigInt)
105
- - static asUintN(bits: [Number](TopLevel.Number.md), value: [BigInt](TopLevel.BigInt.md)): [BigInt](TopLevel.BigInt.md)
106
- - : Clamps the given BigInt value to an unsigned integer with a given precision.
107
-
108
- **Parameters:**
109
- - bits - Number of bits required for resulting integer.
110
- - value - The value to be clamped to the given number of bits.
111
-
112
- **Returns:**
113
- - The `value` modulo 2`bits`, as an unsigned integer.
114
-
115
-
116
- ---
117
-
118
- ### toLocaleString()
119
- - toLocaleString(): [String](TopLevel.String.md)
120
- - : Converts this BigInt to a String using local number formatting conventions.
121
-
122
- The current implementation actually only returns the same as [toString()](TopLevel.BigInt.md#tostring).
123
-
124
-
125
- **Returns:**
126
- - a String using local number formatting conventions.
127
-
128
-
129
- ---
130
-
131
- ### toString()
132
- - toString(): [String](TopLevel.String.md)
133
- - : A String representation of this BigInt.
134
-
135
- **Returns:**
136
- - a String representation of this BigInt.
137
-
138
-
139
- ---
140
-
141
- ### toString(Number)
142
- - toString(radix: [Number](TopLevel.Number.md)): [String](TopLevel.String.md)
143
- - : Converts the BigInt into a string using the specified radix (base).
144
-
145
- **Parameters:**
146
- - radix - the radix to use.
147
-
148
- **Returns:**
149
- - a String representation of this BigInt.
150
-
151
-
152
- ---
153
-
154
- <!-- prettier-ignore-end -->
@@ -1,83 +0,0 @@
1
- <!-- prettier-ignore-start -->
2
- # Class Boolean
3
-
4
- - [TopLevel.Object](TopLevel.Object.md)
5
- - [TopLevel.Boolean](TopLevel.Boolean.md)
6
-
7
- Provides support for boolean values.
8
-
9
-
10
- ## Constructor Summary
11
-
12
- | Constructor | Description |
13
- | --- | --- |
14
- | [Boolean](#booleanstring)([String](TopLevel.String.md)) | Constructs the Boolean using the specified String value. |
15
- | [Boolean](#booleannumber)([Number](TopLevel.Number.md)) | Constructs the Boolean using the specified Number value. |
16
-
17
- ## Method Summary
18
-
19
- | Method | Description |
20
- | --- | --- |
21
- | [toString](TopLevel.Boolean.md#tostring)() | Returns true or false depending on the value used to create the Boolean. |
22
- | [valueOf](TopLevel.Boolean.md#valueof)() | Returns the primitive boolean contained in the Boolean object. |
23
-
24
- ### Methods inherited from class Object
25
-
26
- [assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
27
- ## Constructor Details
28
-
29
- ### Boolean(String)
30
- - Boolean(value: [String](TopLevel.String.md))
31
- - : Constructs the Boolean using the specified
32
- String value.
33
-
34
-
35
- **Parameters:**
36
- - value - the String value to use to construct the Boolean. If _value_ is null or an empty String, the Boolean is set to false.
37
-
38
-
39
- ---
40
-
41
- ### Boolean(Number)
42
- - Boolean(value: [Number](TopLevel.Number.md))
43
- - : Constructs the Boolean using the specified
44
- Number value.
45
-
46
-
47
- **Parameters:**
48
- - value - the Number value to use to construct the Boolean. If _value_ is null or 0, the Boolean is set to false.
49
-
50
-
51
- ---
52
-
53
- ## Method Details
54
-
55
- ### toString()
56
- - toString(): [String](TopLevel.String.md)
57
- - : Returns true or false depending on the value used to create
58
- the Boolean.
59
-
60
-
61
- **Returns:**
62
- - true or false depending on the value used to create
63
- the Boolean.
64
-
65
-
66
-
67
- ---
68
-
69
- ### valueOf()
70
- - valueOf(): [Object](TopLevel.Object.md)
71
- - : Returns the primitive boolean contained in the Boolean
72
- object.
73
-
74
-
75
- **Returns:**
76
- - the primitive boolean contained in the Boolean
77
- object.
78
-
79
-
80
-
81
- ---
82
-
83
- <!-- prettier-ignore-end -->
@@ -1,51 +0,0 @@
1
- <!-- prettier-ignore-start -->
2
- # Class ConversionError
3
-
4
- - [TopLevel.Object](TopLevel.Object.md)
5
- - [TopLevel.Error](TopLevel.Error.md)
6
- - [TopLevel.ConversionError](TopLevel.ConversionError.md)
7
-
8
- Represents a conversion error.
9
-
10
- **API Version:**
11
- :::note
12
- No longer available as of version 21.2.
13
- :::
14
-
15
- ## Constructor Summary
16
-
17
- | Constructor | Description |
18
- | --- | --- |
19
- | [ConversionError](#conversionerror)() | Constructs the error. |
20
- | [ConversionError](#conversionerrorstring)([String](TopLevel.String.md)) | Constructs the error with the specified message. |
21
-
22
- ## Method Summary
23
-
24
- ### Methods inherited from class Error
25
-
26
- [captureStackTrace](TopLevel.Error.md#capturestacktraceerror-function), [toString](TopLevel.Error.md#tostring)
27
- ### Methods inherited from class Object
28
-
29
- [assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
30
- ## Constructor Details
31
-
32
- ### ConversionError()
33
- - ConversionError()
34
- - : Constructs the error.
35
-
36
-
37
- ---
38
-
39
- ### ConversionError(String)
40
- - ConversionError(msg: [String](TopLevel.String.md))
41
- - : Constructs the error with the
42
- specified message.
43
-
44
-
45
- **Parameters:**
46
- - msg - the conversion error message.
47
-
48
-
49
- ---
50
-
51
- <!-- prettier-ignore-end -->
@@ -1,271 +0,0 @@
1
- <!-- prettier-ignore-start -->
2
- # Class DataView
3
-
4
- - [TopLevel.Object](TopLevel.Object.md)
5
- - [TopLevel.DataView](TopLevel.DataView.md)
6
-
7
- The DataView provides low level access to [ArrayBuffer](TopLevel.ArrayBuffer.md).
8
-
9
- **API Version:**
10
- :::note
11
- Available from version 21.2.
12
- :::
13
-
14
- ## Property Summary
15
-
16
- | Property | Description |
17
- | --- | --- |
18
- | [buffer](#buffer): [ArrayBuffer](TopLevel.ArrayBuffer.md) | The array buffer referenced by this view. |
19
- | [byteLength](#bytelength): [Number](TopLevel.Number.md) | The number of bytes in the array buffer used by this view. |
20
- | [byteOffset](#byteoffset): [Number](TopLevel.Number.md) | The start offset for this view within the array buffer. |
21
-
22
- ## Constructor Summary
23
-
24
- | Constructor | Description |
25
- | --- | --- |
26
- | [DataView](#dataviewarraybuffer-number-number)([ArrayBuffer](TopLevel.ArrayBuffer.md), [Number](TopLevel.Number.md), [Number](TopLevel.Number.md)) | Creates a data view on the given [ArrayBuffer](TopLevel.ArrayBuffer.md). |
27
-
28
- ## Method Summary
29
-
30
- | Method | Description |
31
- | --- | --- |
32
- | [getFloat32](TopLevel.DataView.md#getfloat32number-boolean)([Number](TopLevel.Number.md), [Boolean](TopLevel.Boolean.md)) | Returns the 32-bit floating point number at the given offset. |
33
- | [getFloat64](TopLevel.DataView.md#getfloat64number-boolean)([Number](TopLevel.Number.md), [Boolean](TopLevel.Boolean.md)) | Returns the 64-bit floating point number at the given offset. |
34
- | [getInt16](TopLevel.DataView.md#getint16number-boolean)([Number](TopLevel.Number.md), [Boolean](TopLevel.Boolean.md)) | Returns the 16-bit signed integer number at the given offset. |
35
- | [getInt32](TopLevel.DataView.md#getint32number-boolean)([Number](TopLevel.Number.md), [Boolean](TopLevel.Boolean.md)) | Returns the 32-bit signed integer number at the given offset. |
36
- | [getInt8](TopLevel.DataView.md#getint8number)([Number](TopLevel.Number.md)) | Returns the 8-bit signed integer number at the given offset. |
37
- | [getUint16](TopLevel.DataView.md#getuint16number-boolean)([Number](TopLevel.Number.md), [Boolean](TopLevel.Boolean.md)) | Returns the 16-bit unsigned integer number at the given offset. |
38
- | [getUint32](TopLevel.DataView.md#getuint32number-boolean)([Number](TopLevel.Number.md), [Boolean](TopLevel.Boolean.md)) | Returns the 32-bit unsigned integer number at the given offset. |
39
- | [getUint8](TopLevel.DataView.md#getuint8number)([Number](TopLevel.Number.md)) | Returns the 8-bit unsigned integer number at the given offset. |
40
- | [setFloat32](TopLevel.DataView.md#setfloat32number-number-boolean)([Number](TopLevel.Number.md), [Number](TopLevel.Number.md), [Boolean](TopLevel.Boolean.md)) | Writes a 32-bit floating point number into the byte array at the given offset. |
41
- | [setFloat64](TopLevel.DataView.md#setfloat64number-number-boolean)([Number](TopLevel.Number.md), [Number](TopLevel.Number.md), [Boolean](TopLevel.Boolean.md)) | Writes a 64-bit floating point number into the byte array at the given offset. |
42
- | [setInt16](TopLevel.DataView.md#setint16number-number-boolean)([Number](TopLevel.Number.md), [Number](TopLevel.Number.md), [Boolean](TopLevel.Boolean.md)) | Writes a 16-bit signed integer number into the byte array at the given offset. |
43
- | [setInt32](TopLevel.DataView.md#setint32number-number-boolean)([Number](TopLevel.Number.md), [Number](TopLevel.Number.md), [Boolean](TopLevel.Boolean.md)) | Writes a 32-bit signed integer number into the byte array at the given offset. |
44
- | [setInt8](TopLevel.DataView.md#setint8number-number)([Number](TopLevel.Number.md), [Number](TopLevel.Number.md)) | Writes an 8-bit signed integer number into the byte array at the given offset. |
45
- | [setUint16](TopLevel.DataView.md#setuint16number-number-boolean)([Number](TopLevel.Number.md), [Number](TopLevel.Number.md), [Boolean](TopLevel.Boolean.md)) | Writes a 16-bit unsigned integer number into the byte array at the given offset. |
46
- | [setUint32](TopLevel.DataView.md#setuint32number-number-boolean)([Number](TopLevel.Number.md), [Number](TopLevel.Number.md), [Boolean](TopLevel.Boolean.md)) | Writes a 32-bit unsigned integer number into the byte array at the given offset. |
47
- | [setUint8](TopLevel.DataView.md#setuint8number-number)([Number](TopLevel.Number.md), [Number](TopLevel.Number.md)) | Writes an 8-bit unsigned integer number into the byte array at the given offset. |
48
-
49
- ### Methods inherited from class Object
50
-
51
- [assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
52
- ## Property Details
53
-
54
- ### buffer
55
- - buffer: [ArrayBuffer](TopLevel.ArrayBuffer.md)
56
- - : The array buffer referenced by this view.
57
-
58
-
59
- ---
60
-
61
- ### byteLength
62
- - byteLength: [Number](TopLevel.Number.md)
63
- - : The number of bytes in the array buffer used by this view.
64
-
65
-
66
- ---
67
-
68
- ### byteOffset
69
- - byteOffset: [Number](TopLevel.Number.md)
70
- - : The start offset for this view within the array buffer.
71
-
72
-
73
- ---
74
-
75
- ## Constructor Details
76
-
77
- ### DataView(ArrayBuffer, Number, Number)
78
- - DataView(buffer: [ArrayBuffer](TopLevel.ArrayBuffer.md), byteOffset: [Number](TopLevel.Number.md), byteLength: [Number](TopLevel.Number.md))
79
- - : Creates a data view on the given [ArrayBuffer](TopLevel.ArrayBuffer.md).
80
-
81
- **Parameters:**
82
- - buffer - The array buffer storage object.
83
- - byteOffset - Optional. The offset within the array buffer in bytes.
84
- - byteLength - Optional. The number of bytes visible to this view.
85
-
86
-
87
- ---
88
-
89
- ## Method Details
90
-
91
- ### getFloat32(Number, Boolean)
92
- - getFloat32(byteOffset: [Number](TopLevel.Number.md), littleEndian: [Boolean](TopLevel.Boolean.md)): [Number](TopLevel.Number.md)
93
- - : Returns the 32-bit floating point number at the given offset.
94
-
95
- **Parameters:**
96
- - byteOffset - The offset within the view.
97
- - littleEndian - Optional. Default is false. Use true if the number is stored in little-endian format.
98
-
99
-
100
- ---
101
-
102
- ### getFloat64(Number, Boolean)
103
- - getFloat64(byteOffset: [Number](TopLevel.Number.md), littleEndian: [Boolean](TopLevel.Boolean.md)): [Number](TopLevel.Number.md)
104
- - : Returns the 64-bit floating point number at the given offset.
105
-
106
- **Parameters:**
107
- - byteOffset - The offset within the view.
108
- - littleEndian - Optional. Default is false. Use true if the number is stored in little-endian format.
109
-
110
-
111
- ---
112
-
113
- ### getInt16(Number, Boolean)
114
- - getInt16(byteOffset: [Number](TopLevel.Number.md), littleEndian: [Boolean](TopLevel.Boolean.md)): [Number](TopLevel.Number.md)
115
- - : Returns the 16-bit signed integer number at the given offset.
116
-
117
- **Parameters:**
118
- - byteOffset - The offset within the view.
119
- - littleEndian - Optional. Default is false. Use true if the number is stored in little-endian format.
120
-
121
-
122
- ---
123
-
124
- ### getInt32(Number, Boolean)
125
- - getInt32(byteOffset: [Number](TopLevel.Number.md), littleEndian: [Boolean](TopLevel.Boolean.md)): [Number](TopLevel.Number.md)
126
- - : Returns the 32-bit signed integer number at the given offset.
127
-
128
- **Parameters:**
129
- - byteOffset - The offset within the view.
130
- - littleEndian - Optional. Default is false. Use true if the number is stored in little-endian format.
131
-
132
-
133
- ---
134
-
135
- ### getInt8(Number)
136
- - getInt8(byteOffset: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
137
- - : Returns the 8-bit signed integer number at the given offset.
138
-
139
- **Parameters:**
140
- - byteOffset - The offset within the view.
141
-
142
-
143
- ---
144
-
145
- ### getUint16(Number, Boolean)
146
- - getUint16(byteOffset: [Number](TopLevel.Number.md), littleEndian: [Boolean](TopLevel.Boolean.md)): [Number](TopLevel.Number.md)
147
- - : Returns the 16-bit unsigned integer number at the given offset.
148
-
149
- **Parameters:**
150
- - byteOffset - The offset within the view.
151
- - littleEndian - Optional. Default is false. Use true if the number is stored in little-endian format.
152
-
153
-
154
- ---
155
-
156
- ### getUint32(Number, Boolean)
157
- - getUint32(byteOffset: [Number](TopLevel.Number.md), littleEndian: [Boolean](TopLevel.Boolean.md)): [Number](TopLevel.Number.md)
158
- - : Returns the 32-bit unsigned integer number at the given offset.
159
-
160
- **Parameters:**
161
- - byteOffset - The offset within the view.
162
- - littleEndian - Optional. Default is false. Use true if the number is stored in little-endian format.
163
-
164
-
165
- ---
166
-
167
- ### getUint8(Number)
168
- - getUint8(byteOffset: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
169
- - : Returns the 8-bit unsigned integer number at the given offset.
170
-
171
- **Parameters:**
172
- - byteOffset - The offset within the view.
173
-
174
-
175
- ---
176
-
177
- ### setFloat32(Number, Number, Boolean)
178
- - setFloat32(byteOffset: [Number](TopLevel.Number.md), value: [Number](TopLevel.Number.md), littleEndian: [Boolean](TopLevel.Boolean.md)): void
179
- - : Writes a 32-bit floating point number into the byte array at the given offset.
180
-
181
- **Parameters:**
182
- - byteOffset - The offset within the view.
183
- - value - The value to be written.
184
- - littleEndian - Optional. Default is false. Use true if the little-endian format is to be used.
185
-
186
-
187
- ---
188
-
189
- ### setFloat64(Number, Number, Boolean)
190
- - setFloat64(byteOffset: [Number](TopLevel.Number.md), value: [Number](TopLevel.Number.md), littleEndian: [Boolean](TopLevel.Boolean.md)): void
191
- - : Writes a 64-bit floating point number into the byte array at the given offset.
192
-
193
- **Parameters:**
194
- - byteOffset - The offset within the view.
195
- - value - The value to be written.
196
- - littleEndian - Optional. Default is false. Use true if the little-endian format is to be used.
197
-
198
-
199
- ---
200
-
201
- ### setInt16(Number, Number, Boolean)
202
- - setInt16(byteOffset: [Number](TopLevel.Number.md), value: [Number](TopLevel.Number.md), littleEndian: [Boolean](TopLevel.Boolean.md)): void
203
- - : Writes a 16-bit signed integer number into the byte array at the given offset.
204
-
205
- **Parameters:**
206
- - byteOffset - The offset within the view.
207
- - value - The value to be written.
208
- - littleEndian - Optional. Default is false. Use true if the little-endian format is to be used.
209
-
210
-
211
- ---
212
-
213
- ### setInt32(Number, Number, Boolean)
214
- - setInt32(byteOffset: [Number](TopLevel.Number.md), value: [Number](TopLevel.Number.md), littleEndian: [Boolean](TopLevel.Boolean.md)): void
215
- - : Writes a 32-bit signed integer number into the byte array at the given offset.
216
-
217
- **Parameters:**
218
- - byteOffset - The offset within the view.
219
- - value - The value to be written.
220
- - littleEndian - Optional. Default is false. Use true if the little-endian format is to be used.
221
-
222
-
223
- ---
224
-
225
- ### setInt8(Number, Number)
226
- - setInt8(byteOffset: [Number](TopLevel.Number.md), value: [Number](TopLevel.Number.md)): void
227
- - : Writes an 8-bit signed integer number into the byte array at the given offset.
228
-
229
- **Parameters:**
230
- - byteOffset - The offset within the view.
231
- - value - The value to be written.
232
-
233
-
234
- ---
235
-
236
- ### setUint16(Number, Number, Boolean)
237
- - setUint16(byteOffset: [Number](TopLevel.Number.md), value: [Number](TopLevel.Number.md), littleEndian: [Boolean](TopLevel.Boolean.md)): void
238
- - : Writes a 16-bit unsigned integer number into the byte array at the given offset.
239
-
240
- **Parameters:**
241
- - byteOffset - The offset within the view.
242
- - value - The value to be written.
243
- - littleEndian - Optional. Default is false. Use true if the little-endian format is to be used.
244
-
245
-
246
- ---
247
-
248
- ### setUint32(Number, Number, Boolean)
249
- - setUint32(byteOffset: [Number](TopLevel.Number.md), value: [Number](TopLevel.Number.md), littleEndian: [Boolean](TopLevel.Boolean.md)): void
250
- - : Writes a 32-bit unsigned integer number into the byte array at the given offset.
251
-
252
- **Parameters:**
253
- - byteOffset - The offset within the view.
254
- - value - The value to be written.
255
- - littleEndian - Optional. Default is false. Use true if the little-endian format is to be used.
256
-
257
-
258
- ---
259
-
260
- ### setUint8(Number, Number)
261
- - setUint8(byteOffset: [Number](TopLevel.Number.md), value: [Number](TopLevel.Number.md)): void
262
- - : Writes an 8-bit unsigned integer number into the byte array at the given offset.
263
-
264
- **Parameters:**
265
- - byteOffset - The offset within the view.
266
- - value - The value to be written.
267
-
268
-
269
- ---
270
-
271
- <!-- prettier-ignore-end -->