@salesforce/b2c-tooling-sdk 0.0.1 → 0.0.3

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

@@ -0,0 +1,251 @@
+<!-- prettier-ignore-start -->
+# Class Map
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.util.Map](dw.util.Map.md)
+
+Represents a Map of objects.
+
+
+## All Known Subclasses
+[HashMap](dw.util.HashMap.md), [LinkedHashMap](dw.util.LinkedHashMap.md), [SortedMap](dw.util.SortedMap.md)
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [EMPTY_MAP](#empty_map): [Map](dw.util.Map.md) | Convenience variable, for an empty and immutable list. |
+| [empty](#empty): [Boolean](TopLevel.Boolean.md) `(read-only)` | Identifies if this map is empty. |
+| [length](#length): [Number](TopLevel.Number.md) `(read-only)` | REturns the size of the map. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [clear](dw.util.Map.md#clear)() | Clears the map of all objects. |
+| [containsKey](dw.util.Map.md#containskeyobject)([Object](TopLevel.Object.md)) | Identifies if this map contains an element identfied  by the specified key. |
+| [containsValue](dw.util.Map.md#containsvalueobject)([Object](TopLevel.Object.md)) | Identifies if this map contains an element identfied  by the specified value. |
+| [entrySet](dw.util.Map.md#entryset)() | Returns a set of the map's entries. |
+| [get](dw.util.Map.md#getobject)([Object](TopLevel.Object.md)) | Returns the object associated with the key or null. |
+| [getLength](dw.util.Map.md#getlength)() | REturns the size of the map. |
+| [isEmpty](dw.util.Map.md#isempty)() | Identifies if this map is empty. |
+| [keySet](dw.util.Map.md#keyset)() | Returns a set of the map's keys. |
+| [put](dw.util.Map.md#putobject-object)([Object](TopLevel.Object.md), [Object](TopLevel.Object.md)) | Puts the specified value into the map using the  specified key to identify it. |
+| [putAll](dw.util.Map.md#putallmap)([Map](dw.util.Map.md)) | Copies all of the objects inside the specified map  into this map. |
+| [remove](dw.util.Map.md#removeobject)([Object](TopLevel.Object.md)) | Removes the object from the map that is identified by the key. |
+| [size](dw.util.Map.md#size)() | Returns the size of the map. |
+| [values](dw.util.Map.md#values---variant-1)() | Returns a collection of the values contained in this map. |
+| [values](dw.util.Map.md#values---variant-2)() | Returns a collection of the values contained in this map. |
+
+### 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)
+## Property Details
+
+### EMPTY_MAP
+- EMPTY_MAP: [Map](dw.util.Map.md)
+  - : Convenience variable, for an empty and immutable list.
+
+
+---
+
+### empty
+- empty: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : Identifies if this map is empty.
+
+
+---
+
+### length
+- length: [Number](TopLevel.Number.md) `(read-only)`
+  - : REturns the size of the map. This is a bean attribute method and
+      supports the access to the collections
+      length similar to a ECMA array, such as 'products.length'.
+
+
+
+---
+
+## Method Details
+
+### clear()
+- clear(): void
+  - : Clears the map of all objects.
+
+
+---
+
+### containsKey(Object)
+- containsKey(key: [Object](TopLevel.Object.md)): [Boolean](TopLevel.Boolean.md)
+  - : Identifies if this map contains an element identfied
+      by the specified key.
+
+
+    **Parameters:**
+    - key - the key to use.
+
+    **Returns:**
+    - true if this map contains an element whose key is
+      equal to the specified key.
+
+
+
+---
+
+### containsValue(Object)
+- containsValue(value: [Object](TopLevel.Object.md)): [Boolean](TopLevel.Boolean.md)
+  - : Identifies if this map contains an element identfied
+      by the specified value.
+
+
+    **Parameters:**
+    - value - the value to use.
+
+    **Returns:**
+    - true if this map contains an element whose value is
+      equal to the specified value.
+
+
+
+---
+
+### entrySet()
+- entrySet(): [Set](dw.util.Set.md)
+  - : Returns a set of the map's entries. The returned set is actually a view to the entries of this map.
+
+    **Returns:**
+    - a set of the map's entries.
+
+
+---
+
+### get(Object)
+- get(key: [Object](TopLevel.Object.md)): [Object](TopLevel.Object.md)
+  - : Returns the object associated with the key or null.
+
+    **Parameters:**
+    - key - the key to use.
+
+    **Returns:**
+    - the object associated with the key or null.
+
+
+---
+
+### getLength()
+- getLength(): [Number](TopLevel.Number.md)
+  - : REturns the size of the map. This is a bean attribute method and
+      supports the access to the collections
+      length similar to a ECMA array, such as 'products.length'.
+
+
+    **Returns:**
+    - the number of objects in the map.
+
+
+---
+
+### isEmpty()
+- isEmpty(): [Boolean](TopLevel.Boolean.md)
+  - : Identifies if this map is empty.
+
+    **Returns:**
+    - true if the map is empty, false otherwise.
+
+
+---
+
+### keySet()
+- keySet(): [Set](dw.util.Set.md)
+  - : Returns a set of the map's keys. The returned set is actually a view to the keys of this map.
+
+    **Returns:**
+    - a set of the map's keys.
+
+
+---
+
+### put(Object, Object)
+- put(key: [Object](TopLevel.Object.md), value: [Object](TopLevel.Object.md)): [Object](TopLevel.Object.md)
+  - : Puts the specified value into the map using the
+      specified key to identify it.
+
+
+    **Parameters:**
+    - key - the key to use to identify the value.
+    - value - the object to put into the map.
+
+    **Returns:**
+    - previous value associated with specified key, or null if there was no mapping for key.
+
+
+---
+
+### putAll(Map)
+- putAll(other: [Map](dw.util.Map.md)): void
+  - : Copies all of the objects inside the specified map
+      into this map.
+
+
+    **Parameters:**
+    - other - the map whose contents are copied into this map.
+
+
+---
+
+### remove(Object)
+- remove(key: [Object](TopLevel.Object.md)): [Object](TopLevel.Object.md)
+  - : Removes the object from the map that is identified by the key.
+
+    **Parameters:**
+    - key - the key that identifies the object to remove.
+
+    **Returns:**
+    - the removed object or null.
+
+
+---
+
+### size()
+- size(): [Number](TopLevel.Number.md)
+  - : Returns the size of the map.
+
+    **Returns:**
+    - the number of objects in the map.
+
+
+---
+
+### values() - Variant 1
+- values(): [Collection](dw.util.Collection.md)
+  - : Returns a collection of the values contained in this map.
+
+    **Returns:**
+    - a collection of the values contained in this map
+
+    **API Version:**
+:::note
+No longer available as of version 16.1.
+Returns an independent modifiable collection holding all values.
+:::
+
+---
+
+### values() - Variant 2
+- values(): [Collection](dw.util.Collection.md)
+  - : Returns a collection of the values contained in this map.
+
+    **Returns:**
+    - a collection of the values contained in this map
+
+    **API Version:**
+:::note
+Available from version 16.1.
+Returns a view on the values of this map like keySet() and entrySet() do. Former version returned a shallow copy of this.
+:::
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,68 @@
+<!-- prettier-ignore-start -->
+# Class MapEntry
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.util.MapEntry](dw.util.MapEntry.md)
+
+The class represent an entry within a Map.
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [key](#key): [Object](TopLevel.Object.md) `(read-only)` | Returns the entry's key. |
+| [value](#value): [Object](TopLevel.Object.md) `(read-only)` | Returns the entry's value. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getKey](dw.util.MapEntry.md#getkey)() | Returns the entry's key. |
+| [getValue](dw.util.MapEntry.md#getvalue)() | Returns the entry's value. |
+
+### 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)
+## Property Details
+
+### key
+- key: [Object](TopLevel.Object.md) `(read-only)`
+  - : Returns the entry's key.
+
+
+---
+
+### value
+- value: [Object](TopLevel.Object.md) `(read-only)`
+  - : Returns the entry's value.
+
+
+---
+
+## Method Details
+
+### getKey()
+- getKey(): [Object](TopLevel.Object.md)
+  - : Returns the entry's key.
+
+    **Returns:**
+    - the entry's key.
+
+
+---
+
+### getValue()
+- getValue(): [Object](TopLevel.Object.md)
+  - : Returns the entry's value.
+
+    **Returns:**
+    - the entry's value.
+
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,96 @@
+<!-- prettier-ignore-start -->
+# Class MappingKey
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.util.MappingKey](dw.util.MappingKey.md)
+
+Encapsulates the key for a mapping read in with the ImportKeyValueMapping job step. Can be either single or compound keys. For example, a
+single string (e.g. product id) or multiple string components (e.g. product id and site).
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [keyComponents](#keycomponents): [String\[\]](TopLevel.String.md) `(read-only)` | Gets the (possible compound) key. |
+| [singleComponentKey](#singlecomponentkey): [String](TopLevel.String.md) `(read-only)` | Gets a key that contains only a single key component (i.e. |
+
+## Constructor Summary
+
+| Constructor | Description |
+| --- | --- |
+| [MappingKey](#mappingkeystring)([String...](TopLevel.String.md)) | Instantiates a new key using compound key components. |
+
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getKeyComponents](dw.util.MappingKey.md#getkeycomponents)() | Gets the (possible compound) key. |
+| [getSingleComponentKey](dw.util.MappingKey.md#getsinglecomponentkey)() | Gets a key that contains only a single key component (i.e. |
+
+### 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)
+## Property Details
+
+### keyComponents
+- keyComponents: [String\[\]](TopLevel.String.md) `(read-only)`
+  - : Gets the (possible compound) key. If the key consists of only of a single value, the string array
+      will simply contain a single element.
+
+
+
+---
+
+### singleComponentKey
+- singleComponentKey: [String](TopLevel.String.md) `(read-only)`
+  - : Gets a key that contains only a single key component (i.e. that is not a compound key). Returns null if this is
+      not a single component key.
+
+
+
+---
+
+## Constructor Details
+
+### MappingKey(String...)
+- MappingKey(keyComponents: [String...](TopLevel.String.md))
+  - : Instantiates a new key using compound key components. A key can consist of a single string (e.g. product id) or
+      multiple string components (e.g. product id and site). Ctor accepts single string or multiple components for a
+      compound key.
+
+
+    **Parameters:**
+    - keyComponents - the key components
+
+
+---
+
+## Method Details
+
+### getKeyComponents()
+- getKeyComponents(): [String\[\]](TopLevel.String.md)
+  - : Gets the (possible compound) key. If the key consists of only of a single value, the string array
+      will simply contain a single element.
+
+
+    **Returns:**
+    - the key
+
+
+---
+
+### getSingleComponentKey()
+- getSingleComponentKey(): [String](TopLevel.String.md)
+  - : Gets a key that contains only a single key component (i.e. that is not a compound key). Returns null if this is
+      not a single component key.
+
+
+    **Returns:**
+    - the single key
+
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,113 @@
+<!-- prettier-ignore-start -->
+# Class MappingMgr
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.util.MappingMgr](dw.util.MappingMgr.md)
+
+Used to manage and interface with mappings loaded into the system via the ImportKeyValueMapping job step. Class can be
+used to retrieve values for known keys, iterate over all keys known in a mapping or list all known mappings.
+
+
+Mappings are read into the system using the ImportKeyValueMapping job step.
+
+
+Generic mapping capability enables you to map keys to values, with the mapping stored in a high-performance data
+store that is independent of the database. This supports large datasets, with high performance for lookup. An example
+of using this feature is to map SKUs from a backend system to Commerce Cloud Digital SKUs on-the-fly in Digital script, so
+that interaction with the backend system is transparent and does not require adding Digital SKUs to the third
+party system.
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [mappingNames](#mappingnames): [Collection](dw.util.Collection.md) `(read-only)` | List all known mappings. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| static [get](dw.util.MappingMgr.md#getstring-mappingkey)([String](TopLevel.String.md), [MappingKey](dw.util.MappingKey.md)) | Returns a map containing value(s) associated to the specified key for the specified mapping. |
+| static [getFirst](dw.util.MappingMgr.md#getfirststring-mappingkey)([String](TopLevel.String.md), [MappingKey](dw.util.MappingKey.md)) | Gets the first string value of a mapping by name and key. |
+| static [getMappingNames](dw.util.MappingMgr.md#getmappingnames)() | List all known mappings. |
+| static [keyIterator](dw.util.MappingMgr.md#keyiteratorstring)([String](TopLevel.String.md)) | Key iterator over known mapping keys by mapping name. |
+
+### 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)
+## Property Details
+
+### mappingNames
+- mappingNames: [Collection](dw.util.Collection.md) `(read-only)`
+  - : List all known mappings.
+
+
+---
+
+## Method Details
+
+### get(String, MappingKey)
+- static get(mappingName: [String](TopLevel.String.md), key: [MappingKey](dw.util.MappingKey.md)): [Map](dw.util.Map.md)
+  - : Returns a map containing value(s) associated to the specified key for the specified mapping.
+
+    **Parameters:**
+    - mappingName - the mapping name
+    - key - the key
+
+    **Throws:**
+    - IllegalArgumentException - if mappingName is unknown
+
+
+---
+
+### getFirst(String, MappingKey)
+- static getFirst(mappingName: [String](TopLevel.String.md), key: [MappingKey](dw.util.MappingKey.md)): [String](TopLevel.String.md)
+  - : Gets the first string value of a mapping by name and key. Ordering is determined by the input CSV file. Throws an
+      exception if mappingName does not exist.
+
+
+    **Parameters:**
+    - mappingName - the mapping name
+    - key - the key
+
+    **Returns:**
+    - the value if a single value. The first value sequentially if a compound value.
+
+    **Throws:**
+    - IllegalArgumentException - if mappingName is unknown
+
+
+---
+
+### getMappingNames()
+- static getMappingNames(): [Collection](dw.util.Collection.md)
+  - : List all known mappings.
+
+    **Returns:**
+    - the collection of mapping names
+
+
+---
+
+### keyIterator(String)
+- static keyIterator(mappingName: [String](TopLevel.String.md)): [SeekableIterator](dw.util.SeekableIterator.md)
+  - : Key iterator over known mapping keys by mapping name. Throws an exception if mappingName does not exist.
+
+    **Parameters:**
+    - mappingName - the mapping name
+
+    **Returns:**
+    - the seekable iterator
+
+    **Throws:**
+    - IllegalArgumentException - if mappingName is unknown
+
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,122 @@
+<!-- prettier-ignore-start -->
+# Class PropertyComparator
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.util.PropertyComparator](dw.util.PropertyComparator.md)
+
+This comparator can be used for the List sort() methods and for the SortSet
+and SortedMap classes. The comparator can be used to make a comparison based
+on a property of the contained objects. The Comparison is done based on the
+natural order of the values. It is guaranteed to work for Numbers, Strings,
+Dates, Money and Quantity values.
+
+
+
+## Constructor Summary
+
+| Constructor | Description |
+| --- | --- |
+| [PropertyComparator](#propertycomparatorstring-string)([String](TopLevel.String.md), [String...](TopLevel.String.md)) | Constructs the comparator from the variable length argument list. |
+| [PropertyComparator](#propertycomparatorstring-boolean)([String](TopLevel.String.md), [Boolean](TopLevel.Boolean.md)) | Constructs the comparator. |
+| [PropertyComparator](#propertycomparatorstring-boolean-boolean)([String](TopLevel.String.md), [Boolean](TopLevel.Boolean.md), [Boolean](TopLevel.Boolean.md)) | Constructs the comparator. |
+
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [compare](dw.util.PropertyComparator.md#compareobject-object)([Object](TopLevel.Object.md), [Object](TopLevel.Object.md)) | Compares its two arguments for order. |
+
+### 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
+
+### PropertyComparator(String, String...)
+- PropertyComparator(property: [String](TopLevel.String.md), otherProperties: [String...](TopLevel.String.md))
+  - : Constructs the comparator from the variable length argument list. The
+      parameters are property names that are to be used for the comparison.
+      When comparing two objects, the comparator first compares them by the
+      first property. If the two objects have equal values for the first
+      property, the comparator then compares them by the second property,
+      etc, until one object is determined to be less than the other or they are
+      equal. Each parameter must be either a simple name like "totalSum" or can
+      be a reference to a custom attribute like "custom.mytotal". Each
+      parameter may also be prefixed with an optional '+' or '-' character to
+      indicate that the objects should be sorted ascending or descending
+      respectively by that property. If not specified for a given property then
+      '+' (ascending sort) is assumed.
+      
+      For example: new PropertyComparator("+prop1", "-prop2", "prop3")
+      constructs a Comparator which sorts by prop1 ascending, prop2 descending,
+      and finally prop3 ascending.
+      
+      The comparator created with this constructor treats null values as
+      greater than any other value.
+
+
+    **Parameters:**
+    - property - The property name to compare by first.
+    - otherProperties - Additional property names to sort by if two             objects have the same values for the first property.
+
+
+---
+
+### PropertyComparator(String, Boolean)
+- PropertyComparator(propertyName: [String](TopLevel.String.md), sortOrder: [Boolean](TopLevel.Boolean.md))
+  - : Constructs the comparator. The specified parameter is the name of the
+      property that is used for the comparison. The parameter must be either a
+      simple name like "totalSum" or can be a reference to a custom attribute
+      like "custom.mytotal".
+      
+      The comparator created with this constructor is setup with ascending or
+      descending sort order depending on value of sortOrder and null values
+      being greater than any other value.
+
+
+    **Parameters:**
+    - propertyName - the name of the property that is used for the             comparison.
+    - sortOrder - the sort order to use where true means ascending and             false means descending.
+
+
+---
+
+### PropertyComparator(String, Boolean, Boolean)
+- PropertyComparator(propertyName: [String](TopLevel.String.md), sortOrder: [Boolean](TopLevel.Boolean.md), nullGreater: [Boolean](TopLevel.Boolean.md))
+  - : Constructs the comparator. The specified parameter is the name of the
+      property that is used for the comparison. The parameter must be either a
+      simple name like "totalSum" or can be a reference to a custom attribute
+      like "custom.mytotal".
+
+
+    **Parameters:**
+    - propertyName - the name of the property that is used for the             comparison.
+    - sortOrder - the sort order to use where true means ascending and             false means descending.
+    - nullGreater - true means null is greater than any other value
+
+
+---
+
+## Method Details
+
+### compare(Object, Object)
+- compare(arg1: [Object](TopLevel.Object.md), arg2: [Object](TopLevel.Object.md)): [Number](TopLevel.Number.md)
+  - : Compares its two arguments for order. Returns a negative integer, zero,
+      or a positive integer as the first argument is less than, equal to, or
+      greater than the second. By default a null value is treated always
+      greater than any other value. In the constructor of a PropertyComparator
+      this default behavior can be changed.
+
+
+    **Parameters:**
+    - arg1 - the first object to compare.
+    - arg2 - the second object to compare.
+
+    **Returns:**
+    - a negative integer, zero, or a positive integer as the first
+              argument is less than, equal to, or greater than the second.
+
+
+
+---
+
+<!-- prettier-ignore-end -->