@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.
- package/data/guides/index.json +99 -2301
- package/data/help/index.json +9685 -0
- package/data/script-api/index.json +1 -528
- package/data/tooling/index.json +4 -4
- package/data/xsd/index.json +1 -1
- package/dist/esm/cli/base-command.js +5 -0
- package/dist/esm/cli/base-command.js.map +1 -1
- package/dist/esm/cli/oauth-command.js +6 -2
- package/dist/esm/cli/oauth-command.js.map +1 -1
- package/dist/esm/clients/index.d.ts +2 -0
- package/dist/esm/clients/index.js +1 -0
- package/dist/esm/clients/index.js.map +1 -1
- package/dist/esm/clients/middleware-registry.d.ts +1 -1
- package/dist/esm/clients/middleware-registry.js.map +1 -1
- package/dist/esm/clients/preferences.d.ts +83 -0
- package/dist/esm/clients/preferences.generated.d.ts +1651 -0
- package/dist/esm/clients/preferences.generated.js +6 -0
- package/dist/esm/clients/preferences.generated.js.map +1 -0
- package/dist/esm/clients/preferences.js +64 -0
- package/dist/esm/clients/preferences.js.map +1 -0
- package/dist/esm/config/dw-json.d.ts +2 -0
- package/dist/esm/config/dw-json.js.map +1 -1
- package/dist/esm/config/mapping.js +4 -0
- package/dist/esm/config/mapping.js.map +1 -1
- package/dist/esm/config/sources/dw-json-source.js +17 -4
- package/dist/esm/config/sources/dw-json-source.js.map +1 -1
- package/dist/esm/config/sources/env-source.js +2 -0
- package/dist/esm/config/sources/env-source.js.map +1 -1
- package/dist/esm/config/types.d.ts +14 -0
- package/dist/esm/discovery/patterns/storefront-next.js +6 -8
- package/dist/esm/discovery/patterns/storefront-next.js.map +1 -1
- package/dist/esm/docs/content-cache.d.ts +70 -0
- package/dist/esm/docs/content-cache.js +186 -0
- package/dist/esm/docs/content-cache.js.map +1 -0
- package/dist/esm/docs/index.d.ts +1 -0
- package/dist/esm/docs/index.js +2 -0
- package/dist/esm/docs/index.js.map +1 -1
- package/dist/esm/docs/search.js +34 -6
- package/dist/esm/docs/search.js.map +1 -1
- package/dist/esm/docs/types.d.ts +6 -1
- package/dist/esm/docs/types.js +1 -0
- package/dist/esm/docs/types.js.map +1 -1
- package/dist/esm/index.d.ts +2 -2
- package/dist/esm/index.js +1 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/operations/jobs/discover.d.ts +46 -0
- package/dist/esm/operations/jobs/discover.js +87 -0
- package/dist/esm/operations/jobs/discover.js.map +1 -0
- package/dist/esm/operations/jobs/index.d.ts +2 -0
- package/dist/esm/operations/jobs/index.js +2 -0
- package/dist/esm/operations/jobs/index.js.map +1 -1
- package/dist/esm/operations/jobs/run.js +4 -3
- package/dist/esm/operations/jobs/run.js.map +1 -1
- package/package.json +6 -3
- package/specs/preferences-v1.yaml +2095 -0
- package/data/script-api/TopLevel.APIException.md +0 -119
- package/data/script-api/TopLevel.Array.md +0 -732
- package/data/script-api/TopLevel.ArrayBuffer.md +0 -97
- package/data/script-api/TopLevel.BigInt.md +0 -154
- package/data/script-api/TopLevel.Boolean.md +0 -83
- package/data/script-api/TopLevel.ConversionError.md +0 -51
- package/data/script-api/TopLevel.DataView.md +0 -271
- package/data/script-api/TopLevel.Date.md +0 -688
- package/data/script-api/TopLevel.ES6Iterator.md +0 -47
- package/data/script-api/TopLevel.Error.md +0 -124
- package/data/script-api/TopLevel.EvalError.md +0 -47
- package/data/script-api/TopLevel.Fault.md +0 -133
- package/data/script-api/TopLevel.Float32Array.md +0 -186
- package/data/script-api/TopLevel.Float64Array.md +0 -186
- package/data/script-api/TopLevel.Function.md +0 -114
- package/data/script-api/TopLevel.Generator.md +0 -132
- package/data/script-api/TopLevel.IOError.md +0 -98
- package/data/script-api/TopLevel.Int16Array.md +0 -186
- package/data/script-api/TopLevel.Int32Array.md +0 -186
- package/data/script-api/TopLevel.Int8Array.md +0 -186
- package/data/script-api/TopLevel.InternalError.md +0 -47
- package/data/script-api/TopLevel.Iterable.md +0 -44
- package/data/script-api/TopLevel.Iterator.md +0 -89
- package/data/script-api/TopLevel.JSON.md +0 -173
- package/data/script-api/TopLevel.Map.md +0 -189
- package/data/script-api/TopLevel.Math.md +0 -948
- package/data/script-api/TopLevel.Module.md +0 -152
- package/data/script-api/TopLevel.Namespace.md +0 -152
- package/data/script-api/TopLevel.Number.md +0 -404
- package/data/script-api/TopLevel.Object.md +0 -472
- package/data/script-api/TopLevel.QName.md +0 -147
- package/data/script-api/TopLevel.RangeError.md +0 -47
- package/data/script-api/TopLevel.ReferenceError.md +0 -47
- package/data/script-api/TopLevel.RegExp.md +0 -155
- package/data/script-api/TopLevel.Set.md +0 -150
- package/data/script-api/TopLevel.StopIteration.md +0 -36
- package/data/script-api/TopLevel.String.md +0 -1060
- package/data/script-api/TopLevel.Symbol.md +0 -196
- package/data/script-api/TopLevel.SyntaxError.md +0 -47
- package/data/script-api/TopLevel.SystemError.md +0 -99
- package/data/script-api/TopLevel.TypeError.md +0 -47
- package/data/script-api/TopLevel.URIError.md +0 -47
- package/data/script-api/TopLevel.Uint16Array.md +0 -186
- package/data/script-api/TopLevel.Uint32Array.md +0 -186
- package/data/script-api/TopLevel.Uint8Array.md +0 -186
- package/data/script-api/TopLevel.Uint8ClampedArray.md +0 -186
- package/data/script-api/TopLevel.WeakMap.md +0 -135
- package/data/script-api/TopLevel.WeakSet.md +0 -96
- package/data/script-api/TopLevel.XML.md +0 -922
- package/data/script-api/TopLevel.XMLList.md +0 -418
- package/data/script-api/TopLevel.XMLStreamError.md +0 -115
- package/data/script-api/TopLevel.arguments.md +0 -56
- package/data/script-api/TopLevel.global.md +0 -539
- package/data/script-api/TopLevel.md +0 -58
- package/data/script-api/dw.alert.Alert.md +0 -175
- package/data/script-api/dw.alert.Alerts.md +0 -256
- package/data/script-api/dw.alert.md +0 -7
- package/data/script-api/dw.campaign.ABTest.md +0 -63
- package/data/script-api/dw.campaign.ABTestMgr.md +0 -76
- package/data/script-api/dw.campaign.ABTestSegment.md +0 -107
- package/data/script-api/dw.campaign.AmountDiscount.md +0 -70
- package/data/script-api/dw.campaign.ApproachingDiscount.md +0 -157
- package/data/script-api/dw.campaign.BonusChoiceDiscount.md +0 -190
- package/data/script-api/dw.campaign.BonusDiscount.md +0 -59
- package/data/script-api/dw.campaign.Campaign.md +0 -346
- package/data/script-api/dw.campaign.CampaignMgr.md +0 -436
- package/data/script-api/dw.campaign.CampaignStatusCodes.md +0 -103
- package/data/script-api/dw.campaign.Coupon.md +0 -324
- package/data/script-api/dw.campaign.CouponMgr.md +0 -137
- package/data/script-api/dw.campaign.CouponRedemption.md +0 -87
- package/data/script-api/dw.campaign.CouponStatusCodes.md +0 -130
- package/data/script-api/dw.campaign.Discount.md +0 -271
- package/data/script-api/dw.campaign.DiscountPlan.md +0 -322
- package/data/script-api/dw.campaign.FixedPriceDiscount.md +0 -74
- package/data/script-api/dw.campaign.FixedPriceShippingDiscount.md +0 -74
- package/data/script-api/dw.campaign.FreeDiscount.md +0 -24
- package/data/script-api/dw.campaign.FreeShippingDiscount.md +0 -24
- package/data/script-api/dw.campaign.PercentageDiscount.md +0 -74
- package/data/script-api/dw.campaign.PercentageOptionDiscount.md +0 -59
- package/data/script-api/dw.campaign.PriceBookPriceDiscount.md +0 -56
- package/data/script-api/dw.campaign.Promotion.md +0 -939
- package/data/script-api/dw.campaign.PromotionMgr.md +0 -478
- package/data/script-api/dw.campaign.PromotionPlan.md +0 -378
- package/data/script-api/dw.campaign.SlotContent.md +0 -131
- package/data/script-api/dw.campaign.SourceCodeGroup.md +0 -83
- package/data/script-api/dw.campaign.SourceCodeInfo.md +0 -167
- package/data/script-api/dw.campaign.SourceCodeStatusCodes.md +0 -61
- package/data/script-api/dw.campaign.TotalFixedPriceDiscount.md +0 -56
- package/data/script-api/dw.campaign.md +0 -36
- package/data/script-api/dw.catalog.Catalog.md +0 -158
- package/data/script-api/dw.catalog.CatalogMgr.md +0 -161
- package/data/script-api/dw.catalog.Category.md +0 -1212
- package/data/script-api/dw.catalog.CategoryAssignment.md +0 -179
- package/data/script-api/dw.catalog.CategoryLink.md +0 -142
- package/data/script-api/dw.catalog.PriceBook.md +0 -215
- package/data/script-api/dw.catalog.PriceBookMgr.md +0 -176
- package/data/script-api/dw.catalog.Product.md +0 -2492
- package/data/script-api/dw.catalog.ProductActiveData.md +0 -1244
- package/data/script-api/dw.catalog.ProductAttributeModel.md +0 -409
- package/data/script-api/dw.catalog.ProductAvailabilityLevels.md +0 -125
- package/data/script-api/dw.catalog.ProductAvailabilityModel.md +0 -516
- package/data/script-api/dw.catalog.ProductInventoryList.md +0 -136
- package/data/script-api/dw.catalog.ProductInventoryMgr.md +0 -132
- package/data/script-api/dw.catalog.ProductInventoryRecord.md +0 -638
- package/data/script-api/dw.catalog.ProductLink.md +0 -166
- package/data/script-api/dw.catalog.ProductMgr.md +0 -136
- package/data/script-api/dw.catalog.ProductOption.md +0 -189
- package/data/script-api/dw.catalog.ProductOptionModel.md +0 -209
- package/data/script-api/dw.catalog.ProductOptionValue.md +0 -132
- package/data/script-api/dw.catalog.ProductPriceInfo.md +0 -170
- package/data/script-api/dw.catalog.ProductPriceModel.md +0 -988
- package/data/script-api/dw.catalog.ProductPriceTable.md +0 -121
- package/data/script-api/dw.catalog.ProductSearchHit.md +0 -702
- package/data/script-api/dw.catalog.ProductSearchModel.md +0 -1894
- package/data/script-api/dw.catalog.ProductSearchRefinementDefinition.md +0 -99
- package/data/script-api/dw.catalog.ProductSearchRefinementValue.md +0 -80
- package/data/script-api/dw.catalog.ProductSearchRefinements.md +0 -265
- package/data/script-api/dw.catalog.ProductVariationAttribute.md +0 -107
- package/data/script-api/dw.catalog.ProductVariationAttributeValue.md +0 -215
- package/data/script-api/dw.catalog.ProductVariationModel.md +0 -1010
- package/data/script-api/dw.catalog.Recommendation.md +0 -327
- package/data/script-api/dw.catalog.SearchModel.md +0 -769
- package/data/script-api/dw.catalog.SearchRefinementDefinition.md +0 -145
- package/data/script-api/dw.catalog.SearchRefinementValue.md +0 -194
- package/data/script-api/dw.catalog.SearchRefinements.md +0 -238
- package/data/script-api/dw.catalog.SortingOption.md +0 -120
- package/data/script-api/dw.catalog.SortingRule.md +0 -53
- package/data/script-api/dw.catalog.Store.md +0 -484
- package/data/script-api/dw.catalog.StoreGroup.md +0 -95
- package/data/script-api/dw.catalog.StoreInventoryFilter.md +0 -112
- package/data/script-api/dw.catalog.StoreInventoryFilterValue.md +0 -111
- package/data/script-api/dw.catalog.StoreMgr.md +0 -223
- package/data/script-api/dw.catalog.Variant.md +0 -1000
- package/data/script-api/dw.catalog.VariationGroup.md +0 -869
- package/data/script-api/dw.catalog.md +0 -50
- package/data/script-api/dw.content.Content.md +0 -481
- package/data/script-api/dw.content.ContentMgr.md +0 -147
- package/data/script-api/dw.content.ContentSearchModel.md +0 -618
- package/data/script-api/dw.content.ContentSearchRefinementDefinition.md +0 -61
- package/data/script-api/dw.content.ContentSearchRefinementValue.md +0 -22
- package/data/script-api/dw.content.ContentSearchRefinements.md +0 -218
- package/data/script-api/dw.content.Folder.md +0 -432
- package/data/script-api/dw.content.Library.md +0 -124
- package/data/script-api/dw.content.MarkupText.md +0 -150
- package/data/script-api/dw.content.MediaFile.md +0 -367
- package/data/script-api/dw.content.md +0 -15
- package/data/script-api/dw.crypto.CertificateRef.md +0 -59
- package/data/script-api/dw.crypto.CertificateUtils.md +0 -162
- package/data/script-api/dw.crypto.Cipher.md +0 -1234
- package/data/script-api/dw.crypto.Encoding.md +0 -193
- package/data/script-api/dw.crypto.JWE.md +0 -245
- package/data/script-api/dw.crypto.JWEHeader.md +0 -147
- package/data/script-api/dw.crypto.JWS.md +0 -260
- package/data/script-api/dw.crypto.JWSHeader.md +0 -128
- package/data/script-api/dw.crypto.KeyRef.md +0 -77
- package/data/script-api/dw.crypto.Mac.md +0 -191
- package/data/script-api/dw.crypto.MessageDigest.md +0 -243
- package/data/script-api/dw.crypto.SecureRandom.md +0 -161
- package/data/script-api/dw.crypto.Signature.md +0 -241
- package/data/script-api/dw.crypto.WeakCipher.md +0 -725
- package/data/script-api/dw.crypto.WeakMac.md +0 -163
- package/data/script-api/dw.crypto.WeakMessageDigest.md +0 -220
- package/data/script-api/dw.crypto.WeakSignature.md +0 -208
- package/data/script-api/dw.crypto.X509Certificate.md +0 -180
- package/data/script-api/dw.crypto.md +0 -23
- package/data/script-api/dw.customer.AddressBook.md +0 -158
- package/data/script-api/dw.customer.AgentUserMgr.md +0 -94
- package/data/script-api/dw.customer.AgentUserStatusCodes.md +0 -164
- package/data/script-api/dw.customer.AuthenticationStatus.md +0 -157
- package/data/script-api/dw.customer.Credentials.md +0 -524
- package/data/script-api/dw.customer.Customer.md +0 -488
- package/data/script-api/dw.customer.CustomerActiveData.md +0 -563
- package/data/script-api/dw.customer.CustomerAddress.md +0 -666
- package/data/script-api/dw.customer.CustomerCDPData.md +0 -70
- package/data/script-api/dw.customer.CustomerContextMgr.md +0 -62
- package/data/script-api/dw.customer.CustomerGroup.md +0 -146
- package/data/script-api/dw.customer.CustomerList.md +0 -76
- package/data/script-api/dw.customer.CustomerMgr.md +0 -1046
- package/data/script-api/dw.customer.CustomerPasswordConstraints.md +0 -125
- package/data/script-api/dw.customer.CustomerPaymentInstrument.md +0 -161
- package/data/script-api/dw.customer.CustomerStatusCodes.md +0 -55
- package/data/script-api/dw.customer.EncryptedObject.md +0 -34
- package/data/script-api/dw.customer.ExternalProfile.md +0 -154
- package/data/script-api/dw.customer.OrderHistory.md +0 -167
- package/data/script-api/dw.customer.ProductList.md +0 -870
- package/data/script-api/dw.customer.ProductListItem.md +0 -469
- package/data/script-api/dw.customer.ProductListItemPurchase.md +0 -139
- package/data/script-api/dw.customer.ProductListMgr.md +0 -350
- package/data/script-api/dw.customer.ProductListRegistrant.md +0 -165
- package/data/script-api/dw.customer.Profile.md +0 -940
- package/data/script-api/dw.customer.Wallet.md +0 -136
- package/data/script-api/dw.customer.consent.ConsentStatusEntry.md +0 -92
- package/data/script-api/dw.customer.consent.MarketingConsentSubscription.md +0 -247
- package/data/script-api/dw.customer.consent.ShopperConsentErrorCodes.md +0 -74
- package/data/script-api/dw.customer.consent.ShopperConsentException.md +0 -63
- package/data/script-api/dw.customer.consent.ShopperConsentMgr.md +0 -152
- package/data/script-api/dw.customer.consent.md +0 -10
- package/data/script-api/dw.customer.md +0 -31
- package/data/script-api/dw.customer.oauth.OAuthAccessTokenResponse.md +0 -171
- package/data/script-api/dw.customer.oauth.OAuthFinalizedResponse.md +0 -75
- package/data/script-api/dw.customer.oauth.OAuthLoginFlowMgr.md +0 -165
- package/data/script-api/dw.customer.oauth.OAuthUserInfoResponse.md +0 -84
- package/data/script-api/dw.customer.oauth.md +0 -9
- package/data/script-api/dw.customer.shoppercontext.ShopperContext.md +0 -369
- package/data/script-api/dw.customer.shoppercontext.ShopperContextErrorCodes.md +0 -111
- package/data/script-api/dw.customer.shoppercontext.ShopperContextException.md +0 -77
- package/data/script-api/dw.customer.shoppercontext.ShopperContextMgr.md +0 -209
- package/data/script-api/dw.customer.shoppercontext.md +0 -9
- package/data/script-api/dw.experience.AspectAttributeValidationException.md +0 -25
- package/data/script-api/dw.experience.Component.md +0 -166
- package/data/script-api/dw.experience.ComponentRenderSettings.md +0 -130
- package/data/script-api/dw.experience.ComponentScriptContext.md +0 -148
- package/data/script-api/dw.experience.CustomEditor.md +0 -146
- package/data/script-api/dw.experience.CustomEditorResources.md +0 -100
- package/data/script-api/dw.experience.Page.md +0 -467
- package/data/script-api/dw.experience.PageMgr.md +0 -549
- package/data/script-api/dw.experience.PageScriptContext.md +0 -200
- package/data/script-api/dw.experience.Region.md +0 -119
- package/data/script-api/dw.experience.RegionRenderSettings.md +0 -207
- package/data/script-api/dw.experience.cms.CMSRecord.md +0 -125
- package/data/script-api/dw.experience.cms.md +0 -6
- package/data/script-api/dw.experience.image.FocalPoint.md +0 -71
- package/data/script-api/dw.experience.image.Image.md +0 -101
- package/data/script-api/dw.experience.image.ImageMetaData.md +0 -71
- package/data/script-api/dw.experience.image.md +0 -8
- package/data/script-api/dw.experience.md +0 -16
- package/data/script-api/dw.extensions.applepay.ApplePayHookResult.md +0 -254
- package/data/script-api/dw.extensions.applepay.ApplePayHooks.md +0 -572
- package/data/script-api/dw.extensions.applepay.md +0 -7
- package/data/script-api/dw.extensions.facebook.FacebookFeedHooks.md +0 -102
- package/data/script-api/dw.extensions.facebook.FacebookProduct.md +0 -1343
- package/data/script-api/dw.extensions.facebook.md +0 -7
- package/data/script-api/dw.extensions.paymentapi.PaymentApiHooks.md +0 -136
- package/data/script-api/dw.extensions.paymentapi.md +0 -6
- package/data/script-api/dw.extensions.paymentrequest.PaymentRequestHookResult.md +0 -149
- package/data/script-api/dw.extensions.paymentrequest.PaymentRequestHooks.md +0 -356
- package/data/script-api/dw.extensions.paymentrequest.md +0 -7
- package/data/script-api/dw.extensions.payments.SalesforceAdyenPaymentIntent.md +0 -134
- package/data/script-api/dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.md +0 -283
- package/data/script-api/dw.extensions.payments.SalesforceBancontactPaymentDetails.md +0 -88
- package/data/script-api/dw.extensions.payments.SalesforceCardPaymentDetails.md +0 -107
- package/data/script-api/dw.extensions.payments.SalesforceEpsPaymentDetails.md +0 -63
- package/data/script-api/dw.extensions.payments.SalesforceIdealPaymentDetails.md +0 -63
- package/data/script-api/dw.extensions.payments.SalesforceKlarnaPaymentDetails.md +0 -63
- package/data/script-api/dw.extensions.payments.SalesforcePayPalOrder.md +0 -263
- package/data/script-api/dw.extensions.payments.SalesforcePayPalOrderAddress.md +0 -171
- package/data/script-api/dw.extensions.payments.SalesforcePayPalOrderPayer.md +0 -110
- package/data/script-api/dw.extensions.payments.SalesforcePayPalPaymentDetails.md +0 -88
- package/data/script-api/dw.extensions.payments.SalesforcePaymentDetails.md +0 -83
- package/data/script-api/dw.extensions.payments.SalesforcePaymentIntent.md +0 -273
- package/data/script-api/dw.extensions.payments.SalesforcePaymentMethod.md +0 -368
- package/data/script-api/dw.extensions.payments.SalesforcePaymentRequest.md +0 -1077
- package/data/script-api/dw.extensions.payments.SalesforcePaymentsHooks.md +0 -190
- package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccount.md +0 -151
- package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.md +0 -98
- package/data/script-api/dw.extensions.payments.SalesforcePaymentsMgr.md +0 -989
- package/data/script-api/dw.extensions.payments.SalesforcePaymentsSiteConfiguration.md +0 -202
- package/data/script-api/dw.extensions.payments.SalesforcePaymentsZone.md +0 -393
- package/data/script-api/dw.extensions.payments.SalesforceSepaDebitPaymentDetails.md +0 -63
- package/data/script-api/dw.extensions.payments.SalesforceVenmoPaymentDetails.md +0 -88
- package/data/script-api/dw.extensions.payments.md +0 -28
- package/data/script-api/dw.extensions.pinterest.PinterestAvailability.md +0 -85
- package/data/script-api/dw.extensions.pinterest.PinterestFeedHooks.md +0 -118
- package/data/script-api/dw.extensions.pinterest.PinterestOrder.md +0 -263
- package/data/script-api/dw.extensions.pinterest.PinterestOrderHooks.md +0 -89
- package/data/script-api/dw.extensions.pinterest.PinterestProduct.md +0 -677
- package/data/script-api/dw.extensions.pinterest.md +0 -10
- package/data/script-api/dw.io.CSVStreamReader.md +0 -128
- package/data/script-api/dw.io.CSVStreamWriter.md +0 -92
- package/data/script-api/dw.io.File.md +0 -729
- package/data/script-api/dw.io.FileReader.md +0 -70
- package/data/script-api/dw.io.FileWriter.md +0 -159
- package/data/script-api/dw.io.InputStream.md +0 -35
- package/data/script-api/dw.io.OutputStream.md +0 -38
- package/data/script-api/dw.io.PrintWriter.md +0 -66
- package/data/script-api/dw.io.RandomAccessFileReader.md +0 -183
- package/data/script-api/dw.io.Reader.md +0 -284
- package/data/script-api/dw.io.StringWriter.md +0 -89
- package/data/script-api/dw.io.Writer.md +0 -96
- package/data/script-api/dw.io.XMLIndentingStreamWriter.md +0 -121
- package/data/script-api/dw.io.XMLStreamConstants.md +0 -172
- package/data/script-api/dw.io.XMLStreamReader.md +0 -1181
- package/data/script-api/dw.io.XMLStreamWriter.md +0 -478
- package/data/script-api/dw.io.md +0 -21
- package/data/script-api/dw.job.JobExecution.md +0 -111
- package/data/script-api/dw.job.JobStepExecution.md +0 -136
- package/data/script-api/dw.job.md +0 -7
- package/data/script-api/dw.net.FTPClient.md +0 -621
- package/data/script-api/dw.net.FTPFileInfo.md +0 -132
- package/data/script-api/dw.net.HTTPClient.md +0 -775
- package/data/script-api/dw.net.HTTPClientLoggingConfig.md +0 -363
- package/data/script-api/dw.net.HTTPRequestPart.md +0 -296
- package/data/script-api/dw.net.Mail.md +0 -487
- package/data/script-api/dw.net.SFTPClient.md +0 -535
- package/data/script-api/dw.net.SFTPFileInfo.md +0 -128
- package/data/script-api/dw.net.WebDAVClient.md +0 -762
- package/data/script-api/dw.net.WebDAVFileInfo.md +0 -163
- package/data/script-api/dw.net.md +0 -15
- package/data/script-api/dw.object.ActiveData.md +0 -86
- package/data/script-api/dw.object.CustomAttributes.md +0 -165
- package/data/script-api/dw.object.CustomObject.md +0 -82
- package/data/script-api/dw.object.CustomObjectMgr.md +0 -478
- package/data/script-api/dw.object.Extensible.md +0 -71
- package/data/script-api/dw.object.ExtensibleObject.md +0 -85
- package/data/script-api/dw.object.Note.md +0 -118
- package/data/script-api/dw.object.ObjectAttributeDefinition.md +0 -542
- package/data/script-api/dw.object.ObjectAttributeGroup.md +0 -160
- package/data/script-api/dw.object.ObjectAttributeValueDefinition.md +0 -78
- package/data/script-api/dw.object.ObjectTypeDefinition.md +0 -239
- package/data/script-api/dw.object.PersistentObject.md +0 -92
- package/data/script-api/dw.object.SimpleExtensible.md +0 -53
- package/data/script-api/dw.object.SystemObjectMgr.md +0 -520
- package/data/script-api/dw.object.md +0 -19
- package/data/script-api/dw.order.AbstractItem.md +0 -220
- package/data/script-api/dw.order.AbstractItemCtnr.md +0 -219
- package/data/script-api/dw.order.Appeasement.md +0 -398
- package/data/script-api/dw.order.AppeasementItem.md +0 -104
- package/data/script-api/dw.order.Basket.md +0 -868
- package/data/script-api/dw.order.BasketMgr.md +0 -673
- package/data/script-api/dw.order.BonusDiscountLineItem.md +0 -309
- package/data/script-api/dw.order.CouponLineItem.md +0 -289
- package/data/script-api/dw.order.CreateAgentBasketLimitExceededException.md +0 -35
- package/data/script-api/dw.order.CreateBasketFromOrderException.md +0 -54
- package/data/script-api/dw.order.CreateCouponLineItemException.md +0 -67
- package/data/script-api/dw.order.CreateOrderException.md +0 -23
- package/data/script-api/dw.order.CreateTemporaryBasketLimitExceededException.md +0 -35
- package/data/script-api/dw.order.GiftCertificate.md +0 -530
- package/data/script-api/dw.order.GiftCertificateLineItem.md +0 -292
- package/data/script-api/dw.order.GiftCertificateMgr.md +0 -228
- package/data/script-api/dw.order.GiftCertificateStatusCodes.md +0 -108
- package/data/script-api/dw.order.Invoice.md +0 -571
- package/data/script-api/dw.order.InvoiceItem.md +0 -199
- package/data/script-api/dw.order.LineItem.md +0 -577
- package/data/script-api/dw.order.LineItemCtnr.md +0 -2429
- package/data/script-api/dw.order.LineItemTax.md +0 -142
- package/data/script-api/dw.order.Order.md +0 -2770
- package/data/script-api/dw.order.OrderAddress.md +0 -624
- package/data/script-api/dw.order.OrderItem.md +0 -613
- package/data/script-api/dw.order.OrderMgr.md +0 -1502
- package/data/script-api/dw.order.OrderPaymentInstrument.md +0 -231
- package/data/script-api/dw.order.OrderProcessStatusCodes.md +0 -146
- package/data/script-api/dw.order.PaymentCard.md +0 -220
- package/data/script-api/dw.order.PaymentInstrument.md +0 -1416
- package/data/script-api/dw.order.PaymentMethod.md +0 -257
- package/data/script-api/dw.order.PaymentMgr.md +0 -138
- package/data/script-api/dw.order.PaymentProcessor.md +0 -106
- package/data/script-api/dw.order.PaymentStatusCodes.md +0 -70
- package/data/script-api/dw.order.PaymentTransaction.md +0 -291
- package/data/script-api/dw.order.PriceAdjustment.md +0 -745
- package/data/script-api/dw.order.PriceAdjustmentLimitTypes.md +0 -61
- package/data/script-api/dw.order.ProductLineItem.md +0 -1749
- package/data/script-api/dw.order.ProductShippingCost.md +0 -101
- package/data/script-api/dw.order.ProductShippingLineItem.md +0 -336
- package/data/script-api/dw.order.ProductShippingModel.md +0 -143
- package/data/script-api/dw.order.Return.md +0 -396
- package/data/script-api/dw.order.ReturnCase.md +0 -463
- package/data/script-api/dw.order.ReturnCaseItem.md +0 -372
- package/data/script-api/dw.order.ReturnItem.md +0 -335
- package/data/script-api/dw.order.Shipment.md +0 -1132
- package/data/script-api/dw.order.ShipmentShippingCost.md +0 -54
- package/data/script-api/dw.order.ShipmentShippingModel.md +0 -203
- package/data/script-api/dw.order.ShippingLineItem.md +0 -315
- package/data/script-api/dw.order.ShippingLocation.md +0 -313
- package/data/script-api/dw.order.ShippingMethod.md +0 -251
- package/data/script-api/dw.order.ShippingMgr.md +0 -173
- package/data/script-api/dw.order.ShippingOrder.md +0 -630
- package/data/script-api/dw.order.ShippingOrderItem.md +0 -425
- package/data/script-api/dw.order.SumItem.md +0 -158
- package/data/script-api/dw.order.TaxGroup.md +0 -128
- package/data/script-api/dw.order.TaxItem.md +0 -74
- package/data/script-api/dw.order.TaxMgr.md +0 -314
- package/data/script-api/dw.order.TrackingInfo.md +0 -261
- package/data/script-api/dw.order.TrackingRef.md +0 -108
- package/data/script-api/dw.order.hooks.BasketMergeHooks.md +0 -87
- package/data/script-api/dw.order.hooks.CalculateHooks.md +0 -139
- package/data/script-api/dw.order.hooks.CheckoutHooks.md +0 -88
- package/data/script-api/dw.order.hooks.OrderHooks.md +0 -96
- package/data/script-api/dw.order.hooks.PaymentHooks.md +0 -325
- package/data/script-api/dw.order.hooks.ReturnHooks.md +0 -395
- package/data/script-api/dw.order.hooks.ShippingOrderHooks.md +0 -426
- package/data/script-api/dw.order.hooks.TaxHooks.md +0 -495
- package/data/script-api/dw.order.hooks.md +0 -13
- package/data/script-api/dw.order.md +0 -65
- package/data/script-api/dw.rpc.SOAPUtil.md +0 -736
- package/data/script-api/dw.rpc.Stub.md +0 -373
- package/data/script-api/dw.rpc.WebReference.md +0 -133
- package/data/script-api/dw.rpc.md +0 -8
- package/data/script-api/dw.sitemap.SitemapFile.md +0 -137
- package/data/script-api/dw.sitemap.SitemapMgr.md +0 -165
- package/data/script-api/dw.sitemap.md +0 -7
- package/data/script-api/dw.suggest.BrandSuggestions.md +0 -34
- package/data/script-api/dw.suggest.CategorySuggestions.md +0 -76
- package/data/script-api/dw.suggest.ContentSuggestions.md +0 -76
- package/data/script-api/dw.suggest.CustomSuggestions.md +0 -34
- package/data/script-api/dw.suggest.ProductSuggestions.md +0 -76
- package/data/script-api/dw.suggest.SearchPhraseSuggestions.md +0 -126
- package/data/script-api/dw.suggest.SuggestModel.md +0 -471
- package/data/script-api/dw.suggest.SuggestedCategory.md +0 -51
- package/data/script-api/dw.suggest.SuggestedContent.md +0 -51
- package/data/script-api/dw.suggest.SuggestedPhrase.md +0 -70
- package/data/script-api/dw.suggest.SuggestedProduct.md +0 -55
- package/data/script-api/dw.suggest.SuggestedTerm.md +0 -143
- package/data/script-api/dw.suggest.SuggestedTerms.md +0 -144
- package/data/script-api/dw.suggest.Suggestions.md +0 -206
- package/data/script-api/dw.suggest.md +0 -19
- package/data/script-api/dw.svc.FTPService.md +0 -140
- package/data/script-api/dw.svc.FTPServiceDefinition.md +0 -97
- package/data/script-api/dw.svc.HTTPFormService.md +0 -32
- package/data/script-api/dw.svc.HTTPFormServiceDefinition.md +0 -36
- package/data/script-api/dw.svc.HTTPService.md +0 -370
- package/data/script-api/dw.svc.HTTPServiceDefinition.md +0 -290
- package/data/script-api/dw.svc.LocalServiceRegistry.md +0 -63
- package/data/script-api/dw.svc.Result.md +0 -320
- package/data/script-api/dw.svc.SOAPService.md +0 -104
- package/data/script-api/dw.svc.SOAPServiceDefinition.md +0 -32
- package/data/script-api/dw.svc.Service.md +0 -276
- package/data/script-api/dw.svc.ServiceCallback.md +0 -282
- package/data/script-api/dw.svc.ServiceConfig.md +0 -114
- package/data/script-api/dw.svc.ServiceCredential.md +0 -162
- package/data/script-api/dw.svc.ServiceDefinition.md +0 -211
- package/data/script-api/dw.svc.ServiceProfile.md +0 -152
- package/data/script-api/dw.svc.ServiceRegistry.md +0 -118
- package/data/script-api/dw.svc.md +0 -22
- package/data/script-api/dw.system.AgentUserStatusCodes.md +0 -41
- package/data/script-api/dw.system.Cache.md +0 -126
- package/data/script-api/dw.system.CacheMgr.md +0 -70
- package/data/script-api/dw.system.HookMgr.md +0 -78
- package/data/script-api/dw.system.InternalObject.md +0 -47
- package/data/script-api/dw.system.JobProcessMonitor.md +0 -103
- package/data/script-api/dw.system.Log.md +0 -198
- package/data/script-api/dw.system.LogNDC.md +0 -75
- package/data/script-api/dw.system.Logger.md +0 -216
- package/data/script-api/dw.system.OrganizationPreferences.md +0 -53
- package/data/script-api/dw.system.Pipeline.md +0 -94
- package/data/script-api/dw.system.PipelineDictionary.md +0 -42
- package/data/script-api/dw.system.RESTErrorResponse.md +0 -102
- package/data/script-api/dw.system.RESTResponseMgr.md +0 -243
- package/data/script-api/dw.system.RESTSuccessResponse.md +0 -62
- package/data/script-api/dw.system.RemoteInclude.md +0 -146
- package/data/script-api/dw.system.Request.md +0 -785
- package/data/script-api/dw.system.RequestHooks.md +0 -112
- package/data/script-api/dw.system.Response.md +0 -612
- package/data/script-api/dw.system.SearchStatus.md +0 -187
- package/data/script-api/dw.system.Session.md +0 -469
- package/data/script-api/dw.system.Site.md +0 -570
- package/data/script-api/dw.system.SitePreferences.md +0 -90
- package/data/script-api/dw.system.Status.md +0 -330
- package/data/script-api/dw.system.StatusItem.md +0 -273
- package/data/script-api/dw.system.System.md +0 -224
- package/data/script-api/dw.system.Transaction.md +0 -107
- package/data/script-api/dw.system.md +0 -32
- package/data/script-api/dw.template.ISML.md +0 -127
- package/data/script-api/dw.template.Velocity.md +0 -168
- package/data/script-api/dw.template.md +0 -7
- package/data/script-api/dw.util.ArrayList.md +0 -99
- package/data/script-api/dw.util.Assert.md +0 -370
- package/data/script-api/dw.util.BigInteger.md +0 -283
- package/data/script-api/dw.util.Bytes.md +0 -278
- package/data/script-api/dw.util.Calendar.md +0 -1051
- package/data/script-api/dw.util.Collection.md +0 -272
- package/data/script-api/dw.util.Currency.md +0 -147
- package/data/script-api/dw.util.DateUtils.md +0 -82
- package/data/script-api/dw.util.Decimal.md +0 -386
- package/data/script-api/dw.util.FilteringCollection.md +0 -140
- package/data/script-api/dw.util.Geolocation.md +0 -293
- package/data/script-api/dw.util.HashMap.md +0 -50
- package/data/script-api/dw.util.HashSet.md +0 -65
- package/data/script-api/dw.util.Iterator.md +0 -86
- package/data/script-api/dw.util.LinkedHashMap.md +0 -52
- package/data/script-api/dw.util.LinkedHashSet.md +0 -68
- package/data/script-api/dw.util.List.md +0 -429
- package/data/script-api/dw.util.Locale.md +0 -277
- package/data/script-api/dw.util.Map.md +0 -251
- package/data/script-api/dw.util.MapEntry.md +0 -68
- package/data/script-api/dw.util.MappingKey.md +0 -96
- package/data/script-api/dw.util.MappingMgr.md +0 -113
- package/data/script-api/dw.util.PropertyComparator.md +0 -122
- package/data/script-api/dw.util.SecureEncoder.md +0 -582
- package/data/script-api/dw.util.SecureFilter.md +0 -572
- package/data/script-api/dw.util.SeekableIterator.md +0 -187
- package/data/script-api/dw.util.Set.md +0 -39
- package/data/script-api/dw.util.SortedMap.md +0 -148
- package/data/script-api/dw.util.SortedSet.md +0 -173
- package/data/script-api/dw.util.StringUtils.md +0 -655
- package/data/script-api/dw.util.Template.md +0 -141
- package/data/script-api/dw.util.UUIDUtils.md +0 -34
- package/data/script-api/dw.util.md +0 -37
- package/data/script-api/dw.value.EnumValue.md +0 -105
- package/data/script-api/dw.value.MimeEncodedText.md +0 -131
- package/data/script-api/dw.value.Money.md +0 -526
- package/data/script-api/dw.value.Quantity.md +0 -299
- package/data/script-api/dw.value.md +0 -9
- package/data/script-api/dw.web.CSRFProtection.md +0 -105
- package/data/script-api/dw.web.ClickStream.md +0 -177
- package/data/script-api/dw.web.ClickStreamEntry.md +0 -255
- package/data/script-api/dw.web.Cookie.md +0 -431
- package/data/script-api/dw.web.Cookies.md +0 -59
- package/data/script-api/dw.web.Form.md +0 -84
- package/data/script-api/dw.web.FormAction.md +0 -195
- package/data/script-api/dw.web.FormElement.md +0 -211
- package/data/script-api/dw.web.FormElementValidationResult.md +0 -170
- package/data/script-api/dw.web.FormField.md +0 -642
- package/data/script-api/dw.web.FormFieldOption.md +0 -211
- package/data/script-api/dw.web.FormFieldOptions.md +0 -49
- package/data/script-api/dw.web.FormGroup.md +0 -222
- package/data/script-api/dw.web.FormList.md +0 -134
- package/data/script-api/dw.web.FormListItem.md +0 -57
- package/data/script-api/dw.web.Forms.md +0 -25
- package/data/script-api/dw.web.HttpParameter.md +0 -462
- package/data/script-api/dw.web.HttpParameterMap.md +0 -194
- package/data/script-api/dw.web.LoopIterator.md +0 -231
- package/data/script-api/dw.web.PageMetaData.md +0 -197
- package/data/script-api/dw.web.PageMetaTag.md +0 -173
- package/data/script-api/dw.web.PagingModel.md +0 -407
- package/data/script-api/dw.web.Resource.md +0 -147
- package/data/script-api/dw.web.URL.md +0 -174
- package/data/script-api/dw.web.URLAction.md +0 -95
- package/data/script-api/dw.web.URLParameter.md +0 -52
- package/data/script-api/dw.web.URLRedirect.md +0 -72
- package/data/script-api/dw.web.URLRedirectMgr.md +0 -86
- package/data/script-api/dw.web.URLUtils.md +0 -1357
- package/data/script-api/dw.web.md +0 -34
- package/data/script-api/dw.ws.Port.md +0 -126
- package/data/script-api/dw.ws.WSUtil.md +0 -728
- package/data/script-api/dw.ws.WebReference2.md +0 -137
- package/data/script-api/dw.ws.md +0 -8
- package/data/script-api/index.md +0 -40
|
@@ -1,186 +0,0 @@
|
|
|
1
|
-
<!-- prettier-ignore-start -->
|
|
2
|
-
# Class Uint32Array
|
|
3
|
-
|
|
4
|
-
- [TopLevel.Object](TopLevel.Object.md)
|
|
5
|
-
- [TopLevel.Uint32Array](TopLevel.Uint32Array.md)
|
|
6
|
-
|
|
7
|
-
An optimized array to store 32-bit unsigned integer numbers. Elements of this array are stored in an
|
|
8
|
-
[ArrayBuffer](TopLevel.ArrayBuffer.md) object.
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
**API Version:**
|
|
12
|
-
:::note
|
|
13
|
-
Available from version 21.2.
|
|
14
|
-
:::
|
|
15
|
-
|
|
16
|
-
## Constant Summary
|
|
17
|
-
|
|
18
|
-
| Constant | Description |
|
|
19
|
-
| --- | --- |
|
|
20
|
-
| [BYTES_PER_ELEMENT](#bytes_per_element): [Number](TopLevel.Number.md) = 4 | Number value of the element size. |
|
|
21
|
-
|
|
22
|
-
## Property Summary
|
|
23
|
-
|
|
24
|
-
| Property | Description |
|
|
25
|
-
| --- | --- |
|
|
26
|
-
| [buffer](#buffer): [ArrayBuffer](TopLevel.ArrayBuffer.md) | The array buffer referenced by this typed array. |
|
|
27
|
-
| [byteLength](#bytelength): [Number](TopLevel.Number.md) | The number of bytes in the array buffer used by this typed array. |
|
|
28
|
-
| [byteOffset](#byteoffset): [Number](TopLevel.Number.md) | The start offset for this typed array within the array buffer. |
|
|
29
|
-
| [length](#length): [Number](TopLevel.Number.md) | The number of elements. |
|
|
30
|
-
|
|
31
|
-
## Constructor Summary
|
|
32
|
-
|
|
33
|
-
| Constructor | Description |
|
|
34
|
-
| --- | --- |
|
|
35
|
-
| [Uint32Array](#uint32array)() | Creates an empty array. |
|
|
36
|
-
| [Uint32Array](#uint32arraynumber)([Number](TopLevel.Number.md)) | Creates an array with the given element count. |
|
|
37
|
-
| [Uint32Array](#uint32arrayobject)([Object](TopLevel.Object.md)) | Creates an array as a copy of the passed typed array. |
|
|
38
|
-
| [Uint32Array](#uint32arrayarray)([Array](TopLevel.Array.md)) | Creates an array as a copy of the passed array. |
|
|
39
|
-
| [Uint32Array](#uint32arrayarraybuffer-number-number)([ArrayBuffer](TopLevel.ArrayBuffer.md), [Number](TopLevel.Number.md), [Number](TopLevel.Number.md)) | Creates a typed array as a view on the given [ArrayBuffer](TopLevel.ArrayBuffer.md). |
|
|
40
|
-
|
|
41
|
-
## Method Summary
|
|
42
|
-
|
|
43
|
-
| Method | Description |
|
|
44
|
-
| --- | --- |
|
|
45
|
-
| [get](TopLevel.Uint32Array.md#getnumber)([Number](TopLevel.Number.md)) | Returns the value at the specified index. |
|
|
46
|
-
| [set](TopLevel.Uint32Array.md#setobject-number)([Object](TopLevel.Object.md), [Number](TopLevel.Number.md)) | Copies all values from the source array into this typed array. |
|
|
47
|
-
| [subarray](TopLevel.Uint32Array.md#subarraynumber-number)([Number](TopLevel.Number.md), [Number](TopLevel.Number.md)) | Returns a new array object based on the same [ArrayBuffer](TopLevel.ArrayBuffer.md) store. |
|
|
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
|
-
## Constant Details
|
|
53
|
-
|
|
54
|
-
### BYTES_PER_ELEMENT
|
|
55
|
-
|
|
56
|
-
- BYTES_PER_ELEMENT: [Number](TopLevel.Number.md) = 4
|
|
57
|
-
- : Number value of the element size.
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
---
|
|
61
|
-
|
|
62
|
-
## Property Details
|
|
63
|
-
|
|
64
|
-
### buffer
|
|
65
|
-
- buffer: [ArrayBuffer](TopLevel.ArrayBuffer.md)
|
|
66
|
-
- : The array buffer referenced by this typed array.
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
---
|
|
70
|
-
|
|
71
|
-
### byteLength
|
|
72
|
-
- byteLength: [Number](TopLevel.Number.md)
|
|
73
|
-
- : The number of bytes in the array buffer used by this typed array.
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
---
|
|
77
|
-
|
|
78
|
-
### byteOffset
|
|
79
|
-
- byteOffset: [Number](TopLevel.Number.md)
|
|
80
|
-
- : The start offset for this typed array within the array buffer.
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
---
|
|
84
|
-
|
|
85
|
-
### length
|
|
86
|
-
- length: [Number](TopLevel.Number.md)
|
|
87
|
-
- : The number of elements.
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
---
|
|
91
|
-
|
|
92
|
-
## Constructor Details
|
|
93
|
-
|
|
94
|
-
### Uint32Array()
|
|
95
|
-
- Uint32Array()
|
|
96
|
-
- : Creates an empty array.
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
---
|
|
100
|
-
|
|
101
|
-
### Uint32Array(Number)
|
|
102
|
-
- Uint32Array(length: [Number](TopLevel.Number.md))
|
|
103
|
-
- : Creates an array with the given element count.
|
|
104
|
-
|
|
105
|
-
**Parameters:**
|
|
106
|
-
- length - The number of elements.
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
---
|
|
110
|
-
|
|
111
|
-
### Uint32Array(Object)
|
|
112
|
-
- Uint32Array(typedArray: [Object](TopLevel.Object.md))
|
|
113
|
-
- : Creates an array as a copy of the passed typed array.
|
|
114
|
-
|
|
115
|
-
**Parameters:**
|
|
116
|
-
- typedArray - The source typed array.
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
---
|
|
120
|
-
|
|
121
|
-
### Uint32Array(Array)
|
|
122
|
-
- Uint32Array(array: [Array](TopLevel.Array.md))
|
|
123
|
-
- : Creates an array as a copy of the passed array.
|
|
124
|
-
|
|
125
|
-
**Parameters:**
|
|
126
|
-
- array - The source array.
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
---
|
|
130
|
-
|
|
131
|
-
### Uint32Array(ArrayBuffer, Number, Number)
|
|
132
|
-
- Uint32Array(buffer: [ArrayBuffer](TopLevel.ArrayBuffer.md), byteOffset: [Number](TopLevel.Number.md), length: [Number](TopLevel.Number.md))
|
|
133
|
-
- : Creates a typed array as a view on the given [ArrayBuffer](TopLevel.ArrayBuffer.md).
|
|
134
|
-
|
|
135
|
-
**Parameters:**
|
|
136
|
-
- buffer - The array buffer storage object.
|
|
137
|
-
- byteOffset - Optional. The offset within the array buffer in bytes.
|
|
138
|
-
- length - Optional. The number of elements for the target typed array. The passed array buffer must be large enough to store the number of elements specified.
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
---
|
|
142
|
-
|
|
143
|
-
## Method Details
|
|
144
|
-
|
|
145
|
-
### get(Number)
|
|
146
|
-
- get(index: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
|
|
147
|
-
- : Returns the value at the specified index.
|
|
148
|
-
|
|
149
|
-
Note: This is not ECMAScript standard. Use array element access syntax for single value access.
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
**Parameters:**
|
|
153
|
-
- index - The index to use.
|
|
154
|
-
|
|
155
|
-
**Returns:**
|
|
156
|
-
- The value at the specified index.
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
---
|
|
160
|
-
|
|
161
|
-
### set(Object, Number)
|
|
162
|
-
- set(values: [Object](TopLevel.Object.md), offset: [Number](TopLevel.Number.md)): void
|
|
163
|
-
- : Copies all values from the source array into this typed array.
|
|
164
|
-
|
|
165
|
-
**Parameters:**
|
|
166
|
-
- values - The source values. Can be an array or a typed array.
|
|
167
|
-
- offset - Optional. Target offset.
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
---
|
|
171
|
-
|
|
172
|
-
### subarray(Number, Number)
|
|
173
|
-
- subarray(begin: [Number](TopLevel.Number.md), end: [Number](TopLevel.Number.md)): [Uint32Array](TopLevel.Uint32Array.md)
|
|
174
|
-
- : Returns a new array object based on the same [ArrayBuffer](TopLevel.ArrayBuffer.md) store.
|
|
175
|
-
|
|
176
|
-
**Parameters:**
|
|
177
|
-
- begin - Optional. The first included element.
|
|
178
|
-
- end - Optional. The index of the end. This element is not included.
|
|
179
|
-
|
|
180
|
-
**Returns:**
|
|
181
|
-
- The new array object.
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
---
|
|
185
|
-
|
|
186
|
-
<!-- prettier-ignore-end -->
|
|
@@ -1,186 +0,0 @@
|
|
|
1
|
-
<!-- prettier-ignore-start -->
|
|
2
|
-
# Class Uint8Array
|
|
3
|
-
|
|
4
|
-
- [TopLevel.Object](TopLevel.Object.md)
|
|
5
|
-
- [TopLevel.Uint8Array](TopLevel.Uint8Array.md)
|
|
6
|
-
|
|
7
|
-
An optimized array to store 8-bit unsigned integer numbers. Elements of this array are stored in an
|
|
8
|
-
[ArrayBuffer](TopLevel.ArrayBuffer.md) object.
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
**API Version:**
|
|
12
|
-
:::note
|
|
13
|
-
Available from version 21.2.
|
|
14
|
-
:::
|
|
15
|
-
|
|
16
|
-
## Constant Summary
|
|
17
|
-
|
|
18
|
-
| Constant | Description |
|
|
19
|
-
| --- | --- |
|
|
20
|
-
| [BYTES_PER_ELEMENT](#bytes_per_element): [Number](TopLevel.Number.md) = 1 | Number value of the element size. |
|
|
21
|
-
|
|
22
|
-
## Property Summary
|
|
23
|
-
|
|
24
|
-
| Property | Description |
|
|
25
|
-
| --- | --- |
|
|
26
|
-
| [buffer](#buffer): [ArrayBuffer](TopLevel.ArrayBuffer.md) | The array buffer referenced by this typed array. |
|
|
27
|
-
| [byteLength](#bytelength): [Number](TopLevel.Number.md) | The number of bytes in the array buffer used by this typed array. |
|
|
28
|
-
| [byteOffset](#byteoffset): [Number](TopLevel.Number.md) | The start offset for this typed array within the array buffer. |
|
|
29
|
-
| [length](#length): [Number](TopLevel.Number.md) | The number of elements. |
|
|
30
|
-
|
|
31
|
-
## Constructor Summary
|
|
32
|
-
|
|
33
|
-
| Constructor | Description |
|
|
34
|
-
| --- | --- |
|
|
35
|
-
| [Uint8Array](#uint8array)() | Creates an empty array. |
|
|
36
|
-
| [Uint8Array](#uint8arraynumber)([Number](TopLevel.Number.md)) | Creates an array with the given element count. |
|
|
37
|
-
| [Uint8Array](#uint8arrayobject)([Object](TopLevel.Object.md)) | Creates an array as a copy of the passed typed array. |
|
|
38
|
-
| [Uint8Array](#uint8arrayarray)([Array](TopLevel.Array.md)) | Creates an array as a copy of the passed array. |
|
|
39
|
-
| [Uint8Array](#uint8arrayarraybuffer-number-number)([ArrayBuffer](TopLevel.ArrayBuffer.md), [Number](TopLevel.Number.md), [Number](TopLevel.Number.md)) | Creates a typed array as a view on the given [ArrayBuffer](TopLevel.ArrayBuffer.md). |
|
|
40
|
-
|
|
41
|
-
## Method Summary
|
|
42
|
-
|
|
43
|
-
| Method | Description |
|
|
44
|
-
| --- | --- |
|
|
45
|
-
| [get](TopLevel.Uint8Array.md#getnumber)([Number](TopLevel.Number.md)) | Returns the value at the specified index. |
|
|
46
|
-
| [set](TopLevel.Uint8Array.md#setobject-number)([Object](TopLevel.Object.md), [Number](TopLevel.Number.md)) | Copies all values from the source array into this typed array. |
|
|
47
|
-
| [subarray](TopLevel.Uint8Array.md#subarraynumber-number)([Number](TopLevel.Number.md), [Number](TopLevel.Number.md)) | Returns a new array object based on the same [ArrayBuffer](TopLevel.ArrayBuffer.md) store. |
|
|
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
|
-
## Constant Details
|
|
53
|
-
|
|
54
|
-
### BYTES_PER_ELEMENT
|
|
55
|
-
|
|
56
|
-
- BYTES_PER_ELEMENT: [Number](TopLevel.Number.md) = 1
|
|
57
|
-
- : Number value of the element size.
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
---
|
|
61
|
-
|
|
62
|
-
## Property Details
|
|
63
|
-
|
|
64
|
-
### buffer
|
|
65
|
-
- buffer: [ArrayBuffer](TopLevel.ArrayBuffer.md)
|
|
66
|
-
- : The array buffer referenced by this typed array.
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
---
|
|
70
|
-
|
|
71
|
-
### byteLength
|
|
72
|
-
- byteLength: [Number](TopLevel.Number.md)
|
|
73
|
-
- : The number of bytes in the array buffer used by this typed array.
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
---
|
|
77
|
-
|
|
78
|
-
### byteOffset
|
|
79
|
-
- byteOffset: [Number](TopLevel.Number.md)
|
|
80
|
-
- : The start offset for this typed array within the array buffer.
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
---
|
|
84
|
-
|
|
85
|
-
### length
|
|
86
|
-
- length: [Number](TopLevel.Number.md)
|
|
87
|
-
- : The number of elements.
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
---
|
|
91
|
-
|
|
92
|
-
## Constructor Details
|
|
93
|
-
|
|
94
|
-
### Uint8Array()
|
|
95
|
-
- Uint8Array()
|
|
96
|
-
- : Creates an empty array.
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
---
|
|
100
|
-
|
|
101
|
-
### Uint8Array(Number)
|
|
102
|
-
- Uint8Array(length: [Number](TopLevel.Number.md))
|
|
103
|
-
- : Creates an array with the given element count.
|
|
104
|
-
|
|
105
|
-
**Parameters:**
|
|
106
|
-
- length - The number of elements.
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
---
|
|
110
|
-
|
|
111
|
-
### Uint8Array(Object)
|
|
112
|
-
- Uint8Array(typedArray: [Object](TopLevel.Object.md))
|
|
113
|
-
- : Creates an array as a copy of the passed typed array.
|
|
114
|
-
|
|
115
|
-
**Parameters:**
|
|
116
|
-
- typedArray - The source typed array.
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
---
|
|
120
|
-
|
|
121
|
-
### Uint8Array(Array)
|
|
122
|
-
- Uint8Array(array: [Array](TopLevel.Array.md))
|
|
123
|
-
- : Creates an array as a copy of the passed array.
|
|
124
|
-
|
|
125
|
-
**Parameters:**
|
|
126
|
-
- array - The source array.
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
---
|
|
130
|
-
|
|
131
|
-
### Uint8Array(ArrayBuffer, Number, Number)
|
|
132
|
-
- Uint8Array(buffer: [ArrayBuffer](TopLevel.ArrayBuffer.md), byteOffset: [Number](TopLevel.Number.md), length: [Number](TopLevel.Number.md))
|
|
133
|
-
- : Creates a typed array as a view on the given [ArrayBuffer](TopLevel.ArrayBuffer.md).
|
|
134
|
-
|
|
135
|
-
**Parameters:**
|
|
136
|
-
- buffer - The array buffer storage object.
|
|
137
|
-
- byteOffset - Optional. The offset within the array buffer in bytes.
|
|
138
|
-
- length - Optional. The number of elements for the target typed array. The passed array buffer must be large enough to store the number of elements specified.
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
---
|
|
142
|
-
|
|
143
|
-
## Method Details
|
|
144
|
-
|
|
145
|
-
### get(Number)
|
|
146
|
-
- get(index: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
|
|
147
|
-
- : Returns the value at the specified index.
|
|
148
|
-
|
|
149
|
-
Note: This is not ECMAScript standard. Use array element access syntax for single value access.
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
**Parameters:**
|
|
153
|
-
- index - The index to use.
|
|
154
|
-
|
|
155
|
-
**Returns:**
|
|
156
|
-
- The value at the specified index.
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
---
|
|
160
|
-
|
|
161
|
-
### set(Object, Number)
|
|
162
|
-
- set(values: [Object](TopLevel.Object.md), offset: [Number](TopLevel.Number.md)): void
|
|
163
|
-
- : Copies all values from the source array into this typed array.
|
|
164
|
-
|
|
165
|
-
**Parameters:**
|
|
166
|
-
- values - The source values. Can be an array or a typed array.
|
|
167
|
-
- offset - Optional. Target offset.
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
---
|
|
171
|
-
|
|
172
|
-
### subarray(Number, Number)
|
|
173
|
-
- subarray(begin: [Number](TopLevel.Number.md), end: [Number](TopLevel.Number.md)): [Uint8Array](TopLevel.Uint8Array.md)
|
|
174
|
-
- : Returns a new array object based on the same [ArrayBuffer](TopLevel.ArrayBuffer.md) store.
|
|
175
|
-
|
|
176
|
-
**Parameters:**
|
|
177
|
-
- begin - Optional. The first included element.
|
|
178
|
-
- end - Optional. The index of the end. This element is not included.
|
|
179
|
-
|
|
180
|
-
**Returns:**
|
|
181
|
-
- The new array object.
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
---
|
|
185
|
-
|
|
186
|
-
<!-- prettier-ignore-end -->
|
|
@@ -1,186 +0,0 @@
|
|
|
1
|
-
<!-- prettier-ignore-start -->
|
|
2
|
-
# Class Uint8ClampedArray
|
|
3
|
-
|
|
4
|
-
- [TopLevel.Object](TopLevel.Object.md)
|
|
5
|
-
- [TopLevel.Uint8ClampedArray](TopLevel.Uint8ClampedArray.md)
|
|
6
|
-
|
|
7
|
-
An optimized array to store 8-bit unsigned integer numbers. If a value outside of the range 0-255 is attempted to be
|
|
8
|
-
set, either 0 or 255 is set instead. Elements of this array are stored in an [ArrayBuffer](TopLevel.ArrayBuffer.md) object.
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
**API Version:**
|
|
12
|
-
:::note
|
|
13
|
-
Available from version 21.2.
|
|
14
|
-
:::
|
|
15
|
-
|
|
16
|
-
## Constant Summary
|
|
17
|
-
|
|
18
|
-
| Constant | Description |
|
|
19
|
-
| --- | --- |
|
|
20
|
-
| [BYTES_PER_ELEMENT](#bytes_per_element): [Number](TopLevel.Number.md) = 1 | Number value of the element size. |
|
|
21
|
-
|
|
22
|
-
## Property Summary
|
|
23
|
-
|
|
24
|
-
| Property | Description |
|
|
25
|
-
| --- | --- |
|
|
26
|
-
| [buffer](#buffer): [ArrayBuffer](TopLevel.ArrayBuffer.md) | The array buffer referenced by this typed array. |
|
|
27
|
-
| [byteLength](#bytelength): [Number](TopLevel.Number.md) | The number of bytes in the array buffer used by this typed array. |
|
|
28
|
-
| [byteOffset](#byteoffset): [Number](TopLevel.Number.md) | The start offset for this typed array within the array buffer. |
|
|
29
|
-
| [length](#length): [Number](TopLevel.Number.md) | The number of elements. |
|
|
30
|
-
|
|
31
|
-
## Constructor Summary
|
|
32
|
-
|
|
33
|
-
| Constructor | Description |
|
|
34
|
-
| --- | --- |
|
|
35
|
-
| [Uint8ClampedArray](#uint8clampedarray)() | Creates an empty array. |
|
|
36
|
-
| [Uint8ClampedArray](#uint8clampedarraynumber)([Number](TopLevel.Number.md)) | Creates an array with the given element count. |
|
|
37
|
-
| [Uint8ClampedArray](#uint8clampedarrayobject)([Object](TopLevel.Object.md)) | Creates an array as a copy of the passed typed array. |
|
|
38
|
-
| [Uint8ClampedArray](#uint8clampedarrayarray)([Array](TopLevel.Array.md)) | Creates an array as a copy of the passed array. |
|
|
39
|
-
| [Uint8ClampedArray](#uint8clampedarrayarraybuffer-number-number)([ArrayBuffer](TopLevel.ArrayBuffer.md), [Number](TopLevel.Number.md), [Number](TopLevel.Number.md)) | Creates a typed array as a view on the given [ArrayBuffer](TopLevel.ArrayBuffer.md). |
|
|
40
|
-
|
|
41
|
-
## Method Summary
|
|
42
|
-
|
|
43
|
-
| Method | Description |
|
|
44
|
-
| --- | --- |
|
|
45
|
-
| [get](TopLevel.Uint8ClampedArray.md#getnumber)([Number](TopLevel.Number.md)) | Returns the value at the specified index. |
|
|
46
|
-
| [set](TopLevel.Uint8ClampedArray.md#setobject-number)([Object](TopLevel.Object.md), [Number](TopLevel.Number.md)) | Copies all values from the source array into this typed array. |
|
|
47
|
-
| [subarray](TopLevel.Uint8ClampedArray.md#subarraynumber-number)([Number](TopLevel.Number.md), [Number](TopLevel.Number.md)) | Returns a new array object based on the same [ArrayBuffer](TopLevel.ArrayBuffer.md) store. |
|
|
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
|
-
## Constant Details
|
|
53
|
-
|
|
54
|
-
### BYTES_PER_ELEMENT
|
|
55
|
-
|
|
56
|
-
- BYTES_PER_ELEMENT: [Number](TopLevel.Number.md) = 1
|
|
57
|
-
- : Number value of the element size.
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
---
|
|
61
|
-
|
|
62
|
-
## Property Details
|
|
63
|
-
|
|
64
|
-
### buffer
|
|
65
|
-
- buffer: [ArrayBuffer](TopLevel.ArrayBuffer.md)
|
|
66
|
-
- : The array buffer referenced by this typed array.
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
---
|
|
70
|
-
|
|
71
|
-
### byteLength
|
|
72
|
-
- byteLength: [Number](TopLevel.Number.md)
|
|
73
|
-
- : The number of bytes in the array buffer used by this typed array.
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
---
|
|
77
|
-
|
|
78
|
-
### byteOffset
|
|
79
|
-
- byteOffset: [Number](TopLevel.Number.md)
|
|
80
|
-
- : The start offset for this typed array within the array buffer.
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
---
|
|
84
|
-
|
|
85
|
-
### length
|
|
86
|
-
- length: [Number](TopLevel.Number.md)
|
|
87
|
-
- : The number of elements.
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
---
|
|
91
|
-
|
|
92
|
-
## Constructor Details
|
|
93
|
-
|
|
94
|
-
### Uint8ClampedArray()
|
|
95
|
-
- Uint8ClampedArray()
|
|
96
|
-
- : Creates an empty array.
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
---
|
|
100
|
-
|
|
101
|
-
### Uint8ClampedArray(Number)
|
|
102
|
-
- Uint8ClampedArray(length: [Number](TopLevel.Number.md))
|
|
103
|
-
- : Creates an array with the given element count.
|
|
104
|
-
|
|
105
|
-
**Parameters:**
|
|
106
|
-
- length - The number of elements.
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
---
|
|
110
|
-
|
|
111
|
-
### Uint8ClampedArray(Object)
|
|
112
|
-
- Uint8ClampedArray(typedArray: [Object](TopLevel.Object.md))
|
|
113
|
-
- : Creates an array as a copy of the passed typed array.
|
|
114
|
-
|
|
115
|
-
**Parameters:**
|
|
116
|
-
- typedArray - The source typed array.
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
---
|
|
120
|
-
|
|
121
|
-
### Uint8ClampedArray(Array)
|
|
122
|
-
- Uint8ClampedArray(array: [Array](TopLevel.Array.md))
|
|
123
|
-
- : Creates an array as a copy of the passed array.
|
|
124
|
-
|
|
125
|
-
**Parameters:**
|
|
126
|
-
- array - The source array.
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
---
|
|
130
|
-
|
|
131
|
-
### Uint8ClampedArray(ArrayBuffer, Number, Number)
|
|
132
|
-
- Uint8ClampedArray(buffer: [ArrayBuffer](TopLevel.ArrayBuffer.md), byteOffset: [Number](TopLevel.Number.md), length: [Number](TopLevel.Number.md))
|
|
133
|
-
- : Creates a typed array as a view on the given [ArrayBuffer](TopLevel.ArrayBuffer.md).
|
|
134
|
-
|
|
135
|
-
**Parameters:**
|
|
136
|
-
- buffer - The array buffer storage object.
|
|
137
|
-
- byteOffset - Optional. The offset within the array buffer in bytes.
|
|
138
|
-
- length - Optional. The number of elements for the target typed array. The passed array buffer must be large enough to store the number of elements specified.
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
---
|
|
142
|
-
|
|
143
|
-
## Method Details
|
|
144
|
-
|
|
145
|
-
### get(Number)
|
|
146
|
-
- get(index: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
|
|
147
|
-
- : Returns the value at the specified index.
|
|
148
|
-
|
|
149
|
-
Note: This is not ECMAScript standard. Use array element access syntax for single value access.
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
**Parameters:**
|
|
153
|
-
- index - The index to use.
|
|
154
|
-
|
|
155
|
-
**Returns:**
|
|
156
|
-
- The value at the specified index.
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
---
|
|
160
|
-
|
|
161
|
-
### set(Object, Number)
|
|
162
|
-
- set(values: [Object](TopLevel.Object.md), offset: [Number](TopLevel.Number.md)): void
|
|
163
|
-
- : Copies all values from the source array into this typed array.
|
|
164
|
-
|
|
165
|
-
**Parameters:**
|
|
166
|
-
- values - The source values. Can be an array or a typed array.
|
|
167
|
-
- offset - Optional. Target offset.
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
---
|
|
171
|
-
|
|
172
|
-
### subarray(Number, Number)
|
|
173
|
-
- subarray(begin: [Number](TopLevel.Number.md), end: [Number](TopLevel.Number.md)): [Uint8ClampedArray](TopLevel.Uint8ClampedArray.md)
|
|
174
|
-
- : Returns a new array object based on the same [ArrayBuffer](TopLevel.ArrayBuffer.md) store.
|
|
175
|
-
|
|
176
|
-
**Parameters:**
|
|
177
|
-
- begin - Optional. The first included element.
|
|
178
|
-
- end - Optional. The index of the end. This element is not included.
|
|
179
|
-
|
|
180
|
-
**Returns:**
|
|
181
|
-
- The new array object.
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
---
|
|
185
|
-
|
|
186
|
-
<!-- prettier-ignore-end -->
|
|
@@ -1,135 +0,0 @@
|
|
|
1
|
-
<!-- prettier-ignore-start -->
|
|
2
|
-
# Class WeakMap
|
|
3
|
-
|
|
4
|
-
- [TopLevel.Object](TopLevel.Object.md)
|
|
5
|
-
- [TopLevel.WeakMap](TopLevel.WeakMap.md)
|
|
6
|
-
|
|
7
|
-
The WeakMap is map whose entries are subject to garbage collection if there are no more references to the keys.
|
|
8
|
-
Keys must be objects (no primitives). Elements can't be iterated.
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
**API Version:**
|
|
12
|
-
:::note
|
|
13
|
-
Available from version 21.2.
|
|
14
|
-
:::
|
|
15
|
-
|
|
16
|
-
## Property Summary
|
|
17
|
-
|
|
18
|
-
| Property | Description |
|
|
19
|
-
| --- | --- |
|
|
20
|
-
| [size](#size): [Number](TopLevel.Number.md) | Number of key/value pairs stored in this map. |
|
|
21
|
-
|
|
22
|
-
## Constructor Summary
|
|
23
|
-
|
|
24
|
-
| Constructor | Description |
|
|
25
|
-
| --- | --- |
|
|
26
|
-
| [WeakMap](#weakmap)() | Creates an empty map. |
|
|
27
|
-
| [WeakMap](#weakmapiterable)([Iterable](TopLevel.Iterable.md)) | If the passed value is null or undefined then an empty map is constructed. |
|
|
28
|
-
|
|
29
|
-
## Method Summary
|
|
30
|
-
|
|
31
|
-
| Method | Description |
|
|
32
|
-
| --- | --- |
|
|
33
|
-
| [clear](TopLevel.WeakMap.md#clear)() | Removes all key/value pairs from this map. |
|
|
34
|
-
| [delete](TopLevel.WeakMap.md#deleteobject)([Object](TopLevel.Object.md)) | Removes the entry for the given key. |
|
|
35
|
-
| [get](TopLevel.WeakMap.md#getobject)([Object](TopLevel.Object.md)) | Returns the value associated with the given key. |
|
|
36
|
-
| [has](TopLevel.WeakMap.md#hasobject)([Object](TopLevel.Object.md)) | Returns if this map has value associated with the given key. |
|
|
37
|
-
| [set](TopLevel.WeakMap.md#setobject-object)([Object](TopLevel.Object.md), [Object](TopLevel.Object.md)) | Adds or updates a key/value pair to the map. |
|
|
38
|
-
|
|
39
|
-
### Methods inherited from class Object
|
|
40
|
-
|
|
41
|
-
[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)
|
|
42
|
-
## Property Details
|
|
43
|
-
|
|
44
|
-
### size
|
|
45
|
-
- size: [Number](TopLevel.Number.md)
|
|
46
|
-
- : Number of key/value pairs stored in this map.
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
---
|
|
50
|
-
|
|
51
|
-
## Constructor Details
|
|
52
|
-
|
|
53
|
-
### WeakMap()
|
|
54
|
-
- WeakMap()
|
|
55
|
-
- : Creates an empty map.
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
---
|
|
59
|
-
|
|
60
|
-
### WeakMap(Iterable)
|
|
61
|
-
- WeakMap(values: [Iterable](TopLevel.Iterable.md))
|
|
62
|
-
- : If the passed value is null or undefined then an empty map is constructed. Else an iterator object is expected
|
|
63
|
-
that produces a two-element array-like object whose first element is a value that will be used as a Map key and
|
|
64
|
-
whose second element is the value to associate with that key.
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
**Parameters:**
|
|
68
|
-
- values - The initial map values
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
---
|
|
72
|
-
|
|
73
|
-
## Method Details
|
|
74
|
-
|
|
75
|
-
### clear()
|
|
76
|
-
- clear(): void
|
|
77
|
-
- : Removes all key/value pairs from this map.
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
---
|
|
81
|
-
|
|
82
|
-
### delete(Object)
|
|
83
|
-
- delete(key: [Object](TopLevel.Object.md)): [Boolean](TopLevel.Boolean.md)
|
|
84
|
-
- : Removes the entry for the given key.
|
|
85
|
-
|
|
86
|
-
**Parameters:**
|
|
87
|
-
- key - The key of the key/value pair to be removed from the map.
|
|
88
|
-
|
|
89
|
-
**Returns:**
|
|
90
|
-
- `true` if the map contained an entry for the passed key that was removed. Else `false` is returned.
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
---
|
|
94
|
-
|
|
95
|
-
### get(Object)
|
|
96
|
-
- get(key: [Object](TopLevel.Object.md)): [Object](TopLevel.Object.md)
|
|
97
|
-
- : Returns the value associated with the given key.
|
|
98
|
-
|
|
99
|
-
**Parameters:**
|
|
100
|
-
- key - The key to look for.
|
|
101
|
-
|
|
102
|
-
**Returns:**
|
|
103
|
-
- The value associated with the given key if an entry with the key exists else `undefined` is returned.
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
---
|
|
107
|
-
|
|
108
|
-
### has(Object)
|
|
109
|
-
- has(key: [Object](TopLevel.Object.md)): [Boolean](TopLevel.Boolean.md)
|
|
110
|
-
- : Returns if this map has value associated with the given key.
|
|
111
|
-
|
|
112
|
-
**Parameters:**
|
|
113
|
-
- key - The key to look for.
|
|
114
|
-
|
|
115
|
-
**Returns:**
|
|
116
|
-
- `true` if an entry with the key exists else `false` is returned.
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
---
|
|
120
|
-
|
|
121
|
-
### set(Object, Object)
|
|
122
|
-
- set(key: [Object](TopLevel.Object.md), value: [Object](TopLevel.Object.md)): [WeakMap](TopLevel.WeakMap.md)
|
|
123
|
-
- : Adds or updates a key/value pair to the map.
|
|
124
|
-
|
|
125
|
-
**Parameters:**
|
|
126
|
-
- key - The key object.
|
|
127
|
-
- value - The value to be associate with the key.
|
|
128
|
-
|
|
129
|
-
**Returns:**
|
|
130
|
-
- This map object.
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
---
|
|
134
|
-
|
|
135
|
-
<!-- prettier-ignore-end -->
|