@salesforce/b2c-tooling-sdk 1.19.0 → 1.20.0

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 (589) hide show
  1. package/data/help/index.json +9685 -0
  2. package/data/script-api/index.json +1 -528
  3. package/data/tooling/index.json +4 -4
  4. package/data/xsd/index.json +1 -1
  5. package/dist/esm/cli/base-command.js +5 -0
  6. package/dist/esm/cli/base-command.js.map +1 -1
  7. package/dist/esm/clients/index.d.ts +2 -0
  8. package/dist/esm/clients/index.js +1 -0
  9. package/dist/esm/clients/index.js.map +1 -1
  10. package/dist/esm/clients/middleware-registry.d.ts +1 -1
  11. package/dist/esm/clients/middleware-registry.js.map +1 -1
  12. package/dist/esm/clients/preferences.d.ts +83 -0
  13. package/dist/esm/clients/preferences.generated.d.ts +1651 -0
  14. package/dist/esm/clients/preferences.generated.js +6 -0
  15. package/dist/esm/clients/preferences.generated.js.map +1 -0
  16. package/dist/esm/clients/preferences.js +64 -0
  17. package/dist/esm/clients/preferences.js.map +1 -0
  18. package/dist/esm/config/dw-json.d.ts +2 -0
  19. package/dist/esm/config/dw-json.js.map +1 -1
  20. package/dist/esm/config/mapping.js +4 -0
  21. package/dist/esm/config/mapping.js.map +1 -1
  22. package/dist/esm/config/sources/dw-json-source.js +17 -4
  23. package/dist/esm/config/sources/dw-json-source.js.map +1 -1
  24. package/dist/esm/config/sources/env-source.js +2 -0
  25. package/dist/esm/config/sources/env-source.js.map +1 -1
  26. package/dist/esm/config/types.d.ts +14 -0
  27. package/dist/esm/discovery/detector.d.ts +1 -0
  28. package/dist/esm/discovery/detector.js +3 -1
  29. package/dist/esm/discovery/detector.js.map +1 -1
  30. package/dist/esm/discovery/index.d.ts +1 -1
  31. package/dist/esm/discovery/patterns/cartridges.js +4 -2
  32. package/dist/esm/discovery/patterns/cartridges.js.map +1 -1
  33. package/dist/esm/discovery/patterns/sfra.js +10 -5
  34. package/dist/esm/discovery/patterns/sfra.js.map +1 -1
  35. package/dist/esm/discovery/types.d.ts +20 -1
  36. package/dist/esm/docs/content-cache.d.ts +70 -0
  37. package/dist/esm/docs/content-cache.js +186 -0
  38. package/dist/esm/docs/content-cache.js.map +1 -0
  39. package/dist/esm/docs/index.d.ts +1 -0
  40. package/dist/esm/docs/index.js +2 -0
  41. package/dist/esm/docs/index.js.map +1 -1
  42. package/dist/esm/docs/search.js +34 -6
  43. package/dist/esm/docs/search.js.map +1 -1
  44. package/dist/esm/docs/types.d.ts +6 -1
  45. package/dist/esm/docs/types.js +1 -0
  46. package/dist/esm/docs/types.js.map +1 -1
  47. package/dist/esm/index.d.ts +2 -2
  48. package/dist/esm/index.js +1 -1
  49. package/dist/esm/index.js.map +1 -1
  50. package/dist/esm/operations/code/cartridges.d.ts +18 -0
  51. package/dist/esm/operations/code/cartridges.js +31 -20
  52. package/dist/esm/operations/code/cartridges.js.map +1 -1
  53. package/dist/esm/operations/jobs/discover.d.ts +46 -0
  54. package/dist/esm/operations/jobs/discover.js +87 -0
  55. package/dist/esm/operations/jobs/discover.js.map +1 -0
  56. package/dist/esm/operations/jobs/index.d.ts +2 -0
  57. package/dist/esm/operations/jobs/index.js +2 -0
  58. package/dist/esm/operations/jobs/index.js.map +1 -1
  59. package/dist/esm/operations/jobs/run.js +4 -3
  60. package/dist/esm/operations/jobs/run.js.map +1 -1
  61. package/package.json +5 -3
  62. package/specs/preferences-v1.yaml +2095 -0
  63. package/data/script-api/TopLevel.APIException.md +0 -119
  64. package/data/script-api/TopLevel.Array.md +0 -732
  65. package/data/script-api/TopLevel.ArrayBuffer.md +0 -97
  66. package/data/script-api/TopLevel.BigInt.md +0 -154
  67. package/data/script-api/TopLevel.Boolean.md +0 -83
  68. package/data/script-api/TopLevel.ConversionError.md +0 -51
  69. package/data/script-api/TopLevel.DataView.md +0 -271
  70. package/data/script-api/TopLevel.Date.md +0 -688
  71. package/data/script-api/TopLevel.ES6Iterator.md +0 -47
  72. package/data/script-api/TopLevel.Error.md +0 -124
  73. package/data/script-api/TopLevel.EvalError.md +0 -47
  74. package/data/script-api/TopLevel.Fault.md +0 -133
  75. package/data/script-api/TopLevel.Float32Array.md +0 -186
  76. package/data/script-api/TopLevel.Float64Array.md +0 -186
  77. package/data/script-api/TopLevel.Function.md +0 -114
  78. package/data/script-api/TopLevel.Generator.md +0 -132
  79. package/data/script-api/TopLevel.IOError.md +0 -98
  80. package/data/script-api/TopLevel.Int16Array.md +0 -186
  81. package/data/script-api/TopLevel.Int32Array.md +0 -186
  82. package/data/script-api/TopLevel.Int8Array.md +0 -186
  83. package/data/script-api/TopLevel.InternalError.md +0 -47
  84. package/data/script-api/TopLevel.Iterable.md +0 -44
  85. package/data/script-api/TopLevel.Iterator.md +0 -89
  86. package/data/script-api/TopLevel.JSON.md +0 -173
  87. package/data/script-api/TopLevel.Map.md +0 -189
  88. package/data/script-api/TopLevel.Math.md +0 -948
  89. package/data/script-api/TopLevel.Module.md +0 -152
  90. package/data/script-api/TopLevel.Namespace.md +0 -152
  91. package/data/script-api/TopLevel.Number.md +0 -404
  92. package/data/script-api/TopLevel.Object.md +0 -472
  93. package/data/script-api/TopLevel.QName.md +0 -147
  94. package/data/script-api/TopLevel.RangeError.md +0 -47
  95. package/data/script-api/TopLevel.ReferenceError.md +0 -47
  96. package/data/script-api/TopLevel.RegExp.md +0 -155
  97. package/data/script-api/TopLevel.Set.md +0 -150
  98. package/data/script-api/TopLevel.StopIteration.md +0 -36
  99. package/data/script-api/TopLevel.String.md +0 -1060
  100. package/data/script-api/TopLevel.Symbol.md +0 -196
  101. package/data/script-api/TopLevel.SyntaxError.md +0 -47
  102. package/data/script-api/TopLevel.SystemError.md +0 -99
  103. package/data/script-api/TopLevel.TypeError.md +0 -47
  104. package/data/script-api/TopLevel.URIError.md +0 -47
  105. package/data/script-api/TopLevel.Uint16Array.md +0 -186
  106. package/data/script-api/TopLevel.Uint32Array.md +0 -186
  107. package/data/script-api/TopLevel.Uint8Array.md +0 -186
  108. package/data/script-api/TopLevel.Uint8ClampedArray.md +0 -186
  109. package/data/script-api/TopLevel.WeakMap.md +0 -135
  110. package/data/script-api/TopLevel.WeakSet.md +0 -96
  111. package/data/script-api/TopLevel.XML.md +0 -922
  112. package/data/script-api/TopLevel.XMLList.md +0 -418
  113. package/data/script-api/TopLevel.XMLStreamError.md +0 -115
  114. package/data/script-api/TopLevel.arguments.md +0 -56
  115. package/data/script-api/TopLevel.global.md +0 -539
  116. package/data/script-api/TopLevel.md +0 -58
  117. package/data/script-api/dw.alert.Alert.md +0 -175
  118. package/data/script-api/dw.alert.Alerts.md +0 -256
  119. package/data/script-api/dw.alert.md +0 -7
  120. package/data/script-api/dw.campaign.ABTest.md +0 -63
  121. package/data/script-api/dw.campaign.ABTestMgr.md +0 -76
  122. package/data/script-api/dw.campaign.ABTestSegment.md +0 -107
  123. package/data/script-api/dw.campaign.AmountDiscount.md +0 -70
  124. package/data/script-api/dw.campaign.ApproachingDiscount.md +0 -157
  125. package/data/script-api/dw.campaign.BonusChoiceDiscount.md +0 -190
  126. package/data/script-api/dw.campaign.BonusDiscount.md +0 -59
  127. package/data/script-api/dw.campaign.Campaign.md +0 -346
  128. package/data/script-api/dw.campaign.CampaignMgr.md +0 -436
  129. package/data/script-api/dw.campaign.CampaignStatusCodes.md +0 -103
  130. package/data/script-api/dw.campaign.Coupon.md +0 -324
  131. package/data/script-api/dw.campaign.CouponMgr.md +0 -137
  132. package/data/script-api/dw.campaign.CouponRedemption.md +0 -87
  133. package/data/script-api/dw.campaign.CouponStatusCodes.md +0 -130
  134. package/data/script-api/dw.campaign.Discount.md +0 -271
  135. package/data/script-api/dw.campaign.DiscountPlan.md +0 -322
  136. package/data/script-api/dw.campaign.FixedPriceDiscount.md +0 -74
  137. package/data/script-api/dw.campaign.FixedPriceShippingDiscount.md +0 -74
  138. package/data/script-api/dw.campaign.FreeDiscount.md +0 -24
  139. package/data/script-api/dw.campaign.FreeShippingDiscount.md +0 -24
  140. package/data/script-api/dw.campaign.PercentageDiscount.md +0 -74
  141. package/data/script-api/dw.campaign.PercentageOptionDiscount.md +0 -59
  142. package/data/script-api/dw.campaign.PriceBookPriceDiscount.md +0 -56
  143. package/data/script-api/dw.campaign.Promotion.md +0 -939
  144. package/data/script-api/dw.campaign.PromotionMgr.md +0 -478
  145. package/data/script-api/dw.campaign.PromotionPlan.md +0 -378
  146. package/data/script-api/dw.campaign.SlotContent.md +0 -131
  147. package/data/script-api/dw.campaign.SourceCodeGroup.md +0 -83
  148. package/data/script-api/dw.campaign.SourceCodeInfo.md +0 -167
  149. package/data/script-api/dw.campaign.SourceCodeStatusCodes.md +0 -61
  150. package/data/script-api/dw.campaign.TotalFixedPriceDiscount.md +0 -56
  151. package/data/script-api/dw.campaign.md +0 -36
  152. package/data/script-api/dw.catalog.Catalog.md +0 -158
  153. package/data/script-api/dw.catalog.CatalogMgr.md +0 -161
  154. package/data/script-api/dw.catalog.Category.md +0 -1212
  155. package/data/script-api/dw.catalog.CategoryAssignment.md +0 -179
  156. package/data/script-api/dw.catalog.CategoryLink.md +0 -142
  157. package/data/script-api/dw.catalog.PriceBook.md +0 -215
  158. package/data/script-api/dw.catalog.PriceBookMgr.md +0 -176
  159. package/data/script-api/dw.catalog.Product.md +0 -2492
  160. package/data/script-api/dw.catalog.ProductActiveData.md +0 -1244
  161. package/data/script-api/dw.catalog.ProductAttributeModel.md +0 -409
  162. package/data/script-api/dw.catalog.ProductAvailabilityLevels.md +0 -125
  163. package/data/script-api/dw.catalog.ProductAvailabilityModel.md +0 -516
  164. package/data/script-api/dw.catalog.ProductInventoryList.md +0 -136
  165. package/data/script-api/dw.catalog.ProductInventoryMgr.md +0 -132
  166. package/data/script-api/dw.catalog.ProductInventoryRecord.md +0 -638
  167. package/data/script-api/dw.catalog.ProductLink.md +0 -166
  168. package/data/script-api/dw.catalog.ProductMgr.md +0 -136
  169. package/data/script-api/dw.catalog.ProductOption.md +0 -189
  170. package/data/script-api/dw.catalog.ProductOptionModel.md +0 -209
  171. package/data/script-api/dw.catalog.ProductOptionValue.md +0 -132
  172. package/data/script-api/dw.catalog.ProductPriceInfo.md +0 -170
  173. package/data/script-api/dw.catalog.ProductPriceModel.md +0 -988
  174. package/data/script-api/dw.catalog.ProductPriceTable.md +0 -121
  175. package/data/script-api/dw.catalog.ProductSearchHit.md +0 -702
  176. package/data/script-api/dw.catalog.ProductSearchModel.md +0 -1894
  177. package/data/script-api/dw.catalog.ProductSearchRefinementDefinition.md +0 -99
  178. package/data/script-api/dw.catalog.ProductSearchRefinementValue.md +0 -80
  179. package/data/script-api/dw.catalog.ProductSearchRefinements.md +0 -265
  180. package/data/script-api/dw.catalog.ProductVariationAttribute.md +0 -107
  181. package/data/script-api/dw.catalog.ProductVariationAttributeValue.md +0 -215
  182. package/data/script-api/dw.catalog.ProductVariationModel.md +0 -1010
  183. package/data/script-api/dw.catalog.Recommendation.md +0 -327
  184. package/data/script-api/dw.catalog.SearchModel.md +0 -769
  185. package/data/script-api/dw.catalog.SearchRefinementDefinition.md +0 -145
  186. package/data/script-api/dw.catalog.SearchRefinementValue.md +0 -194
  187. package/data/script-api/dw.catalog.SearchRefinements.md +0 -238
  188. package/data/script-api/dw.catalog.SortingOption.md +0 -120
  189. package/data/script-api/dw.catalog.SortingRule.md +0 -53
  190. package/data/script-api/dw.catalog.Store.md +0 -484
  191. package/data/script-api/dw.catalog.StoreGroup.md +0 -95
  192. package/data/script-api/dw.catalog.StoreInventoryFilter.md +0 -112
  193. package/data/script-api/dw.catalog.StoreInventoryFilterValue.md +0 -111
  194. package/data/script-api/dw.catalog.StoreMgr.md +0 -223
  195. package/data/script-api/dw.catalog.Variant.md +0 -1000
  196. package/data/script-api/dw.catalog.VariationGroup.md +0 -869
  197. package/data/script-api/dw.catalog.md +0 -50
  198. package/data/script-api/dw.content.Content.md +0 -481
  199. package/data/script-api/dw.content.ContentMgr.md +0 -147
  200. package/data/script-api/dw.content.ContentSearchModel.md +0 -618
  201. package/data/script-api/dw.content.ContentSearchRefinementDefinition.md +0 -61
  202. package/data/script-api/dw.content.ContentSearchRefinementValue.md +0 -22
  203. package/data/script-api/dw.content.ContentSearchRefinements.md +0 -218
  204. package/data/script-api/dw.content.Folder.md +0 -432
  205. package/data/script-api/dw.content.Library.md +0 -124
  206. package/data/script-api/dw.content.MarkupText.md +0 -150
  207. package/data/script-api/dw.content.MediaFile.md +0 -367
  208. package/data/script-api/dw.content.md +0 -15
  209. package/data/script-api/dw.crypto.CertificateRef.md +0 -59
  210. package/data/script-api/dw.crypto.CertificateUtils.md +0 -162
  211. package/data/script-api/dw.crypto.Cipher.md +0 -1234
  212. package/data/script-api/dw.crypto.Encoding.md +0 -193
  213. package/data/script-api/dw.crypto.JWE.md +0 -245
  214. package/data/script-api/dw.crypto.JWEHeader.md +0 -147
  215. package/data/script-api/dw.crypto.JWS.md +0 -260
  216. package/data/script-api/dw.crypto.JWSHeader.md +0 -128
  217. package/data/script-api/dw.crypto.KeyRef.md +0 -77
  218. package/data/script-api/dw.crypto.Mac.md +0 -191
  219. package/data/script-api/dw.crypto.MessageDigest.md +0 -243
  220. package/data/script-api/dw.crypto.SecureRandom.md +0 -161
  221. package/data/script-api/dw.crypto.Signature.md +0 -241
  222. package/data/script-api/dw.crypto.WeakCipher.md +0 -725
  223. package/data/script-api/dw.crypto.WeakMac.md +0 -163
  224. package/data/script-api/dw.crypto.WeakMessageDigest.md +0 -220
  225. package/data/script-api/dw.crypto.WeakSignature.md +0 -208
  226. package/data/script-api/dw.crypto.X509Certificate.md +0 -180
  227. package/data/script-api/dw.crypto.md +0 -23
  228. package/data/script-api/dw.customer.AddressBook.md +0 -158
  229. package/data/script-api/dw.customer.AgentUserMgr.md +0 -94
  230. package/data/script-api/dw.customer.AgentUserStatusCodes.md +0 -164
  231. package/data/script-api/dw.customer.AuthenticationStatus.md +0 -157
  232. package/data/script-api/dw.customer.Credentials.md +0 -524
  233. package/data/script-api/dw.customer.Customer.md +0 -488
  234. package/data/script-api/dw.customer.CustomerActiveData.md +0 -563
  235. package/data/script-api/dw.customer.CustomerAddress.md +0 -666
  236. package/data/script-api/dw.customer.CustomerCDPData.md +0 -70
  237. package/data/script-api/dw.customer.CustomerContextMgr.md +0 -62
  238. package/data/script-api/dw.customer.CustomerGroup.md +0 -146
  239. package/data/script-api/dw.customer.CustomerList.md +0 -76
  240. package/data/script-api/dw.customer.CustomerMgr.md +0 -1046
  241. package/data/script-api/dw.customer.CustomerPasswordConstraints.md +0 -125
  242. package/data/script-api/dw.customer.CustomerPaymentInstrument.md +0 -161
  243. package/data/script-api/dw.customer.CustomerStatusCodes.md +0 -55
  244. package/data/script-api/dw.customer.EncryptedObject.md +0 -34
  245. package/data/script-api/dw.customer.ExternalProfile.md +0 -154
  246. package/data/script-api/dw.customer.OrderHistory.md +0 -167
  247. package/data/script-api/dw.customer.ProductList.md +0 -870
  248. package/data/script-api/dw.customer.ProductListItem.md +0 -469
  249. package/data/script-api/dw.customer.ProductListItemPurchase.md +0 -139
  250. package/data/script-api/dw.customer.ProductListMgr.md +0 -350
  251. package/data/script-api/dw.customer.ProductListRegistrant.md +0 -165
  252. package/data/script-api/dw.customer.Profile.md +0 -940
  253. package/data/script-api/dw.customer.Wallet.md +0 -136
  254. package/data/script-api/dw.customer.consent.ConsentStatusEntry.md +0 -92
  255. package/data/script-api/dw.customer.consent.MarketingConsentSubscription.md +0 -247
  256. package/data/script-api/dw.customer.consent.ShopperConsentErrorCodes.md +0 -74
  257. package/data/script-api/dw.customer.consent.ShopperConsentException.md +0 -63
  258. package/data/script-api/dw.customer.consent.ShopperConsentMgr.md +0 -152
  259. package/data/script-api/dw.customer.consent.md +0 -10
  260. package/data/script-api/dw.customer.md +0 -31
  261. package/data/script-api/dw.customer.oauth.OAuthAccessTokenResponse.md +0 -171
  262. package/data/script-api/dw.customer.oauth.OAuthFinalizedResponse.md +0 -75
  263. package/data/script-api/dw.customer.oauth.OAuthLoginFlowMgr.md +0 -165
  264. package/data/script-api/dw.customer.oauth.OAuthUserInfoResponse.md +0 -84
  265. package/data/script-api/dw.customer.oauth.md +0 -9
  266. package/data/script-api/dw.customer.shoppercontext.ShopperContext.md +0 -369
  267. package/data/script-api/dw.customer.shoppercontext.ShopperContextErrorCodes.md +0 -111
  268. package/data/script-api/dw.customer.shoppercontext.ShopperContextException.md +0 -77
  269. package/data/script-api/dw.customer.shoppercontext.ShopperContextMgr.md +0 -209
  270. package/data/script-api/dw.customer.shoppercontext.md +0 -9
  271. package/data/script-api/dw.experience.AspectAttributeValidationException.md +0 -25
  272. package/data/script-api/dw.experience.Component.md +0 -166
  273. package/data/script-api/dw.experience.ComponentRenderSettings.md +0 -130
  274. package/data/script-api/dw.experience.ComponentScriptContext.md +0 -148
  275. package/data/script-api/dw.experience.CustomEditor.md +0 -146
  276. package/data/script-api/dw.experience.CustomEditorResources.md +0 -100
  277. package/data/script-api/dw.experience.Page.md +0 -467
  278. package/data/script-api/dw.experience.PageMgr.md +0 -549
  279. package/data/script-api/dw.experience.PageScriptContext.md +0 -200
  280. package/data/script-api/dw.experience.Region.md +0 -119
  281. package/data/script-api/dw.experience.RegionRenderSettings.md +0 -207
  282. package/data/script-api/dw.experience.cms.CMSRecord.md +0 -125
  283. package/data/script-api/dw.experience.cms.md +0 -6
  284. package/data/script-api/dw.experience.image.FocalPoint.md +0 -71
  285. package/data/script-api/dw.experience.image.Image.md +0 -101
  286. package/data/script-api/dw.experience.image.ImageMetaData.md +0 -71
  287. package/data/script-api/dw.experience.image.md +0 -8
  288. package/data/script-api/dw.experience.md +0 -16
  289. package/data/script-api/dw.extensions.applepay.ApplePayHookResult.md +0 -254
  290. package/data/script-api/dw.extensions.applepay.ApplePayHooks.md +0 -572
  291. package/data/script-api/dw.extensions.applepay.md +0 -7
  292. package/data/script-api/dw.extensions.facebook.FacebookFeedHooks.md +0 -102
  293. package/data/script-api/dw.extensions.facebook.FacebookProduct.md +0 -1343
  294. package/data/script-api/dw.extensions.facebook.md +0 -7
  295. package/data/script-api/dw.extensions.paymentapi.PaymentApiHooks.md +0 -136
  296. package/data/script-api/dw.extensions.paymentapi.md +0 -6
  297. package/data/script-api/dw.extensions.paymentrequest.PaymentRequestHookResult.md +0 -149
  298. package/data/script-api/dw.extensions.paymentrequest.PaymentRequestHooks.md +0 -356
  299. package/data/script-api/dw.extensions.paymentrequest.md +0 -7
  300. package/data/script-api/dw.extensions.payments.SalesforceAdyenPaymentIntent.md +0 -134
  301. package/data/script-api/dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.md +0 -283
  302. package/data/script-api/dw.extensions.payments.SalesforceBancontactPaymentDetails.md +0 -88
  303. package/data/script-api/dw.extensions.payments.SalesforceCardPaymentDetails.md +0 -107
  304. package/data/script-api/dw.extensions.payments.SalesforceEpsPaymentDetails.md +0 -63
  305. package/data/script-api/dw.extensions.payments.SalesforceIdealPaymentDetails.md +0 -63
  306. package/data/script-api/dw.extensions.payments.SalesforceKlarnaPaymentDetails.md +0 -63
  307. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrder.md +0 -263
  308. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrderAddress.md +0 -171
  309. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrderPayer.md +0 -110
  310. package/data/script-api/dw.extensions.payments.SalesforcePayPalPaymentDetails.md +0 -88
  311. package/data/script-api/dw.extensions.payments.SalesforcePaymentDetails.md +0 -83
  312. package/data/script-api/dw.extensions.payments.SalesforcePaymentIntent.md +0 -273
  313. package/data/script-api/dw.extensions.payments.SalesforcePaymentMethod.md +0 -368
  314. package/data/script-api/dw.extensions.payments.SalesforcePaymentRequest.md +0 -1077
  315. package/data/script-api/dw.extensions.payments.SalesforcePaymentsHooks.md +0 -190
  316. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccount.md +0 -151
  317. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.md +0 -98
  318. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMgr.md +0 -989
  319. package/data/script-api/dw.extensions.payments.SalesforcePaymentsSiteConfiguration.md +0 -202
  320. package/data/script-api/dw.extensions.payments.SalesforcePaymentsZone.md +0 -393
  321. package/data/script-api/dw.extensions.payments.SalesforceSepaDebitPaymentDetails.md +0 -63
  322. package/data/script-api/dw.extensions.payments.SalesforceVenmoPaymentDetails.md +0 -88
  323. package/data/script-api/dw.extensions.payments.md +0 -28
  324. package/data/script-api/dw.extensions.pinterest.PinterestAvailability.md +0 -85
  325. package/data/script-api/dw.extensions.pinterest.PinterestFeedHooks.md +0 -118
  326. package/data/script-api/dw.extensions.pinterest.PinterestOrder.md +0 -263
  327. package/data/script-api/dw.extensions.pinterest.PinterestOrderHooks.md +0 -89
  328. package/data/script-api/dw.extensions.pinterest.PinterestProduct.md +0 -677
  329. package/data/script-api/dw.extensions.pinterest.md +0 -10
  330. package/data/script-api/dw.io.CSVStreamReader.md +0 -128
  331. package/data/script-api/dw.io.CSVStreamWriter.md +0 -92
  332. package/data/script-api/dw.io.File.md +0 -729
  333. package/data/script-api/dw.io.FileReader.md +0 -70
  334. package/data/script-api/dw.io.FileWriter.md +0 -159
  335. package/data/script-api/dw.io.InputStream.md +0 -35
  336. package/data/script-api/dw.io.OutputStream.md +0 -38
  337. package/data/script-api/dw.io.PrintWriter.md +0 -66
  338. package/data/script-api/dw.io.RandomAccessFileReader.md +0 -183
  339. package/data/script-api/dw.io.Reader.md +0 -284
  340. package/data/script-api/dw.io.StringWriter.md +0 -89
  341. package/data/script-api/dw.io.Writer.md +0 -96
  342. package/data/script-api/dw.io.XMLIndentingStreamWriter.md +0 -121
  343. package/data/script-api/dw.io.XMLStreamConstants.md +0 -172
  344. package/data/script-api/dw.io.XMLStreamReader.md +0 -1181
  345. package/data/script-api/dw.io.XMLStreamWriter.md +0 -478
  346. package/data/script-api/dw.io.md +0 -21
  347. package/data/script-api/dw.job.JobExecution.md +0 -111
  348. package/data/script-api/dw.job.JobStepExecution.md +0 -136
  349. package/data/script-api/dw.job.md +0 -7
  350. package/data/script-api/dw.net.FTPClient.md +0 -621
  351. package/data/script-api/dw.net.FTPFileInfo.md +0 -132
  352. package/data/script-api/dw.net.HTTPClient.md +0 -775
  353. package/data/script-api/dw.net.HTTPClientLoggingConfig.md +0 -363
  354. package/data/script-api/dw.net.HTTPRequestPart.md +0 -296
  355. package/data/script-api/dw.net.Mail.md +0 -487
  356. package/data/script-api/dw.net.SFTPClient.md +0 -535
  357. package/data/script-api/dw.net.SFTPFileInfo.md +0 -128
  358. package/data/script-api/dw.net.WebDAVClient.md +0 -762
  359. package/data/script-api/dw.net.WebDAVFileInfo.md +0 -163
  360. package/data/script-api/dw.net.md +0 -15
  361. package/data/script-api/dw.object.ActiveData.md +0 -86
  362. package/data/script-api/dw.object.CustomAttributes.md +0 -165
  363. package/data/script-api/dw.object.CustomObject.md +0 -82
  364. package/data/script-api/dw.object.CustomObjectMgr.md +0 -478
  365. package/data/script-api/dw.object.Extensible.md +0 -71
  366. package/data/script-api/dw.object.ExtensibleObject.md +0 -85
  367. package/data/script-api/dw.object.Note.md +0 -118
  368. package/data/script-api/dw.object.ObjectAttributeDefinition.md +0 -542
  369. package/data/script-api/dw.object.ObjectAttributeGroup.md +0 -160
  370. package/data/script-api/dw.object.ObjectAttributeValueDefinition.md +0 -78
  371. package/data/script-api/dw.object.ObjectTypeDefinition.md +0 -239
  372. package/data/script-api/dw.object.PersistentObject.md +0 -92
  373. package/data/script-api/dw.object.SimpleExtensible.md +0 -53
  374. package/data/script-api/dw.object.SystemObjectMgr.md +0 -520
  375. package/data/script-api/dw.object.md +0 -19
  376. package/data/script-api/dw.order.AbstractItem.md +0 -220
  377. package/data/script-api/dw.order.AbstractItemCtnr.md +0 -219
  378. package/data/script-api/dw.order.Appeasement.md +0 -398
  379. package/data/script-api/dw.order.AppeasementItem.md +0 -104
  380. package/data/script-api/dw.order.Basket.md +0 -868
  381. package/data/script-api/dw.order.BasketMgr.md +0 -673
  382. package/data/script-api/dw.order.BonusDiscountLineItem.md +0 -309
  383. package/data/script-api/dw.order.CouponLineItem.md +0 -289
  384. package/data/script-api/dw.order.CreateAgentBasketLimitExceededException.md +0 -35
  385. package/data/script-api/dw.order.CreateBasketFromOrderException.md +0 -54
  386. package/data/script-api/dw.order.CreateCouponLineItemException.md +0 -67
  387. package/data/script-api/dw.order.CreateOrderException.md +0 -23
  388. package/data/script-api/dw.order.CreateTemporaryBasketLimitExceededException.md +0 -35
  389. package/data/script-api/dw.order.GiftCertificate.md +0 -530
  390. package/data/script-api/dw.order.GiftCertificateLineItem.md +0 -292
  391. package/data/script-api/dw.order.GiftCertificateMgr.md +0 -228
  392. package/data/script-api/dw.order.GiftCertificateStatusCodes.md +0 -108
  393. package/data/script-api/dw.order.Invoice.md +0 -571
  394. package/data/script-api/dw.order.InvoiceItem.md +0 -199
  395. package/data/script-api/dw.order.LineItem.md +0 -577
  396. package/data/script-api/dw.order.LineItemCtnr.md +0 -2429
  397. package/data/script-api/dw.order.LineItemTax.md +0 -142
  398. package/data/script-api/dw.order.Order.md +0 -2770
  399. package/data/script-api/dw.order.OrderAddress.md +0 -624
  400. package/data/script-api/dw.order.OrderItem.md +0 -613
  401. package/data/script-api/dw.order.OrderMgr.md +0 -1502
  402. package/data/script-api/dw.order.OrderPaymentInstrument.md +0 -231
  403. package/data/script-api/dw.order.OrderProcessStatusCodes.md +0 -146
  404. package/data/script-api/dw.order.PaymentCard.md +0 -220
  405. package/data/script-api/dw.order.PaymentInstrument.md +0 -1416
  406. package/data/script-api/dw.order.PaymentMethod.md +0 -257
  407. package/data/script-api/dw.order.PaymentMgr.md +0 -138
  408. package/data/script-api/dw.order.PaymentProcessor.md +0 -106
  409. package/data/script-api/dw.order.PaymentStatusCodes.md +0 -70
  410. package/data/script-api/dw.order.PaymentTransaction.md +0 -291
  411. package/data/script-api/dw.order.PriceAdjustment.md +0 -745
  412. package/data/script-api/dw.order.PriceAdjustmentLimitTypes.md +0 -61
  413. package/data/script-api/dw.order.ProductLineItem.md +0 -1749
  414. package/data/script-api/dw.order.ProductShippingCost.md +0 -101
  415. package/data/script-api/dw.order.ProductShippingLineItem.md +0 -336
  416. package/data/script-api/dw.order.ProductShippingModel.md +0 -143
  417. package/data/script-api/dw.order.Return.md +0 -396
  418. package/data/script-api/dw.order.ReturnCase.md +0 -463
  419. package/data/script-api/dw.order.ReturnCaseItem.md +0 -372
  420. package/data/script-api/dw.order.ReturnItem.md +0 -335
  421. package/data/script-api/dw.order.Shipment.md +0 -1132
  422. package/data/script-api/dw.order.ShipmentShippingCost.md +0 -54
  423. package/data/script-api/dw.order.ShipmentShippingModel.md +0 -203
  424. package/data/script-api/dw.order.ShippingLineItem.md +0 -315
  425. package/data/script-api/dw.order.ShippingLocation.md +0 -313
  426. package/data/script-api/dw.order.ShippingMethod.md +0 -251
  427. package/data/script-api/dw.order.ShippingMgr.md +0 -173
  428. package/data/script-api/dw.order.ShippingOrder.md +0 -630
  429. package/data/script-api/dw.order.ShippingOrderItem.md +0 -425
  430. package/data/script-api/dw.order.SumItem.md +0 -158
  431. package/data/script-api/dw.order.TaxGroup.md +0 -128
  432. package/data/script-api/dw.order.TaxItem.md +0 -74
  433. package/data/script-api/dw.order.TaxMgr.md +0 -314
  434. package/data/script-api/dw.order.TrackingInfo.md +0 -261
  435. package/data/script-api/dw.order.TrackingRef.md +0 -108
  436. package/data/script-api/dw.order.hooks.BasketMergeHooks.md +0 -87
  437. package/data/script-api/dw.order.hooks.CalculateHooks.md +0 -139
  438. package/data/script-api/dw.order.hooks.CheckoutHooks.md +0 -88
  439. package/data/script-api/dw.order.hooks.OrderHooks.md +0 -96
  440. package/data/script-api/dw.order.hooks.PaymentHooks.md +0 -325
  441. package/data/script-api/dw.order.hooks.ReturnHooks.md +0 -395
  442. package/data/script-api/dw.order.hooks.ShippingOrderHooks.md +0 -426
  443. package/data/script-api/dw.order.hooks.TaxHooks.md +0 -495
  444. package/data/script-api/dw.order.hooks.md +0 -13
  445. package/data/script-api/dw.order.md +0 -65
  446. package/data/script-api/dw.rpc.SOAPUtil.md +0 -736
  447. package/data/script-api/dw.rpc.Stub.md +0 -373
  448. package/data/script-api/dw.rpc.WebReference.md +0 -133
  449. package/data/script-api/dw.rpc.md +0 -8
  450. package/data/script-api/dw.sitemap.SitemapFile.md +0 -137
  451. package/data/script-api/dw.sitemap.SitemapMgr.md +0 -165
  452. package/data/script-api/dw.sitemap.md +0 -7
  453. package/data/script-api/dw.suggest.BrandSuggestions.md +0 -34
  454. package/data/script-api/dw.suggest.CategorySuggestions.md +0 -76
  455. package/data/script-api/dw.suggest.ContentSuggestions.md +0 -76
  456. package/data/script-api/dw.suggest.CustomSuggestions.md +0 -34
  457. package/data/script-api/dw.suggest.ProductSuggestions.md +0 -76
  458. package/data/script-api/dw.suggest.SearchPhraseSuggestions.md +0 -126
  459. package/data/script-api/dw.suggest.SuggestModel.md +0 -471
  460. package/data/script-api/dw.suggest.SuggestedCategory.md +0 -51
  461. package/data/script-api/dw.suggest.SuggestedContent.md +0 -51
  462. package/data/script-api/dw.suggest.SuggestedPhrase.md +0 -70
  463. package/data/script-api/dw.suggest.SuggestedProduct.md +0 -55
  464. package/data/script-api/dw.suggest.SuggestedTerm.md +0 -143
  465. package/data/script-api/dw.suggest.SuggestedTerms.md +0 -144
  466. package/data/script-api/dw.suggest.Suggestions.md +0 -206
  467. package/data/script-api/dw.suggest.md +0 -19
  468. package/data/script-api/dw.svc.FTPService.md +0 -140
  469. package/data/script-api/dw.svc.FTPServiceDefinition.md +0 -97
  470. package/data/script-api/dw.svc.HTTPFormService.md +0 -32
  471. package/data/script-api/dw.svc.HTTPFormServiceDefinition.md +0 -36
  472. package/data/script-api/dw.svc.HTTPService.md +0 -370
  473. package/data/script-api/dw.svc.HTTPServiceDefinition.md +0 -290
  474. package/data/script-api/dw.svc.LocalServiceRegistry.md +0 -63
  475. package/data/script-api/dw.svc.Result.md +0 -320
  476. package/data/script-api/dw.svc.SOAPService.md +0 -104
  477. package/data/script-api/dw.svc.SOAPServiceDefinition.md +0 -32
  478. package/data/script-api/dw.svc.Service.md +0 -276
  479. package/data/script-api/dw.svc.ServiceCallback.md +0 -282
  480. package/data/script-api/dw.svc.ServiceConfig.md +0 -114
  481. package/data/script-api/dw.svc.ServiceCredential.md +0 -162
  482. package/data/script-api/dw.svc.ServiceDefinition.md +0 -211
  483. package/data/script-api/dw.svc.ServiceProfile.md +0 -152
  484. package/data/script-api/dw.svc.ServiceRegistry.md +0 -118
  485. package/data/script-api/dw.svc.md +0 -22
  486. package/data/script-api/dw.system.AgentUserStatusCodes.md +0 -41
  487. package/data/script-api/dw.system.Cache.md +0 -126
  488. package/data/script-api/dw.system.CacheMgr.md +0 -70
  489. package/data/script-api/dw.system.HookMgr.md +0 -78
  490. package/data/script-api/dw.system.InternalObject.md +0 -47
  491. package/data/script-api/dw.system.JobProcessMonitor.md +0 -103
  492. package/data/script-api/dw.system.Log.md +0 -198
  493. package/data/script-api/dw.system.LogNDC.md +0 -75
  494. package/data/script-api/dw.system.Logger.md +0 -216
  495. package/data/script-api/dw.system.OrganizationPreferences.md +0 -53
  496. package/data/script-api/dw.system.Pipeline.md +0 -94
  497. package/data/script-api/dw.system.PipelineDictionary.md +0 -42
  498. package/data/script-api/dw.system.RESTErrorResponse.md +0 -102
  499. package/data/script-api/dw.system.RESTResponseMgr.md +0 -243
  500. package/data/script-api/dw.system.RESTSuccessResponse.md +0 -62
  501. package/data/script-api/dw.system.RemoteInclude.md +0 -146
  502. package/data/script-api/dw.system.Request.md +0 -785
  503. package/data/script-api/dw.system.RequestHooks.md +0 -112
  504. package/data/script-api/dw.system.Response.md +0 -612
  505. package/data/script-api/dw.system.SearchStatus.md +0 -187
  506. package/data/script-api/dw.system.Session.md +0 -469
  507. package/data/script-api/dw.system.Site.md +0 -570
  508. package/data/script-api/dw.system.SitePreferences.md +0 -90
  509. package/data/script-api/dw.system.Status.md +0 -330
  510. package/data/script-api/dw.system.StatusItem.md +0 -273
  511. package/data/script-api/dw.system.System.md +0 -224
  512. package/data/script-api/dw.system.Transaction.md +0 -107
  513. package/data/script-api/dw.system.md +0 -32
  514. package/data/script-api/dw.template.ISML.md +0 -127
  515. package/data/script-api/dw.template.Velocity.md +0 -168
  516. package/data/script-api/dw.template.md +0 -7
  517. package/data/script-api/dw.util.ArrayList.md +0 -99
  518. package/data/script-api/dw.util.Assert.md +0 -370
  519. package/data/script-api/dw.util.BigInteger.md +0 -283
  520. package/data/script-api/dw.util.Bytes.md +0 -278
  521. package/data/script-api/dw.util.Calendar.md +0 -1051
  522. package/data/script-api/dw.util.Collection.md +0 -272
  523. package/data/script-api/dw.util.Currency.md +0 -147
  524. package/data/script-api/dw.util.DateUtils.md +0 -82
  525. package/data/script-api/dw.util.Decimal.md +0 -386
  526. package/data/script-api/dw.util.FilteringCollection.md +0 -140
  527. package/data/script-api/dw.util.Geolocation.md +0 -293
  528. package/data/script-api/dw.util.HashMap.md +0 -50
  529. package/data/script-api/dw.util.HashSet.md +0 -65
  530. package/data/script-api/dw.util.Iterator.md +0 -86
  531. package/data/script-api/dw.util.LinkedHashMap.md +0 -52
  532. package/data/script-api/dw.util.LinkedHashSet.md +0 -68
  533. package/data/script-api/dw.util.List.md +0 -429
  534. package/data/script-api/dw.util.Locale.md +0 -277
  535. package/data/script-api/dw.util.Map.md +0 -251
  536. package/data/script-api/dw.util.MapEntry.md +0 -68
  537. package/data/script-api/dw.util.MappingKey.md +0 -96
  538. package/data/script-api/dw.util.MappingMgr.md +0 -113
  539. package/data/script-api/dw.util.PropertyComparator.md +0 -122
  540. package/data/script-api/dw.util.SecureEncoder.md +0 -582
  541. package/data/script-api/dw.util.SecureFilter.md +0 -572
  542. package/data/script-api/dw.util.SeekableIterator.md +0 -187
  543. package/data/script-api/dw.util.Set.md +0 -39
  544. package/data/script-api/dw.util.SortedMap.md +0 -148
  545. package/data/script-api/dw.util.SortedSet.md +0 -173
  546. package/data/script-api/dw.util.StringUtils.md +0 -655
  547. package/data/script-api/dw.util.Template.md +0 -141
  548. package/data/script-api/dw.util.UUIDUtils.md +0 -34
  549. package/data/script-api/dw.util.md +0 -37
  550. package/data/script-api/dw.value.EnumValue.md +0 -105
  551. package/data/script-api/dw.value.MimeEncodedText.md +0 -131
  552. package/data/script-api/dw.value.Money.md +0 -526
  553. package/data/script-api/dw.value.Quantity.md +0 -299
  554. package/data/script-api/dw.value.md +0 -9
  555. package/data/script-api/dw.web.CSRFProtection.md +0 -105
  556. package/data/script-api/dw.web.ClickStream.md +0 -177
  557. package/data/script-api/dw.web.ClickStreamEntry.md +0 -255
  558. package/data/script-api/dw.web.Cookie.md +0 -431
  559. package/data/script-api/dw.web.Cookies.md +0 -59
  560. package/data/script-api/dw.web.Form.md +0 -84
  561. package/data/script-api/dw.web.FormAction.md +0 -195
  562. package/data/script-api/dw.web.FormElement.md +0 -211
  563. package/data/script-api/dw.web.FormElementValidationResult.md +0 -170
  564. package/data/script-api/dw.web.FormField.md +0 -642
  565. package/data/script-api/dw.web.FormFieldOption.md +0 -211
  566. package/data/script-api/dw.web.FormFieldOptions.md +0 -49
  567. package/data/script-api/dw.web.FormGroup.md +0 -222
  568. package/data/script-api/dw.web.FormList.md +0 -134
  569. package/data/script-api/dw.web.FormListItem.md +0 -57
  570. package/data/script-api/dw.web.Forms.md +0 -25
  571. package/data/script-api/dw.web.HttpParameter.md +0 -462
  572. package/data/script-api/dw.web.HttpParameterMap.md +0 -194
  573. package/data/script-api/dw.web.LoopIterator.md +0 -231
  574. package/data/script-api/dw.web.PageMetaData.md +0 -197
  575. package/data/script-api/dw.web.PageMetaTag.md +0 -173
  576. package/data/script-api/dw.web.PagingModel.md +0 -407
  577. package/data/script-api/dw.web.Resource.md +0 -147
  578. package/data/script-api/dw.web.URL.md +0 -174
  579. package/data/script-api/dw.web.URLAction.md +0 -95
  580. package/data/script-api/dw.web.URLParameter.md +0 -52
  581. package/data/script-api/dw.web.URLRedirect.md +0 -72
  582. package/data/script-api/dw.web.URLRedirectMgr.md +0 -86
  583. package/data/script-api/dw.web.URLUtils.md +0 -1357
  584. package/data/script-api/dw.web.md +0 -34
  585. package/data/script-api/dw.ws.Port.md +0 -126
  586. package/data/script-api/dw.ws.WSUtil.md +0 -728
  587. package/data/script-api/dw.ws.WebReference2.md +0 -137
  588. package/data/script-api/dw.ws.md +0 -8
  589. package/data/script-api/index.md +0 -40
