@salesforce/b2c-tooling-sdk 1.19.1 → 1.20.0

package/data/script-api/dw.util.Decimal.md

@@ -1,386 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class Decimal
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.util.Decimal](dw.util.Decimal.md)
-
-The Decimal class is a helper class to perform decimal arithmetic in
-scripts and to represent a decimal number with arbitrary length. The decimal
-class avoids arithmetic errors, which are typical for calculating with
-floating numbers, that are based on a binary mantissa.
-
-
-The class is designed in a way that it can be used very similar to a
-desktop calculator.
-
-
-```
-var d = new Decimal( 10.0 );
-var result = d.add( 2.0 ).sub( 3.0 ).get();
-```
-
-
-
-The above code will return 9 as result.
-
-
-
-## Constructor Summary
-
-| Constructor | Description |
-| --- | --- |
-| [Decimal](#decimal)() | Constructs a new Decimal with the value 0. |
-| [Decimal](#decimalnumber)([Number](TopLevel.Number.md)) | Constructs a new decimal using the specified Number value. |
-| [Decimal](#decimalbigint)([BigInt](TopLevel.BigInt.md)) | Constructs a new decimal using the specified BigInt value. |
-| [Decimal](#decimalstring)([String](TopLevel.String.md)) | Constructs a new Decimal using the specified string representation of  a number. |
-
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [abs](dw.util.Decimal.md#abs)() | Returns a new Decimal with the absolute value of this Decimal. |
-| [add](dw.util.Decimal.md#addnumber)([Number](TopLevel.Number.md)) | Adds a Number value to this Decimal and returns the new Decimal. |
-| [add](dw.util.Decimal.md#adddecimal)([Decimal](dw.util.Decimal.md)) | Adds a Decimal value to this Decimal and returns the new Decimal. |
-| [addPercent](dw.util.Decimal.md#addpercentnumber)([Number](TopLevel.Number.md)) | Adds a percentage value to the current value of the  decimal. |
-| [addPercent](dw.util.Decimal.md#addpercentdecimal)([Decimal](dw.util.Decimal.md)) | Adds a percentage value to the current value of the  decimal. |
-| [divide](dw.util.Decimal.md#dividenumber)([Number](TopLevel.Number.md)) | Divides the specified Number value with this decimal and returns the new  decimal. |
-| [divide](dw.util.Decimal.md#dividedecimal)([Decimal](dw.util.Decimal.md)) | Divides the specified Decimal value with this decimal and returns the new  decimal. |
-| [equals](dw.util.Decimal.md#equalsobject)([Object](TopLevel.Object.md)) | Compares two decimal values whether they are equivalent. |
-| [get](dw.util.Decimal.md#get)() | Returns the value of the Decimal as a Number. |
-| [hashCode](dw.util.Decimal.md#hashcode)() | Calculates the hash code for this decimal; |
-| [multiply](dw.util.Decimal.md#multiplynumber)([Number](TopLevel.Number.md)) | Multiples the specified Number value with this Decimal and returns the new Decimal. |
-| [multiply](dw.util.Decimal.md#multiplydecimal)([Decimal](dw.util.Decimal.md)) | Multiples the specified Decimal value with this Decimal and returns the new Decimal. |
-| [negate](dw.util.Decimal.md#negate)() | Returns a new Decimal with the negated value of this Decimal. |
-| [round](dw.util.Decimal.md#roundnumber)([Number](TopLevel.Number.md)) | Rounds the current value of the decimal using the specified  number of decimals. |
-| [subtract](dw.util.Decimal.md#subtractnumber)([Number](TopLevel.Number.md)) | Subtracts the specified Number value from this Decimal and returns the new Decimal. |
-| [subtract](dw.util.Decimal.md#subtractdecimal)([Decimal](dw.util.Decimal.md)) | Subtracts the specified Decimal value from this Decimal and returns the new Decimal. |
-| [subtractPercent](dw.util.Decimal.md#subtractpercentnumber)([Number](TopLevel.Number.md)) | Subtracts a percentage value from the current value of the  decimal. |
-| [subtractPercent](dw.util.Decimal.md#subtractpercentdecimal)([Decimal](dw.util.Decimal.md)) | Subtracts a percentage value from the current value of the  decimal. |
-| [toString](dw.util.Decimal.md#tostring)() | Returns a string representation of this object. |
-| [valueOf](dw.util.Decimal.md#valueof)() | The valueOf() method is called by the ECMAScript interpret to return  the "natural" value of an object. |
-
-### Methods inherited from class Object
-
-[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)
-## Constructor Details
-
-### Decimal()
-- Decimal()
-  - : Constructs a new Decimal with the value 0.
-
-
----
-
-### Decimal(Number)
-- Decimal(value: [Number](TopLevel.Number.md))
-  - : Constructs a new decimal using the specified Number value.
-
-    **Parameters:**
-    - value - the value to use.
-
-
----
-
-### Decimal(BigInt)
-- Decimal(value: [BigInt](TopLevel.BigInt.md))
-  - : Constructs a new decimal using the specified BigInt value.
-
-    **Parameters:**
-    - value - the value to use.
-
-    **API Version:**
-:::note
-Available from version 22.7.
-:::
-
----
-
-### Decimal(String)
-- Decimal(value: [String](TopLevel.String.md))
-  - : Constructs a new Decimal using the specified string representation of
-      a number.
-
-
-    **Parameters:**
-    - value - the value to use.
-
-
----
-
-## Method Details
-
-### abs()
-- abs(): [Decimal](dw.util.Decimal.md)
-  - : Returns a new Decimal with the absolute value of this Decimal.
-
-    **Returns:**
-    - the new Decimal
-
-
----
-
-### add(Number)
-- add(value: [Number](TopLevel.Number.md)): [Decimal](dw.util.Decimal.md)
-  - : Adds a Number value to this Decimal and returns the new Decimal.
-
-    **Parameters:**
-    - value - the value to add to this decimal.
-
-    **Returns:**
-    - the new decimal with the value added.
-
-
----
-
-### add(Decimal)
-- add(value: [Decimal](dw.util.Decimal.md)): [Decimal](dw.util.Decimal.md)
-  - : Adds a Decimal value to this Decimal and returns the new Decimal.
-
-    **Parameters:**
-    - value - the value to add to this decimal.
-
-    **Returns:**
-    - the new decimal with the value added.
-
-
----
-
-### addPercent(Number)
-- addPercent(value: [Number](TopLevel.Number.md)): [Decimal](dw.util.Decimal.md)
-  - : Adds a percentage value to the current value of the
-      decimal. For example a value of 10 represent 10% or a value of
-      85 represents 85%.
-
-
-    **Parameters:**
-    - value - the value to add.
-
-    **Returns:**
-    - a new decimal with the added percentage value.
-
-
----
-
-### addPercent(Decimal)
-- addPercent(value: [Decimal](dw.util.Decimal.md)): [Decimal](dw.util.Decimal.md)
-  - : Adds a percentage value to the current value of the
-      decimal. For example a value of 10 represent 10% or a value of
-      85 represents 85%.
-
-
-    **Parameters:**
-    - value - the value to add.
-
-    **Returns:**
-    - a new decimal with the added percentage value.
-
-
----
-
-### divide(Number)
-- divide(value: [Number](TopLevel.Number.md)): [Decimal](dw.util.Decimal.md)
-  - : Divides the specified Number value with this decimal and returns the new
-      decimal.
-      
-      When performing the division, 34 digits precision and a rounding mode of
-      HALF\_EVEN is used to prevent quotients with nonterminating decimal
-      expansions.
-
-
-    **Parameters:**
-    - value - the value to use to divide this decimal.
-
-    **Returns:**
-    - the new decimal.
-
-
----
-
-### divide(Decimal)
-- divide(value: [Decimal](dw.util.Decimal.md)): [Decimal](dw.util.Decimal.md)
-  - : Divides the specified Decimal value with this decimal and returns the new
-      decimal.
-      
-      When performing the division, 34 digits precision and a rounding mode of
-      HALF\_EVEN is used to prevent quotients with nonterminating decimal
-      expansions.
-
-
-    **Parameters:**
-    - value - the value to use to divide this decimal.
-
-    **Returns:**
-    - the new decimal.
-
-
----
-
-### equals(Object)
-- equals(other: [Object](TopLevel.Object.md)): [Boolean](TopLevel.Boolean.md)
-  - : Compares two decimal values whether they are equivalent.
-
-    **Parameters:**
-    - other - the object to comapre against this decimal.
-
-
----
-
-### get()
-- get(): [Number](TopLevel.Number.md)
-  - : Returns the value of the Decimal as a Number.
-
-    **Returns:**
-    - the value of the Decimal.
-
-
----
-
-### hashCode()
-- hashCode(): [Number](TopLevel.Number.md)
-  - : Calculates the hash code for this decimal;
-
-
----
-
-### multiply(Number)
-- multiply(value: [Number](TopLevel.Number.md)): [Decimal](dw.util.Decimal.md)
-  - : Multiples the specified Number value with this Decimal and returns the new Decimal.
-
-    **Parameters:**
-    - value - the value to multiply with this decimal.
-
-    **Returns:**
-    - the new decimal.
-
-
----
-
-### multiply(Decimal)
-- multiply(value: [Decimal](dw.util.Decimal.md)): [Decimal](dw.util.Decimal.md)
-  - : Multiples the specified Decimal value with this Decimal and returns the new Decimal.
-
-    **Parameters:**
-    - value - the value to multiply with this decimal.
-
-    **Returns:**
-    - the new decimal.
-
-
----
-
-### negate()
-- negate(): [Decimal](dw.util.Decimal.md)
-  - : Returns a new Decimal with the negated value of this Decimal.
-
-    **Returns:**
-    - the new Decimal
-
-
----
-
-### round(Number)
-- round(decimals: [Number](TopLevel.Number.md)): [Decimal](dw.util.Decimal.md)
-  - : Rounds the current value of the decimal using the specified
-      number of decimals. The parameter
-      specifies the number of digest after the decimal point.
-
-
-    **Parameters:**
-    - decimals - the number of decimals to use.
-
-    **Returns:**
-    - the decimal that has been rounded.
-
-
----
-
-### subtract(Number)
-- subtract(value: [Number](TopLevel.Number.md)): [Decimal](dw.util.Decimal.md)
-  - : Subtracts the specified Number value from this Decimal and returns the new Decimal.
-
-    **Parameters:**
-    - value - the value to add to this decimal.
-
-    **Returns:**
-    - the new decimal with the value subtraced.
-
-
----
-
-### subtract(Decimal)
-- subtract(value: [Decimal](dw.util.Decimal.md)): [Decimal](dw.util.Decimal.md)
-  - : Subtracts the specified Decimal value from this Decimal and returns the new Decimal.
-
-    **Parameters:**
-    - value - the value to add to this decimal.
-
-    **Returns:**
-    - the new decimal with the value subtraced.
-
-
----
-
-### subtractPercent(Number)
-- subtractPercent(value: [Number](TopLevel.Number.md)): [Decimal](dw.util.Decimal.md)
-  - : Subtracts a percentage value from the current value of the
-      decimal. For example a value of 10 represent 10% or a value of
-      85 represents 85%.
-
-
-    **Parameters:**
-    - value - the value to subtract.
-
-    **Returns:**
-    - a new decimal with the subtracted percentage value.
-
-
----
-
-### subtractPercent(Decimal)
-- subtractPercent(value: [Decimal](dw.util.Decimal.md)): [Decimal](dw.util.Decimal.md)
-  - : Subtracts a percentage value from the current value of the
-      decimal. For example a value of 10 represent 10% or a value of
-      85 represents 85%.
-
-
-    **Parameters:**
-    - value - the value to subtract.
-
-    **Returns:**
-    - a new decimal with the subtracted percentage value.
-
-
----
-
-### toString()
-- toString(): [String](TopLevel.String.md)
-  - : Returns a string representation of this object.
-
-    **Returns:**
-    - a string representation of this object.
-
-
----
-
-### valueOf()
-- valueOf(): [Object](TopLevel.Object.md)
-  - : The valueOf() method is called by the ECMAScript interpret to return
-      the "natural" value of an object. The Decimal object returns its
-      current value as number. With this behavior script snippets can
-      be written like:
-      
-      `
-       var d = new Decimal( 10.0 );
-       var x = 1.0 + d.add( 2.0 );
-       `
-      
-      where x will be at the end 13.0.
-
-
-    **Returns:**
-    - the value of this object.
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/dw.util.FilteringCollection.md

@@ -1,140 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class FilteringCollection
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.util.Collection](dw.util.Collection.md)
-    - [dw.util.FilteringCollection](dw.util.FilteringCollection.md)
-
-[FilteringCollection](dw.util.FilteringCollection.md) is an extension of
-[Collection](dw.util.Collection.md) which provides possibilities to
-
-
-- _filter_the elements to return a new  [FilteringCollection](dw.util.FilteringCollection.md)with a filtered set of elements
-- _sort_the elements to return a new  [FilteringCollection](dw.util.FilteringCollection.md)with a defined sort order
-- _transform_the elements to return a new  [FilteringCollection](dw.util.FilteringCollection.md)containing related elements
-- _provide a map_of the elements against a predefined key
-
-
-
-
-**Usage** - In the current version each
-[FilteringCollection](dw.util.FilteringCollection.md) provides a set of predefined
-_qualifier_ constants which can be passed into the
-[select(Object)](dw.util.FilteringCollection.md#selectobject) method used to _filter_ the elements. Generally
-_qualifiers_ have the prefix _QUALIFIER\__. A second method
-[sort(Object)](dw.util.FilteringCollection.md#sortobject) is used to create a new instance with a different
-element ordering, which takes an _orderB<_ constant. Generally
-_orderBys_ have the prefix ORDERBY\_: examples are
-[ShippingOrder.ORDERBY_ITEMID](dw.order.ShippingOrder.md#orderby_itemid),
-[ShippingOrder.ORDERBY_ITEMPOSITION](dw.order.ShippingOrder.md#orderby_itemposition), and [ORDERBY_REVERSE](dw.util.FilteringCollection.md#orderby_reverse) can
-be used to provide a [FilteringCollection](dw.util.FilteringCollection.md) with the reverse
-ordering. An example with method [ShippingOrder.getItems()](dw.order.ShippingOrder.md#getitems):
-
-
-
-`
- 
-var allItems     : FilteringCollection = shippingOrder.items;
- 
-var productItems : FilteringCollection = allItems.select(ShippingOrder.QUALIFIER_PRODUCTITEMS);
- 
-var serviceItems : FilteringCollection = allItems.select(ShippingOrder.QUALIFIER_SERVICEITEMS);
- 
-var byPosition   : FilteringCollection = productItems.sort(ShippingOrder.ORDERBY_ITEMPOSITION);
- 
-var revByPosition: FilteringCollection = byPosition.sort(FilteringCollection.ORDERBY_REVERSE);
- 
-var mapByItemID  : Map = allItems.asMap();
- `
-
-
-
-## Constant Summary
-
-| Constant | Description |
-| --- | --- |
-| [ORDERBY_REVERSE](#orderby_reverse): [Object](TopLevel.Object.md) | Pass this _orderBy_ with the [sort(Object)](dw.util.FilteringCollection.md#sortobject) method to  obtain a new [FilteringCollection](dw.util.FilteringCollection.md) with the reversed sort  order. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [asMap](dw.util.FilteringCollection.md#asmap)() | Returns a [Map](dw.util.Map.md) containing the elements of this  [FilteringCollection](dw.util.FilteringCollection.md) against a predefined key. |
-| [select](dw.util.FilteringCollection.md#selectobject)([Object](TopLevel.Object.md)) | Select a new [FilteringCollection](dw.util.FilteringCollection.md) instance by passing a  predefined _qualifier_ as an argument to this method. |
-| [sort](dw.util.FilteringCollection.md#sortobject)([Object](TopLevel.Object.md)) | Select a new [FilteringCollection](dw.util.FilteringCollection.md) instance by passing a  predefined _orderBy_ as an argument to this method. |
-
-### Methods inherited from class Collection
-
-[add](dw.util.Collection.md#addobject), [add1](dw.util.Collection.md#add1object), [addAll](dw.util.Collection.md#addallcollection), [clear](dw.util.Collection.md#clear), [contains](dw.util.Collection.md#containsobject), [containsAll](dw.util.Collection.md#containsallcollection), [getLength](dw.util.Collection.md#getlength), [isEmpty](dw.util.Collection.md#isempty), [iterator](dw.util.Collection.md#iterator), [remove](dw.util.Collection.md#removeobject), [removeAll](dw.util.Collection.md#removeallcollection), [retainAll](dw.util.Collection.md#retainallcollection), [size](dw.util.Collection.md#size), [toArray](dw.util.Collection.md#toarray), [toArray](dw.util.Collection.md#toarraynumber-number)
-### Methods inherited from class Object
-
-[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)
-## Constant Details
-
-### ORDERBY_REVERSE
-
-- ORDERBY_REVERSE: [Object](TopLevel.Object.md)
-  - : Pass this _orderBy_ with the [sort(Object)](dw.util.FilteringCollection.md#sortobject) method to
-      obtain a new [FilteringCollection](dw.util.FilteringCollection.md) with the reversed sort
-      order. Only use on a [FilteringCollection](dw.util.FilteringCollection.md) which has been
-      previously sorted.
-
-
-
----
-
-## Method Details
-
-### asMap()
-- asMap(): [Map](dw.util.Map.md)
-  - : Returns a [Map](dw.util.Map.md) containing the elements of this
-      [FilteringCollection](dw.util.FilteringCollection.md) against a predefined key. The key
-      used is documented in the method returning the
-      [FilteringCollection](dw.util.FilteringCollection.md) and is typically the ItemID assigned
-      to an element in the collection.
-
-
-    **Returns:**
-    - a [Map](dw.util.Map.md) containing the elements of this
-              [FilteringCollection](dw.util.FilteringCollection.md) against a predefined key.
-
-
-
----
-
-### select(Object)
-- select(qualifier: [Object](TopLevel.Object.md)): [FilteringCollection](dw.util.FilteringCollection.md)
-  - : Select a new [FilteringCollection](dw.util.FilteringCollection.md) instance by passing a
-      predefined _qualifier_ as an argument to this method. See
-      [FilteringCollection](dw.util.FilteringCollection.md).
-
-
-    **Parameters:**
-    - qualifier - possible qualifiers are documented in the method returning the [FilteringCollection](dw.util.FilteringCollection.md)
-
-    **Returns:**
-    - a new [FilteringCollection](dw.util.FilteringCollection.md) instance
-
-
----
-
-### sort(Object)
-- sort(orderBy: [Object](TopLevel.Object.md)): [FilteringCollection](dw.util.FilteringCollection.md)
-  - : Select a new [FilteringCollection](dw.util.FilteringCollection.md) instance by passing a
-      predefined _orderBy_ as an argument to this method. See
-      [FilteringCollection](dw.util.FilteringCollection.md).
-
-
-    **Parameters:**
-    - orderBy - possible orderBys are documented in the method returning the [FilteringCollection](dw.util.FilteringCollection.md)
-
-    **Returns:**
-    - a new [FilteringCollection](dw.util.FilteringCollection.md) instance
-
-
----
-
-<!-- prettier-ignore-end -->