@salesforce/b2c-tooling-sdk 1.19.1 → 1.20.0

package/data/script-api/TopLevel.Iterator.md

@@ -1,89 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class Iterator
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [TopLevel.Iterator](TopLevel.Iterator.md)
-
-An Iterator is a special object that lets you access items from a 
-collection one at a time, while keeping track of its current position 
-within that sequence.
-
-
-
-## Constructor Summary
-
-| Constructor | Description |
-| --- | --- |
-| [Iterator](#iteratorobject)([Object](TopLevel.Object.md)) | Creates an Iterator instance for the specified object. |
-| [Iterator](#iteratorobject-boolean)([Object](TopLevel.Object.md), [Boolean](TopLevel.Boolean.md)) | Creates an Iterator instance for the specified object's keys. |
-
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [next](TopLevel.Iterator.md#next)() | Returns the next item in the iterator. |
-
-### 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
-
-### Iterator(Object)
-- Iterator(object: [Object](TopLevel.Object.md))
-  - : Creates an Iterator instance for the specified object.
-      The Iterator for the object is created by calling the 
-      object's \_\_iterator\_\_ method. If there is no \_\_iterator\_\_ method, 
-      a default iterator is created. The default iterator provides access to 
-      the object's properties, according to the usual for...in and for 
-      each...in model. 
-      
-      If you want to provide a custom iterator, you should override 
-      the \_\_iterator\_\_ method to return an instance of your custom iterator.
-
-
-    **Parameters:**
-    - object - the object whose values will be accessible via the   Iterator.
-
-
----
-
-### Iterator(Object, Boolean)
-- Iterator(object: [Object](TopLevel.Object.md), keysOnly: [Boolean](TopLevel.Boolean.md))
-  - : Creates an Iterator instance for the specified object's keys.
-      The Iterator for the object is created by calling the 
-      object's \_\_iterator\_\_ method. If there is no \_\_iterator\_\_ method, 
-      a default iterator is created. The default iterator provides access to 
-      the object's properties, according to the usual for...in and for 
-      each...in model. 
-      
-      If you want to provide a custom iterator, you should override 
-      the \_\_iterator\_\_ method to return an instance of your custom iterator.
-
-
-    **Parameters:**
-    - object - the object whose keys or values will be accessible   via the Iterator.
-    - keysOnly - if true, provides access to the object's keys. If false,   provides access to the object's values.
-
-
----
-
-## Method Details
-
-### next()
-- next(): [Object](TopLevel.Object.md)
-  - : Returns the next item in the iterator. If there are no items left, 
-      the StopIteration exception is thrown. You should generally use this method 
-      in the context of a try...catch block to handle the StopIteration case.
-      There is no guaranteed ordering of the data.
-
-
-    **Returns:**
-    - the next item in the iterator.
-
-    **See Also:**
-    - [StopIteration](TopLevel.StopIteration.md)
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/TopLevel.JSON.md

@@ -1,173 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class JSON
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [TopLevel.JSON](TopLevel.JSON.md)
-
-The JSON object is a single object that contains two functions, parse and stringify,
-that are used to parse and construct JSON texts. The JSON Data Interchange Format is
-described in RFC 4627.
-
-
-
-## Constructor Summary
-
-| Constructor | Description |
-| --- | --- |
-| [JSON](#json)() |  |
-
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| static [parse](TopLevel.JSON.md#parsestring)([String](TopLevel.String.md)) | The parse function parses a JSON text (a JSON formatted string) and produces an ECMAScript  value. |
-| static [parse](TopLevel.JSON.md#parsestring-function)([String](TopLevel.String.md), [Function](TopLevel.Function.md)) | The parse function parses a JSON text (a JSON formatted string) and produces an ECMAScript  value. |
-| static [stringify](TopLevel.JSON.md#stringifyobject)([Object](TopLevel.Object.md)) | The stringify function produces a JSON formatted string that captures information  from a JavaScript value. |
-| static [stringify](TopLevel.JSON.md#stringifyobject-object)([Object](TopLevel.Object.md), [Object](TopLevel.Object.md)) | The stringify function produces a JSON formatted string that captures information  from a JavaScript value. |
-| static [stringify](TopLevel.JSON.md#stringifyobject-object-string)([Object](TopLevel.Object.md), [Object](TopLevel.Object.md), [String](TopLevel.String.md)) | The stringify function produces a JSON formatted string that captures information  from a JavaScript value. |
-| static [stringify](TopLevel.JSON.md#stringifyobject-object-number)([Object](TopLevel.Object.md), [Object](TopLevel.Object.md), [Number](TopLevel.Number.md)) | The stringify function produces a JSON formatted string that captures information  from a JavaScript 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)
-## Constructor Details
-
-### JSON()
-- JSON()
-  - : 
-
-
----
-
-## Method Details
-
-### parse(String)
-- static parse(json: [String](TopLevel.String.md)): [Object](TopLevel.Object.md)
-  - : The parse function parses a JSON text (a JSON formatted string) and produces an ECMAScript
-      value. The JSON format is a restricted form of ECMAScript literal. JSON objects are realized
-      as ECMAScript objects. JSON Arrays are realized as ECMAScript arrays. JSON strings, numbers,
-      booleans, and null are realized as ECMAScript strings, numbers, booleans, and null.
-
-
-    **Parameters:**
-    - json - a JSON formatted string
-
-    **Returns:**
-    - the object produced from the JSON string
-
-
----
-
-### parse(String, Function)
-- static parse(json: [String](TopLevel.String.md), reviver: [Function](TopLevel.Function.md)): [Object](TopLevel.Object.md)
-  - : The parse function parses a JSON text (a JSON formatted string) and produces an ECMAScript
-      value. The JSON format is a restricted form of ECMAScript literal. JSON objects are realized
-      as ECMAScript objects. JSON Arrays are realized as ECMAScript arrays. JSON strings, numbers,
-      booleans, and null are realized as ECMAScript strings, numbers, booleans, and null.
-      
-      The optional reviver parameter is a function that takes two parameters, (key, value). It can
-      filter and transform the results. It is called with each of the key/value pairs produced by the
-      parse, and its return value is used instead of the original value. If it returns what it
-      received, the structure is not modified. If it returns undefined then the member is deleted
-      from the result.
-
-
-    **Parameters:**
-    - json - a JSON formatted string
-    - reviver - a function, which is called with each key, value pair during parsing
-
-    **Returns:**
-    - the object produced from the JSON string
-
-
----
-
-### stringify(Object)
-- static stringify(value: [Object](TopLevel.Object.md)): [String](TopLevel.String.md)
-  - : The stringify function produces a JSON formatted string that captures information
-      from a JavaScript value. The value parameter is a JavaScript value is usually an
-      object or array, although it can also be a string, boolean, number or null.
-      
-      Note: Stringifying API objects is not supported.
-
-
-    **Parameters:**
-    - value - the value which is stringified
-
-    **Returns:**
-    - the JSON string
-
-
----
-
-### stringify(Object, Object)
-- static stringify(value: [Object](TopLevel.Object.md), replacer: [Object](TopLevel.Object.md)): [String](TopLevel.String.md)
-  - : The stringify function produces a JSON formatted string that captures information
-      from a JavaScript value. The value parameter is a JavaScript value is usually an
-      object or array, although it can also be a string, boolean, number or null. The
-      optional replacer parameter is either a function that alters the way objects and
-      arrays are stringified, or an array of strings that acts as an allowlist for selecting
-      the keys that will be stringified.
-      
-      Note: Stringifying API objects is not supported.
-
-
-    **Parameters:**
-    - value - the value which is stringified
-    - replacer - either a function, which is called with a key and value as parameter, or an array with an allowlist
-
-    **Returns:**
-    - the JSON string
-
-
----
-
-### stringify(Object, Object, String)
-- static stringify(value: [Object](TopLevel.Object.md), replacer: [Object](TopLevel.Object.md), space: [String](TopLevel.String.md)): [String](TopLevel.String.md)
-  - : The stringify function produces a JSON formatted string that captures information
-      from a JavaScript value. The value parameter is a JavaScript value is usually an
-      object or array, although it can also be a string, boolean, number or null. The
-      optional replacer parameter is either a function that alters the way objects and
-      arrays are stringified, or an array of strings that acts as an allowlist for selecting
-      the keys that will be stringified. The optional space parameter is a string or number
-      that allows the result to have white space injected into it to improve human readability.
-      
-      Note: Stringifying API objects is not supported.
-
-
-    **Parameters:**
-    - value - the value which is stringified
-    - replacer - either a function, which is called with a key and value as parameter, or an array with an allowlist
-    - space - a string for indentation
-
-    **Returns:**
-    - the JSON string
-
-
----
-
-### stringify(Object, Object, Number)
-- static stringify(value: [Object](TopLevel.Object.md), replacer: [Object](TopLevel.Object.md), space: [Number](TopLevel.Number.md)): [String](TopLevel.String.md)
-  - : The stringify function produces a JSON formatted string that captures information
-      from a JavaScript value. The value parameter is a JavaScript value is usually an
-      object or array, although it can also be a string, boolean, number or null. The
-      optional replacer parameter is either a function that alters the way objects and
-      arrays are stringified, or an array of strings that acts as an allowlist for selecting
-      the keys that will be stringified. The optional space parameter is a string or number
-      that allows the result to have white space injected into it to improve human readability.
-      
-      Note: Stringifying API objects is not supported.
-
-
-    **Parameters:**
-    - value - the value which is stringified
-    - replacer - either a function, which is called with a key and value as parameter, or an array with an allowlist
-    - space - the number of space for indenting
-
-    **Returns:**
-    - the JSON string
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/TopLevel.Map.md

@@ -1,189 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class Map
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [TopLevel.Map](TopLevel.Map.md)
-
-Map objects are collections of key/value pairs where both the keys and values may be arbitrary ECMAScript language
-values. A distinct key value may only occur in one key/value pair within the Map's collection. Key/value pairs are stored
-and iterated in insertion order.
-
-
-**API Version:**
-:::note
-Available from version 21.2.
-:::
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [size](#size): [Number](TopLevel.Number.md) | Number of key/value pairs stored in this map. |
-
-## Constructor Summary
-
-| Constructor | Description |
-| --- | --- |
-| [Map](#map)() | Creates an empty map. |
-| [Map](#mapiterable)([Iterable](TopLevel.Iterable.md)) | If the passed value is null or undefined then an empty map is constructed. |
-
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [clear](TopLevel.Map.md#clear)() | Removes all key/value pairs from this map. |
-| [delete](TopLevel.Map.md#deleteobject)([Object](TopLevel.Object.md)) | Removes the entry for the given key. |
-| [entries](TopLevel.Map.md#entries)() | Returns an iterator containing all key/value pairs of this map. |
-| [forEach](TopLevel.Map.md#foreachfunction)([Function](TopLevel.Function.md)) | Runs the provided callback function once for each key/value pair present in this map. |
-| [forEach](TopLevel.Map.md#foreachfunction-object)([Function](TopLevel.Function.md), [Object](TopLevel.Object.md)) | Runs the provided callback function once for each key/value pair present in this map. |
-| [get](TopLevel.Map.md#getobject)([Object](TopLevel.Object.md)) | Returns the value associated with the given key. |
-| [has](TopLevel.Map.md#hasobject)([Object](TopLevel.Object.md)) | Returns if this map has value associated with the given key. |
-| [keys](TopLevel.Map.md#keys)() | Returns an iterator containing all keys of this map. |
-| [set](TopLevel.Map.md#setobject-object)([Object](TopLevel.Object.md), [Object](TopLevel.Object.md)) | Adds or updates a key/value pair to the map. |
-| [values](TopLevel.Map.md#values)() | Returns an iterator containing all values of 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
-
-### size
-- size: [Number](TopLevel.Number.md)
-  - : Number of key/value pairs stored in this map.
-
-
----
-
-## Constructor Details
-
-### Map()
-- Map()
-  - : Creates an empty map.
-
-
----
-
-### Map(Iterable)
-- Map(values: [Iterable](TopLevel.Iterable.md))
-  - : If the passed value is null or undefined then an empty map is constructed. Else an iterator object is expected
-      that produces a two element array-like object whose first element is a value that will be used as a Map key and
-      whose second element is the value to associate with that key.
-
-
-    **Parameters:**
-    - values - The initial map values
-
-
----
-
-## Method Details
-
-### clear()
-- clear(): void
-  - : Removes all key/value pairs from this map.
-
-
----
-
-### delete(Object)
-- delete(key: [Object](TopLevel.Object.md)): [Boolean](TopLevel.Boolean.md)
-  - : Removes the entry for the given key.
-
-    **Parameters:**
-    - key - The key of the key/value pair to be removed from the map.
-
-    **Returns:**
-    - `true` if the map contained an entry for the passed key that was removed. Else `false` is returned.
-
-
----
-
-### entries()
-- entries(): [ES6Iterator](TopLevel.ES6Iterator.md)
-  - : Returns an iterator containing all key/value pairs of this map.
-      The iterator produces a series of two-element arrays with the first element as the key and the second element as the value.
-
-
-
----
-
-### forEach(Function)
-- forEach(callback: [Function](TopLevel.Function.md)): void
-  - : Runs the provided callback function once for each key/value pair present in this map.
-
-    **Parameters:**
-    - callback - The function to call, which is invoked with three  arguments: the value of the element, the key of the element, and the  Map object being iterated.
-
-
----
-
-### forEach(Function, Object)
-- forEach(callback: [Function](TopLevel.Function.md), thisObject: [Object](TopLevel.Object.md)): void
-  - : Runs the provided callback function once for each key/value pair present in this map.
-
-    **Parameters:**
-    - callback - The function to call, which is invoked with three  arguments: the value of the element, the key of the element, and the  Map object being iterated.
-    - thisObject - The Object to use as 'this' when executing callback.
-
-
----
-
-### get(Object)
-- get(key: [Object](TopLevel.Object.md)): [Object](TopLevel.Object.md)
-  - : Returns the value associated with the given key.
-
-    **Parameters:**
-    - key - The key to look for.
-
-    **Returns:**
-    - The value associated with the given key if an entry with the key exists else `undefined` is returned.
-
-
----
-
-### has(Object)
-- has(key: [Object](TopLevel.Object.md)): [Boolean](TopLevel.Boolean.md)
-  - : Returns if this map has value associated with the given key.
-
-    **Parameters:**
-    - key - The key to look for.
-
-    **Returns:**
-    - `true` if an entry with the key exists else `false` is returned.
-
-
----
-
-### keys()
-- keys(): [ES6Iterator](TopLevel.ES6Iterator.md)
-  - : Returns an iterator containing all keys of this map.
-
-
----
-
-### set(Object, Object)
-- set(key: [Object](TopLevel.Object.md), value: [Object](TopLevel.Object.md)): [Map](TopLevel.Map.md)
-  - : Adds or updates a key/value pair to the map. 
-      
-      You can't use JavaScript bracket notation to access map entries. JavaScript bracket notation accesses only
-      properties for Map objects, not map entries.
-
-
-    **Parameters:**
-    - key - The key object.
-    - value - The value to be associated with the key.
-
-    **Returns:**
-    - This map object.
-
-
----
-
-### values()
-- values(): [ES6Iterator](TopLevel.ES6Iterator.md)
-  - : Returns an iterator containing all values of this map.
-
-
----
-
-<!-- prettier-ignore-end -->