@@ -1,948 +0,0 @@
1
- <!-- prettier-ignore-start -->
2
- # Class Math
3
-
4
- - [TopLevel.Object](TopLevel.Object.md)
5
- - [TopLevel.Math](TopLevel.Math.md)
6
-
7
- Mathematical functions and constants.
8
-
9
-
10
- ## Constant Summary
11
-
12
- | Constant | Description |
13
- | --- | --- |
14
- | [E](#e): [Number](TopLevel.Number.md) | The constant _e_, which is the base of natural logarithms. |
15
- | [LN10](#ln10): [Number](TopLevel.Number.md) | The natural logarithm of 10. |
16
- | [LN2](#ln2): [Number](TopLevel.Number.md) | The natural logarithm of 2. |
17
- | [LOG10E](#log10e): [Number](TopLevel.Number.md) | The base-10 logarithm of _e_. |
18
- | [LOG2E](#log2e): [Number](TopLevel.Number.md) | The base-2 logarithm of _e_. |
19
- | [PI](#pi): [Number](TopLevel.Number.md) | The constant for PI. |
20
- | [SQRT1_2](#sqrt1_2): [Number](TopLevel.Number.md) | 1 divided by the square root of 2. |
21
- | [SQRT2](#sqrt2): [Number](TopLevel.Number.md) | The square root of 2. |
22
-
23
- ## Constructor Summary
24
-
25
- | Constructor | Description |
26
- | --- | --- |
27
- | [Math](#math)() | |
28
-
29
- ## Method Summary
30
-
31
- | Method | Description |
32
- | --- | --- |
33
- | static [abs](TopLevel.Math.md#absnumber)([Number](TopLevel.Number.md)) | Returns the absolute value of _x_. |
34
- | static [acos](TopLevel.Math.md#acosnumber)([Number](TopLevel.Number.md)) | Returns an approximation to the arc cosine of _x_. |
35
- | static [acosh](TopLevel.Math.md#acoshnumber)([Number](TopLevel.Number.md)) | Returns an approximation to the inverse hyperbolic cosine of _x_. |
36
- | static [asin](TopLevel.Math.md#asinnumber)([Number](TopLevel.Number.md)) | Returns an approximation to the arc sine of _x_. |
37
- | static [asinh](TopLevel.Math.md#asinhnumber)([Number](TopLevel.Number.md)) | Returns an approximation to the inverse hyperbolic sine of _x_. |
38
- | static [atan](TopLevel.Math.md#atannumber)([Number](TopLevel.Number.md)) | Returns an approximation to the arc tangent of _x_. |
39
- | static [atan2](TopLevel.Math.md#atan2number-number)([Number](TopLevel.Number.md), [Number](TopLevel.Number.md)) | Returns an approximation to the arc tangent of the quotient y/x of the arguments _y_ and _x_, where the signs of _y_ and _x_ are used to determine the quadrant of the result. |
40
- | static [atanh](TopLevel.Math.md#atanhnumber)([Number](TopLevel.Number.md)) | Returns an approximation to the inverse hyperbolic tangent of _x_. |
41
- | static [cbrt](TopLevel.Math.md#cbrtnumber)([Number](TopLevel.Number.md)) | Returns an approximation to the cube root of _x_. |
42
- | static [ceil](TopLevel.Math.md#ceilnumber)([Number](TopLevel.Number.md)) | Returns the smallest (closest to -&#8734;) number value that is not less than _x_ and is equal to a mathematical integer. |
43
- | static [clz32](TopLevel.Math.md#clz32number)([Number](TopLevel.Number.md)) | Returns the number of leading zero bits in the 32-bit binary representation of _x_. |
44
- | static [cos](TopLevel.Math.md#cosnumber)([Number](TopLevel.Number.md)) | Returns an approximation to the cosine of _x_. |
45
- | static [cosh](TopLevel.Math.md#coshnumber)([Number](TopLevel.Number.md)) | Returns an approximation to the hyperbolic cosine of _x_. |
46
- | static [exp](TopLevel.Math.md#expnumber)([Number](TopLevel.Number.md)) | Returns an approximation to the exponential function of _x_ (e raised to the power of x, where e is the base of the natural logarithms). |
47
- | static [expm1](TopLevel.Math.md#expm1number)([Number](TopLevel.Number.md)) | Returns an approximation to subtracting 1 from the exponential function of _x_ (e raised to the power of _x_, where e is the base of the natural logarithms). |
48
- | static [floor](TopLevel.Math.md#floornumber)([Number](TopLevel.Number.md)) | Returns the greatest (closest to +&#8734;) number value that is not greater than _x_ and is equal to a mathematical integer. |
49
- | static [fround](TopLevel.Math.md#froundnumber)([Number](TopLevel.Number.md)) | Returns the nearest 32-bit single precision float representation of _x_. |
50
- | static [hypot](TopLevel.Math.md#hypotnumber)([Number...](TopLevel.Number.md)) | Returns an approximation of the square root of the sum of squares of the arguments. |
51
- | static [imul](TopLevel.Math.md#imulnumber-number)([Number](TopLevel.Number.md), [Number](TopLevel.Number.md)) | Performs a 32 bit integer multiplication, where the result is always a 32 bit integer value, ignoring any overflows. |
52
- | static [log](TopLevel.Math.md#lognumber)([Number](TopLevel.Number.md)) | Returns an approximation to the natural logarithm of _x_. |
53
- | static [log10](TopLevel.Math.md#log10number)([Number](TopLevel.Number.md)) | Returns an approximation to the base 10 logarithm of _x_. |
54
- | static [log1p](TopLevel.Math.md#log1pnumber)([Number](TopLevel.Number.md)) | Returns an approximation to the natural logarithm of of 1 + _x_. |
55
- | static [log2](TopLevel.Math.md#log2number)([Number](TopLevel.Number.md)) | Returns an approximation to the base 2 logarithm of _x_. |
56
- | static [max](TopLevel.Math.md#maxnumber)([Number...](TopLevel.Number.md)) | Returns the largest specified values. |
57
- | static [min](TopLevel.Math.md#minnumber)([Number...](TopLevel.Number.md)) | Returns the smallest of the specified values. |
58
- | static [pow](TopLevel.Math.md#pownumber-number)([Number](TopLevel.Number.md), [Number](TopLevel.Number.md)) | Returns an approximation to the result of raising _x_ to the power _y_. |
59
- | static [random](TopLevel.Math.md#random)() | Returns a number value with positive sign, greater than or equal to 0 but less than 1, chosen randomly or pseudo randomly with approximately uniform distribution over that range, using an implementation-dependent algorithm or strategy. |
60
- | static [round](TopLevel.Math.md#roundnumber)([Number](TopLevel.Number.md)) | Returns the number value that is closest to _x_ and is equal to a mathematical integer. |
61
- | static [sign](TopLevel.Math.md#signnumber)([Number](TopLevel.Number.md)) | Returns the sign of _x_, indicating whether _x_ is positive, negative, or zero. |
62
- | static [sin](TopLevel.Math.md#sinnumber)([Number](TopLevel.Number.md)) | Returns an approximation to the sine of _x_. |
63
- | static [sinh](TopLevel.Math.md#sinhnumber)([Number](TopLevel.Number.md)) | Returns an approximation to the hyperbolic sine of _x_. |
64
- | static [sqrt](TopLevel.Math.md#sqrtnumber)([Number](TopLevel.Number.md)) | Returns an approximation to the square root of _x_. |
65
- | static [tan](TopLevel.Math.md#tannumber)([Number](TopLevel.Number.md)) | Returns an approximation to the tangent of _x_. |
66
- | static [tanh](TopLevel.Math.md#tanhnumber)([Number](TopLevel.Number.md)) | Returns an approximation to the hyperbolic tangent of _x_. |
67
- | static [trunc](TopLevel.Math.md#truncnumber)([Number](TopLevel.Number.md)) | Returns the integral part of the number _x_, removing any fractional digits. |
68
-
69
- ### Methods inherited from class Object
70
-
71
- [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)
72
- ## Constant Details
73
-
74
- ### E
75
-
76
- - E: [Number](TopLevel.Number.md)
77
- - : The constant _e_, which is the base of natural logarithms.
78
-
79
-
80
- ---
81
-
82
- ### LN10
83
-
84
- - LN10: [Number](TopLevel.Number.md)
85
- - : The natural logarithm of 10.
86
-
87
-
88
- ---
89
-
90
- ### LN2
91
-
92
- - LN2: [Number](TopLevel.Number.md)
93
- - : The natural logarithm of 2.
94
-
95
-
96
- ---
97
-
98
- ### LOG10E
99
-
100
- - LOG10E: [Number](TopLevel.Number.md)
101
- - : The base-10 logarithm of _e_.
102
-
103
-
104
- ---
105
-
106
- ### LOG2E
107
-
108
- - LOG2E: [Number](TopLevel.Number.md)
109
- - : The base-2 logarithm of _e_.
110
-
111
-
112
- ---
113
-
114
- ### PI
115
-
116
- - PI: [Number](TopLevel.Number.md)
117
- - : The constant for PI.
118
-
119
-
120
- ---
121
-
122
- ### SQRT1_2
123
-
124
- - SQRT1_2: [Number](TopLevel.Number.md)
125
- - : 1 divided by the square root of 2.
126
-
127
-
128
- ---
129
-
130
- ### SQRT2
131
-
132
- - SQRT2: [Number](TopLevel.Number.md)
133
- - : The square root of 2.
134
-
135
-
136
- ---
137
-
138
- ## Constructor Details
139
-
140
- ### Math()
141
- - Math()
142
- - :
143
-
144
-
145
- ---
146
-
147
- ## Method Details
148
-
149
- ### abs(Number)
150
- - static abs(x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
151
- - : Returns the absolute value of _x_. The result has the same magnitude as _x_ but has positive sign.
152
-
153
- - If _x_is NaN, the result is NaN.
154
- - If _x_is -0, the result is +0.
155
- - If _x_is -&#8734;, the result is +&#8734;.
156
-
157
-
158
- **Parameters:**
159
- - x - the Number to operate on.
160
-
161
- **Returns:**
162
- - the absolute value of _x_.
163
-
164
-
165
- ---
166
-
167
- ### acos(Number)
168
- - static acos(x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
169
- - : Returns an approximation to the arc cosine of _x_. The result is expressed in radians and ranges from +0 to
170
- +p.
171
-
172
- - If _x_is NaN, the result is NaN.
173
- - If _x_is greater than 1, the result is NaN.
174
- - If _x_is less than -1, the result is NaN.
175
- - If _x_is exactly 1, the result is +0.
176
-
177
-
178
- **Parameters:**
179
- - x - the Number to operate on.
180
-
181
- **Returns:**
182
- - an approximation to the arc cosine of _x_.
183
-
184
-
185
- ---
186
-
187
- ### acosh(Number)
188
- - static acosh(x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
189
- - : Returns an approximation to the inverse hyperbolic cosine of _x_.
190
-
191
- - If _x_is NaN, the result is NaN.
192
- - If _x_is less than 1, the result is NaN.
193
- - If _x_is exactly 1, the result is +0.
194
- - If _x_is +&#8734;, the result is +&#8734;.
195
-
196
-
197
- **Parameters:**
198
- - x - the Number to operate on.
199
-
200
- **Returns:**
201
- - an approximation to the inverse hyperbolic cosine of _x_.
202
-
203
- **API Version:**
204
- :::note
205
- Available from version 21.2.
206
- :::
207
-
208
- ---
209
-
210
- ### asin(Number)
211
- - static asin(x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
212
- - : Returns an approximation to the arc sine of _x_. The result is expressed in radians and ranges from -p/2 to
213
- +p/2.
214
-
215
- - If _x_is NaN, the result is NaN
216
- - If _x_is greater than 1, the result is NaN.
217
- - If _x_is less than -1, the result is NaN.
218
- - If _x_is +0, the result is +0.
219
- - If _x_is -0, the result is -0.
220
-
221
-
222
- **Parameters:**
223
- - x - the Number to operate on.
224
-
225
- **Returns:**
226
- - an approximation to the arc sine of _x_.
227
-
228
-
229
- ---
230
-
231
- ### asinh(Number)
232
- - static asinh(x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
233
- - : Returns an approximation to the inverse hyperbolic sine of _x_.
234
-
235
- - If _x_is NaN, the result is NaN
236
- - If _x_is +0, the result is +0.
237
- - If _x_is -0, the result is -0.
238
- - If _x_is +&#8734;, the result is +&#8734;.
239
- - If _x_is -&#8734;, the result is -&#8734;.
240
-
241
-
242
- **Parameters:**
243
- - x - the Number to operate on.
244
-
245
- **Returns:**
246
- - an approximation to the inverse hyperbolic sine of _x_.
247
-
248
- **API Version:**
249
- :::note
250
- Available from version 21.2.
251
- :::
252
-
253
- ---
254
-
255
- ### atan(Number)
256
- - static atan(x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
257
- - : Returns an approximation to the arc tangent of _x_. The result is expressed in radians and ranges from -p/2
258
- to +p/2.
259
-
260
- - If _x_is NaN, the result is NaN.
261
- - If _x_is +0, the result is +0.
262
- - If _x_is -0, the result is -0.
263
- - If _x_is +&#8734;, the result is an approximation to +p/2.
264
- - If _x_is -&#8734;, the result is an approximation to -p/2.
265
-
266
-
267
- **Parameters:**
268
- - x - the Number to operate on.
269
-
270
- **Returns:**
271
- - an approximation to the arc tangent of _x_.
272
-
273
-
274
- ---
275
-
276
- ### atan2(Number, Number)
277
- - static atan2(y: [Number](TopLevel.Number.md), x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
278
- - : Returns an approximation to the arc tangent of the quotient y/x of the arguments _y_ and _x_, where the
279
- signs of _y_ and _x_ are used to determine the quadrant of the result. Note that it is intentional and
280
- traditional for the two-argument arc tangent function that the argument named _y_ be first and the argument
281
- named _x_ be second. The result is expressed in radians and ranges from -p to +p.
282
-
283
- - If either _x_or _y_is NaN, the result is NaN.
284
- - If _y_>0 and _x_is +0, the result is an implementation-dependent approximation to +p/2.
285
- - If _y_>0 and _x_is -0, the result is an implementation-dependent approximation to +p/2.
286
- - If _y_is +0 and _x_>0, the result is +0.
287
- - If _y_is +0 and _x_is +0, the result is +0.
288
- - If _y_is +0 and _x_is -0, the result is an implementation-dependent approximation to +p.
289
- - If _y_is +0 and _X_<0, the result is an implementation-dependent approximation to +p.
290
- - If _y_is -0 and _x_>0, the result is -0.
291
- - If _y_is -0 and _x_is +0, the result is -0.
292
- - If _y_is -0 and _x_is -0, the result is an implementation-dependent approximation to -p.
293
- - If _y_is -0 and _X_<0, the result is an implementation-dependent approximation to -p.
294
- - If _y_<0 and _x_is +0, the result is an implementation-dependent approximation to -p/2.
295
- - If _y_<0 and _x_is -0, the result is an implementation-dependent approximation to -p/2.
296
- - If _y_>0 and _y_is finite and _x_is +&#8734;, the result is +0.
297
- - If _y_>0 and _y_is finite and _x_is -&#8734;, the result if an implementation-dependent approximation to +p.
298
- - If _y_<0 and _y_is finite and _x_is +&#8734;, the result is -0.
299
- - If _y_<0 and _y_is finite and _x_is -&#8734;, the result is an implementation-dependent approximation to -p.
300
- - If _y_is +&#8734;and _x_is finite, the result is an implementation-dependent approximation to +p/2.
301
- - If _y_is -&#8734;and _x_is finite, the result is an implementation-dependent approximation to -p/2.
302
- - If _y_is +&#8734;and _x_is +&#8734;, the result is an implementation-dependent approximation to +p/4.
303
- - If _y_is +&#8734;and _x_is -&#8734;, the result is an implementation-dependent approximation to +3p/4.
304
- - If _y_is -&#8734;and _x_is +&#8734;, the result is an implementation-dependent approximation to -p/4.
305
- - If _y_is -&#8734;and _x_is -&#8734;, the result is an implementation-dependent approximation to -3p/4.
306
-
307
-
308
- **Parameters:**
309
- - y - the first argument.
310
- - x - the second argument.
311
-
312
- **Returns:**
313
- - approximation to the arc tangent of the quotient _y/x_ of the arguments _y_ and x, where the
314
- signs of _y_ and _x_ are used to determine the quadrant of the result.
315
-
316
-
317
-
318
- ---
319
-
320
- ### atanh(Number)
321
- - static atanh(x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
322
- - : Returns an approximation to the inverse hyperbolic tangent of _x_.
323
-
324
- - If _x_is NaN, the result is NaN.
325
- - If _x_is less than -1, the result is NaN.
326
- - If _x_is greater than 1, the result is NaN.
327
- - If _x_is exactly -1, the result is -&#8734;.
328
- - If _x_is exactly +1, the result is +&#8734;.
329
- - If _x_is +0, the result is +0.
330
- - If _x_is -0, the result is -0.
331
-
332
-
333
- **Parameters:**
334
- - x - the Number to operate on.
335
-
336
- **Returns:**
337
- - an approximation to the inverse hyperbolic tangent of _x_.
338
-
339
- **API Version:**
340
- :::note
341
- Available from version 21.2.
342
- :::
343
-
344
- ---
345
-
346
- ### cbrt(Number)
347
- - static cbrt(x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
348
- - : Returns an approximation to the cube root of _x_.
349
-
350
- - If _x_is NaN, the result is NaN
351
- - If _x_is +0, the result is +0.
352
- - If _x_is -0, the result is -0.
353
- - If _x_is +&#8734;, the result is +&#8734;.
354
- - If _x_is -&#8734;, the result is -&#8734;.
355
-
356
-
357
- **Parameters:**
358
- - x - the Number to operate on.
359
-
360
- **Returns:**
361
- - an approximation to the cube root of _x_.
362
-
363
- **API Version:**
364
- :::note
365
- Available from version 21.2.
366
- :::
367
-
368
- ---
369
-
370
- ### ceil(Number)
371
- - static ceil(x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
372
- - : Returns the smallest (closest to -&#8734;) number value that is not less than _x_ and is equal to a
373
- mathematical integer. If _x_ is already an integer, the result is _x_.
374
-
375
- - If _x_is NaN, the result is NaN.
376
- - If _x_is +0, the result is +0.
377
- - If _x_is -0, the result is -0.
378
- - If _x_is +&#8734;, the result is +&#8734;.
379
- - If _x_is -&#8734;, the result is -&#8734;.
380
- - If _x_is less than 0 but greater than -1, the result is -0.
381
-
382
- The value of Math.ceil(x) is the same as the value of -Math.floor(-x).
383
-
384
-
385
- **Parameters:**
386
- - x - the Number to operate on.
387
-
388
- **Returns:**
389
- - the smallest (closest to -&#8734;) number value that is not less than _x_ and is equal to a
390
- mathematical integer.
391
-
392
-
393
-
394
- ---
395
-
396
- ### clz32(Number)
397
- - static clz32(x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
398
- - : Returns the number of leading zero bits in the 32-bit binary representation of _x_.
399
-
400
- **Parameters:**
401
- - x - the Number to operate on.
402
-
403
- **Returns:**
404
- - the number of leading zero bits in the 32-bit binary representation of _x_.
405
-
406
- **API Version:**
407
- :::note
408
- Available from version 21.2.
409
- :::
410
-
411
- ---
412
-
413
- ### cos(Number)
414
- - static cos(x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
415
- - : Returns an approximation to the cosine of _x_. The argument is expressed in radians.
416
-
417
- - If _x_is NaN, the result is NaN.
418
- - If _x_is +0, the result is 1.
419
- - If _x_is -0, the result is 1.
420
- - If _x_is +&#8734;, the result is NaN.
421
- - If _x_is -&#8734;, the result is NaN.
422
-
423
-
424
- **Parameters:**
425
- - x - the Number to operate on.
426
-
427
- **Returns:**
428
- - an approximation to the cosine of _x_.
429
-
430
-
431
- ---
432
-
433
- ### cosh(Number)
434
- - static cosh(x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
435
- - : Returns an approximation to the hyperbolic cosine of _x_.
436
-
437
- - If _x_is NaN, the result is NaN.
438
- - If _x_is +0, the result is 1.
439
- - If _x_is -0, the result is 1.
440
- - If _x_is +&#8734;, the result is +&#8734;.
441
- - If _x_is -&#8734;, the result is +&#8734;.
442
-
443
-
444
- **Parameters:**
445
- - x - the Number to operate on.
446
-
447
- **Returns:**
448
- - an approximation to the hyperbolic cosine of _x_.
449
-
450
- **API Version:**
451
- :::note
452
- Available from version 21.2.
453
- :::
454
-
455
- ---
456
-
457
- ### exp(Number)
458
- - static exp(x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
459
- - : Returns an approximation to the exponential function of _x_ (e raised to the power
460
- of x, where e is the base of the natural logarithms).
461
-
462
- - If _x_is NaN, the result is NaN.
463
- - If _x_is +0, the result is 1.
464
- - If _x_is -0, the result is 1.
465
- - If _x_is +&#8734;, the result is +&#8734;.
466
- - If _x_is -&#8734;, the result is +0.
467
-
468
-
469
- **Parameters:**
470
- - x - the Number to operate on.
471
-
472
- **Returns:**
473
- - an approximation to the exponential function of _x_.
474
-
475
-
476
- ---
477
-
478
- ### expm1(Number)
479
- - static expm1(x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
480
- - : Returns an approximation to subtracting 1 from the exponential function of _x_ (e raised to the power of _x_, where e
481
- is the base of the natural logarithms). The result is computed in a way that is accurate even when the value of _x_
482
- is close 0.
483
-
484
- - If _x_is NaN, the result is NaN.
485
- - If _x_is +0, the result is +0.
486
- - If _x_is -0, the result is -0.
487
- - If _x_is +&#8734;, the result is +&#8734;.
488
- - If _x_is -&#8734;, the result is -1.
489
-
490
-
491
- **Parameters:**
492
- - x - the Number to operate on.
493
-
494
- **Returns:**
495
- - an approximation to subtracting 1 from the exponential function of _x_.
496
-
497
- **API Version:**
498
- :::note
499
- Available from version 21.2.
500
- :::
501
-
502
- ---
503
-
504
- ### floor(Number)
505
- - static floor(x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
506
- - : Returns the greatest (closest to +&#8734;) number value that is not greater than _x_ and is equal to a
507
- mathematical integer. If _x_ is already an integer, the result is _x_.
508
-
509
- - If _x_is NaN, the result is NaN.
510
- - If _x_is +0, the result is +0.
511
- - If _x_is -0, the result is -0.
512
- - If _x_is +&#8734;, the result is +&#8734;.
513
- - If _x_is -&#8734;, the result is -&#8734;.
514
- - If _x_is greater than 0 but less than 1, the result is +0.
515
-
516
- The value of Math.floor(_x_) is the same as the value of -Math.ceil(_-x_).
517
-
518
-
519
- **Parameters:**
520
- - x - the Number to operate on.
521
-
522
- **Returns:**
523
- - the greatest (closest to +&#8734;) number value that is not greater than _x_ and is equal to a
524
- mathematical integer.
525
-
526
-
527
-
528
- ---
529
-
530
- ### fround(Number)
531
- - static fround(x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
532
- - : Returns the nearest 32-bit single precision float representation of _x_.
533
-
534
- **Parameters:**
535
- - x - the Number to operate on.
536
-
537
- **Returns:**
538
- - the nearest 32-bit single precision float representation of _x_.
539
-
540
- **API Version:**
541
- :::note
542
- Available from version 21.2.
543
- :::
544
-
545
- ---
546
-
547
- ### hypot(Number...)
548
- - static hypot(values: [Number...](TopLevel.Number.md)): [Number](TopLevel.Number.md)
549
- - : Returns an approximation of the square root of the sum of squares of the arguments.
550
-
551
- - If no arguments are passed, the result is +0.
552
- - If any argument is +&#8734;, the result is +&#8734;.
553
- - If any argument is -&#8734;, the result is +&#8734;.
554
- - If no argument is +&#8734;or -&#8734;and any argument is NaN, the result is NaN.
555
- - If all arguments are either +0 or -0, the result is +0.
556
-
557
-
558
- **Parameters:**
559
- - values - the Number values to operate on.
560
-
561
- **Returns:**
562
- - an approximation of the square root of the sum of squares of the arguments.
563
-
564
- **API Version:**
565
- :::note
566
- Available from version 21.2.
567
- :::
568
-
569
- ---
570
-
571
- ### imul(Number, Number)
572
- - static imul(x: [Number](TopLevel.Number.md), y: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
573
- - : Performs a 32 bit integer multiplication, where the result is always a 32 bit integer value, ignoring any overflows.
574
-
575
- **Parameters:**
576
- - x - The first operand.
577
- - y - The second operand.
578
-
579
- **Returns:**
580
- - Returns the result of the 32 bit multiplication. The result is a 32 bit signed integer value.
581
-
582
- **API Version:**
583
- :::note
584
- Available from version 21.2.
585
- :::
586
-
587
- ---
588
-
589
- ### log(Number)
590
- - static log(x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
591
- - : Returns an approximation to the natural logarithm of _x_.
592
-
593
- - If _x_is NaN, the result is NaN.
594
- - If _x_is less than 0, the result is NaN.
595
- - If _x_is +0 or -0, the result is -&#8734;.
596
- - If _x_is 1, the result is +0.
597
- - If _x_is +&#8734;, the result is +&#8734;.
598
-
599
-
600
- **Parameters:**
601
- - x - the Number to operate on.
602
-
603
- **Returns:**
604
- - an approximation to the natural logarithm of _x_.
605
-
606
-
607
- ---
608
-
609
- ### log10(Number)
610
- - static log10(x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
611
- - : Returns an approximation to the base 10 logarithm of _x_.
612
-
613
- - If _x_is NaN, the result is NaN.
614
- - If _x_is less than 0, the result is NaN.
615
- - If _x_is +0 or -0, the result is -&#8734;.
616
- - If _x_is 1, the result is +0.
617
- - If _x_is +&#8734;, the result is +&#8734;.
618
-
619
-
620
- **Parameters:**
621
- - x - the Number to operate on.
622
-
623
- **Returns:**
624
- - an approximation to the base 10 logarithm of _x_.
625
-
626
- **API Version:**
627
- :::note
628
- Available from version 21.2.
629
- :::
630
-
631
- ---
632
-
633
- ### log1p(Number)
634
- - static log1p(x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
635
- - : Returns an approximation to the natural logarithm of of 1 + _x_.
636
-
637
- - If _x_is NaN, the result is NaN.
638
- - If _x_is less than -1, the result is NaN.
639
- - If _x_is -1, the result is -&#8734;.
640
- - If _x_is +0, the result is +0.
641
- - If _x_is -0, the result is -0.
642
- - If _x_is +&#8734;, the result is +&#8734;.
643
-
644
-
645
- **Parameters:**
646
- - x - the Number to operate on.
647
-
648
- **Returns:**
649
- - an approximation to the natural logarithm of of 1 + _x_.
650
-
651
- **API Version:**
652
- :::note
653
- Available from version 21.2.
654
- :::
655
-
656
- ---
657
-
658
- ### log2(Number)
659
- - static log2(x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
660
- - : Returns an approximation to the base 2 logarithm of _x_.
661
-
662
- - If _x_is NaN, the result is NaN.
663
- - If _x_is less than 0, the result is NaN.
664
- - If _x_is +0 or -0, the result is -&#8734;.
665
- - If _x_is 1, the result is +0.
666
- - If _x_is +&#8734;, the result is +&#8734;.
667
-
668
-
669
- **Parameters:**
670
- - x - the Number to operate on.
671
-
672
- **Returns:**
673
- - an approximation to the base 2 logarithm of _x_.
674
-
675
- **API Version:**
676
- :::note
677
- Available from version 21.2.
678
- :::
679
-
680
- ---
681
-
682
- ### max(Number...)
683
- - static max(values: [Number...](TopLevel.Number.md)): [Number](TopLevel.Number.md)
684
- - : Returns the largest specified values. If no arguments are given, the result is -&#8734;. If any value is NaN, the
685
- result is NaN.
686
-
687
-
688
- **Parameters:**
689
- - values - zero or more values.
690
-
691
- **Returns:**
692
- - the largest of the specified values.
693
-
694
-
695
- ---
696
-
697
- ### min(Number...)
698
- - static min(values: [Number...](TopLevel.Number.md)): [Number](TopLevel.Number.md)
699
- - : Returns the smallest of the specified values. If no arguments are given, the result is +&#8734;. If any value is
700
- NaN, the result is NaN.
701
-
702
-
703
- **Parameters:**
704
- - values - zero or more values.
705
-
706
- **Returns:**
707
- - the smallest of the specified values.
708
-
709
-
710
- ---
711
-
712
- ### pow(Number, Number)
713
- - static pow(x: [Number](TopLevel.Number.md), y: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
714
- - : Returns an approximation to the result of raising _x_ to the power _y_.
715
-
716
- - If _y_is NaN, the result is NaN.
717
- - If _y_is +0, the result is 1, even if _x_is NaN.
718
- - If _y_is -0, the result is 1, even if _x_is NaN.
719
- - If _x_is NaN and _y_is nonzero, the result is NaN.
720
- - If abs(_x_)>1 and _y_is +&#8734;, the result is +&#8734;.
721
- - If abs(_x_)>1 and _y_is -&#8734;, the result is +0.
722
- - If abs(_x_)==1 and _y_is +&#8734;, the result is NaN.
723
- - If abs(_x_)==1 and _y_is -&#8734;, the result is NaN.
724
- - If abs(_x_)<1 and _y_is +&#8734;, the result is +0.
725
- - If abs(_x_)<1 and _y_is -&#8734;, the result is +&#8734;.
726
- - If _x_is +&#8734;and _y_>0, the result is +&#8734;.
727
- - If _x_is +&#8734;and _y_<0, the result is +0.
728
- - If _x_is -&#8734;and _y_>0 and _y_is an odd integer, the result is -&#8734;.
729
- - If _x_is -&#8734;and _y_>0 and _y_is not an odd integer, the result is +&#8734;.
730
- - If _x_is -&#8734;and _y_<0 and _y_is an odd integer, the result is -0.
731
- - If _x_is -&#8734;and _y_<0 and _y_is not an odd integer, the result is +0.
732
- - If _x_is +0 and _y_>0, the result is +0.
733
- - If _x_is +0 and _y_<0, the result is +&#8734;.
734
- - If _x_is -0 and _y_>0 and _y_is an odd integer, the result is -0.
735
- - If _x_is -0 and _y_>0 and _y_is not an odd integer, the result is +0.
736
- - If _x_is -0 and _y_<0 and _y_is an odd integer, the result is -&#8734;.
737
- - If _x_is -0 and _y_<0 and _y_is not an odd integer, the result is +&#8734;.
738
- - If _X_<0 and _x_is finite and _y_is finite and _y_is not an integer, the result is NaN.
739
-
740
-
741
- **Parameters:**
742
- - x - a Number that will be raised to the power of _y_.
743
- - y - the power by which _x_ will be raised.
744
-
745
- **Returns:**
746
- - an approximation to the result of raising _x_ to the power _y_.
747
-
748
-
749
- ---
750
-
751
- ### random()
752
- - static random(): [Number](TopLevel.Number.md)
753
- - : Returns a number value with positive sign, greater than or equal to 0 but less than 1, chosen randomly or pseudo
754
- randomly with approximately uniform distribution over that range, using an implementation-dependent algorithm or
755
- strategy.
756
-
757
-
758
- **Returns:**
759
- - a Number greater than or equal to 0 but less than 1.
760
-
761
-
762
- ---
763
-
764
- ### round(Number)
765
- - static round(x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
766
- - : Returns the number value that is closest to _x_ and is equal to a mathematical integer. If two integer
767
- number values are equally close to x, then the result is the number value that is closer to +&#8734;. If _x_
768
- is already an integer, the result is _x_.
769
-
770
- - If _x_is NaN, the result is NaN.
771
- - If _x_is +0, the result is +0.
772
- - If _x_is -0, the result is -0.
773
- - If _x_is +&#8734;, the result is +&#8734;.
774
- - If _x_is -&#8734;, the result is -&#8734;.
775
- - If _x_is greater than 0 but less than 0.5, the result is +0.
776
- - If _x_is less than 0 but greater than or equal to -0.5, the result is -0.
777
-
778
- Math.round(3.5) returns 4, but Math.round(-3.5) returns -3. The value of Math.round(_x_) is the same as the
779
- value of Math.floor(_x_+0.5), except when _x_ is -0 or is less than 0 but greater than or equal to
780
- -0.5; for these cases Math.round(_x_) returns -0, but Math.floor(_x_+0.5) returns +0.
781
-
782
-
783
- **Parameters:**
784
- - x - the Number to operate on.
785
-
786
- **Returns:**
787
- - the number value that is closest to _x_ and is equal to a mathematical integer.
788
-
789
-
790
- ---
791
-
792
- ### sign(Number)
793
- - static sign(x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
794
- - : Returns the sign of _x_, indicating whether _x_ is positive, negative, or zero.
795
-
796
- - If _x_is NaN, the result is NaN.
797
- - If _x_is -0, the result is -0.
798
- - If _x_is +0, the result is +0.
799
- - If _x_is negative and not -0, the result is -1.
800
- - If _x_is positive and not +0, the result is +1.
801
-
802
-
803
- **Parameters:**
804
- - x - the Number to operate on.
805
-
806
- **Returns:**
807
- - the sign of _x_.
808
-
809
- **API Version:**
810
- :::note
811
- Available from version 21.2.
812
- :::
813
-
814
- ---
815
-
816
- ### sin(Number)
817
- - static sin(x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
818
- - : Returns an approximation to the sine of _x_. The argument is expressed in radians.
819
-
820
- - If _x_is NaN, the result is NaN.
821
- - If _x_is +0, the result is +0.
822
- - If _x_is -0, the result is -0.
823
- - If _x_is +&#8734;or -&#8734;, the result is NaN.
824
-
825
-
826
- **Parameters:**
827
- - x - the Number to operate on.
828
-
829
- **Returns:**
830
- - an approximation to the sine of _x_.
831
-
832
-
833
- ---
834
-
835
- ### sinh(Number)
836
- - static sinh(x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
837
- - : Returns an approximation to the hyperbolic sine of _x_.
838
-
839
- - If _x_is NaN, the result is NaN.
840
- - If _x_is +0, the result is +0.
841
- - If _x_is -0, the result is -0.
842
- - If _x_is +&#8734;, the result is +&#8734;.
843
- - If _x_is -&#8734;, the result is +&#8734;.
844
-
845
-
846
- **Parameters:**
847
- - x - the Number to operate on.
848
-
849
- **Returns:**
850
- - an approximation to the hyperbolic sine of _x_.
851
-
852
- **API Version:**
853
- :::note
854
- Available from version 21.2.
855
- :::
856
-
857
- ---
858
-
859
- ### sqrt(Number)
860
- - static sqrt(x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
861
- - : Returns an approximation to the square root of _x_.
862
-
863
- - If _x_is NaN, the result is NaN.
864
- - If _x_isless than 0, the result is NaN.
865
- - If _x_is +0, the result is +0.
866
- - If _x_is -0, the result is -0.
867
- - If _x_is +&#8734;, the result is +&#8734;.
868
-
869
-
870
- **Parameters:**
871
- - x - the Number to operate on.
872
-
873
- **Returns:**
874
- - an approximation to the square root of _x_.
875
-
876
-
877
- ---
878
-
879
- ### tan(Number)
880
- - static tan(x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
881
- - : Returns an approximation to the tangent of _x_. The argument is expressed in radians.
882
-
883
- - If _x_is NaN, the result is NaN.
884
- - If _x_is +0, the result is +0.
885
- - If _x_is -0, the result is -0.
886
- - If _x_is +&#8734;or -&#8734;, the result is NaN.
887
-
888
-
889
- **Parameters:**
890
- - x - the Number to operate on.
891
-
892
- **Returns:**
893
- - an approximation to the tangent of _x_.
894
-
895
-
896
- ---
897
-
898
- ### tanh(Number)
899
- - static tanh(x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
900
- - : Returns an approximation to the hyperbolic tangent of _x_.
901
-
902
- - If _x_is NaN, the result is NaN.
903
- - If _x_is +0, the result is +0.
904
- - If _x_is -0, the result is -0.
905
- - If _x_is +&#8734;, the result is +1.
906
- - If _x_is -&#8734;, the result is -1.
907
-
908
-
909
- **Parameters:**
910
- - x - the Number to operate on.
911
-
912
- **Returns:**
913
- - an approximation to the hyperbolic tangent of _x_.
914
-
915
- **API Version:**
916
- :::note
917
- Available from version 21.2.
918
- :::
919
-
920
- ---
921
-
922
- ### trunc(Number)
923
- - static trunc(x: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
924
- - : Returns the integral part of the number _x_, removing any fractional digits. If _x_ is already an integer, the result is _x_.
925
-
926
- - If _x_is NaN, the result is NaN.
927
- - If _x_is -0, the result is -0.
928
- - If _x_is +0, the result is +0.
929
- - If _x_is -&#8734;, the result is -&#8734;.
930
- - If _x_is +&#8734;, the result is +&#8734;.
931
- - If _x_is greater than 0 but less than 1, the result is +0.
932
- - If _x_is less than 0 but greater than -1, the result is -0.
933
-
934
-
935
- **Parameters:**
936
- - x - the Number to operate on.
937
-
938
- **Returns:**
939
- - the integral part of the number of _x_.
940
-
941
- **API Version:**
942
- :::note
943
- Available from version 21.2.
944
- :::
945
-
946
- ---
947
-
948
- <!-- prettier-ignore-end -->