@salesforce/b2c-tooling-sdk 1.19.1 → 1.20.1

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

@@ -1,186 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class Float64Array
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [TopLevel.Float64Array](TopLevel.Float64Array.md)
-
-An optimized array to store 64-bit floating point numbers. Elements of this array are stored in an
-[ArrayBuffer](TopLevel.ArrayBuffer.md) object.
-
-
-**API Version:**
-:::note
-Available from version 21.2.
-:::
-
-## Constant Summary
-
-| Constant | Description |
-| --- | --- |
-| [BYTES_PER_ELEMENT](#bytes_per_element): [Number](TopLevel.Number.md) = 8 | Number value of the element size. |
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [buffer](#buffer): [ArrayBuffer](TopLevel.ArrayBuffer.md) | The array buffer referenced by this typed array. |
-| [byteLength](#bytelength): [Number](TopLevel.Number.md) | The number of bytes in the array buffer used by this typed array. |
-| [byteOffset](#byteoffset): [Number](TopLevel.Number.md) | The start offset for this typed array within the array buffer. |
-| [length](#length): [Number](TopLevel.Number.md) | The number of elements. |
-
-## Constructor Summary
-
-| Constructor | Description |
-| --- | --- |
-| [Float64Array](#float64array)() | Creates an empty array. |
-| [Float64Array](#float64arraynumber)([Number](TopLevel.Number.md)) | Creates an array with the given element count. |
-| [Float64Array](#float64arrayobject)([Object](TopLevel.Object.md)) | Creates an array as a copy of the passed typed array. |
-| [Float64Array](#float64arrayarray)([Array](TopLevel.Array.md)) | Creates an array as a copy of the passed array. |
-| [Float64Array](#float64arrayarraybuffer-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). |
-
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [get](TopLevel.Float64Array.md#getnumber)([Number](TopLevel.Number.md)) | Returns the value at the specified index. |
-| [set](TopLevel.Float64Array.md#setobject-number)([Object](TopLevel.Object.md), [Number](TopLevel.Number.md)) | Copies all values from the source array into this typed array. |
-| [subarray](TopLevel.Float64Array.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. |
-
-### 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
-
-### BYTES_PER_ELEMENT
-
-- BYTES_PER_ELEMENT: [Number](TopLevel.Number.md) = 8
-  - : Number value of the element size.
-
-
----
-
-## Property Details
-
-### buffer
-- buffer: [ArrayBuffer](TopLevel.ArrayBuffer.md)
-  - : The array buffer referenced by this typed array.
-
-
----
-
-### byteLength
-- byteLength: [Number](TopLevel.Number.md)
-  - : The number of bytes in the array buffer used by this typed array.
-
-
----
-
-### byteOffset
-- byteOffset: [Number](TopLevel.Number.md)
-  - : The start offset for this typed array within the array buffer.
-
-
----
-
-### length
-- length: [Number](TopLevel.Number.md)
-  - : The number of elements.
-
-
----
-
-## Constructor Details
-
-### Float64Array()
-- Float64Array()
-  - : Creates an empty array.
-
-
----
-
-### Float64Array(Number)
-- Float64Array(length: [Number](TopLevel.Number.md))
-  - : Creates an array with the given element count.
-
-    **Parameters:**
-    - length - The number of elements.
-
-
----
-
-### Float64Array(Object)
-- Float64Array(typedArray: [Object](TopLevel.Object.md))
-  - : Creates an array as a copy of the passed typed array.
-
-    **Parameters:**
-    - typedArray - The source typed array.
-
-
----
-
-### Float64Array(Array)
-- Float64Array(array: [Array](TopLevel.Array.md))
-  - : Creates an array as a copy of the passed array.
-
-    **Parameters:**
-    - array - The source array.
-
-
----
-
-### Float64Array(ArrayBuffer, Number, Number)
-- Float64Array(buffer: [ArrayBuffer](TopLevel.ArrayBuffer.md), byteOffset: [Number](TopLevel.Number.md), length: [Number](TopLevel.Number.md))
-  - : Creates a typed array as a view on the given [ArrayBuffer](TopLevel.ArrayBuffer.md).
-
-    **Parameters:**
-    - buffer - The array buffer storage object.
-    - byteOffset - Optional. The offset within the array buffer in bytes.
-    - 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.
-
-
----
-
-## Method Details
-
-### get(Number)
-- get(index: [Number](TopLevel.Number.md)): [Number](TopLevel.Number.md)
-  - : Returns the value at the specified index. 
-      
-      Note: This is not ECMAScript standard. Use array element access syntax for single value access.
-
-
-    **Parameters:**
-    - index - The index to use.
-
-    **Returns:**
-    - The value at the specified index.
-
-
----
-
-### set(Object, Number)
-- set(values: [Object](TopLevel.Object.md), offset: [Number](TopLevel.Number.md)): void
-  - : Copies all values from the source array into this typed array.
-
-    **Parameters:**
-    - values - The source values. Can be an array or a typed array.
-    - offset - Optional. Target offset.
-
-
----
-
-### subarray(Number, Number)
-- subarray(begin: [Number](TopLevel.Number.md), end: [Number](TopLevel.Number.md)): [Float64Array](TopLevel.Float64Array.md)
-  - : Returns a new array object based on the same [ArrayBuffer](TopLevel.ArrayBuffer.md) store.
-
-    **Parameters:**
-    - begin - Optional. The first included element.
-    - end - Optional. The index of the end. This element is not included.
-
-    **Returns:**
-    - The new array object.
-
-
----
-
-<!-- prettier-ignore-end -->

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

@@ -1,114 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class Function
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [TopLevel.Function](TopLevel.Function.md)
-
-The Function class represent a JavaScript function.
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [length](#length): [Number](TopLevel.Number.md) | The number of named arguments that were specified  when the function was declared. |
-| [prototype](#prototype): [Object](TopLevel.Object.md) | An object that defines properties and methods  shared by all objects created with that  constructor function. |
-
-## Constructor Summary
-
-| Constructor | Description |
-| --- | --- |
-| [Function](#functionstring)([String...](TopLevel.String.md)) | Constructs the function with the specified arguments where the  last argument represents the function body and all preceeding arguments represent  the function parameters. |
-
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [apply](TopLevel.Function.md#applyobject-array)([Object](TopLevel.Object.md), [Array](TopLevel.Array.md)) | Invokes this function as a method of the specified object  passing the specified Array of arguments. |
-| [call](TopLevel.Function.md#callobject-object)([Object](TopLevel.Object.md), [Object...](TopLevel.Object.md)) | Invokes this function as a method of the specified object  passing the specified optional arguments. |
-| [toString](TopLevel.Function.md#tostring)() | Returns a String representation of this function 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)
-## Property Details
-
-### length
-- length: [Number](TopLevel.Number.md)
-  - : The number of named arguments that were specified
-      when the function was declared.
-
-
-
----
-
-### prototype
-- prototype: [Object](TopLevel.Object.md)
-  - : An object that defines properties and methods
-      shared by all objects created with that
-      constructor function.
-
-
-
----
-
-## Constructor Details
-
-### Function(String...)
-- Function(args: [String...](TopLevel.String.md))
-  - : Constructs the function with the specified arguments where the
-      last argument represents the function body and all preceeding arguments represent
-      the function parameters.
-
-
-    **Parameters:**
-    - args - one or more Strings where the last argument in the list  represents the function body and all preceeding arguments represent  the function parameters.
-
-
----
-
-## Method Details
-
-### apply(Object, Array)
-- apply(thisobj: [Object](TopLevel.Object.md), args: [Array](TopLevel.Array.md)): [Object](TopLevel.Object.md)
-  - : Invokes this function as a method of the specified object
-      passing the specified Array of arguments.
-
-
-    **Parameters:**
-    - thisobj - the object to which the function is applied.
-    - args - Array of values or an arguments object to be passed  as arguments to the function.
-
-    **Returns:**
-    - whatever value is returned by the invocation of the function.
-
-
----
-
-### call(Object, Object...)
-- call(thisobj: [Object](TopLevel.Object.md), args: [Object...](TopLevel.Object.md)): [Object](TopLevel.Object.md)
-  - : Invokes this function as a method of the specified object
-      passing the specified optional arguments.
-
-
-    **Parameters:**
-    - thisobj - the object to which the function is applied.
-    - args - an optional list of one or more arguments values  that are passed as arguments  to the function.
-
-    **Returns:**
-    - whatever value is returned by the invocation of the function.
-
-
----
-
-### toString()
-- toString(): [String](TopLevel.String.md)
-  - : Returns a String representation of this function object.
-
-    **Returns:**
-    - a String representation of this function object.
-
-
----
-
-<!-- prettier-ignore-end -->

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

@@ -1,132 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class Generator
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [TopLevel.Generator](TopLevel.Generator.md)
-
-A generator is a special type of function that works as a factory for
-iterators and it allows you to define an iterative algorithm by writing a
-single function which can maintain its own state. A function becomes a
-generator if it contains one or more **yield** statements.
-
-
-When a generator function is called, the body of the function does not
-execute straight away; instead, it returns a generator-iterator object.
-Each call to the generator-iterator's next() method will execute the
-body of the function up to the next **yield** statement and return its result.
-When either the end of the function or a return statement is reached,
-a StopIteration exception is thrown.
-
-
-For example, the following fib() function is a Fibonacci number generator,
-that returns the generator when it encounters the **yield** statement:
-
-```
-function fib() {
-   var fibNum = 0, j = 1;
-   while (true) {
-      **_yield_** fibNum;
-      var t = fibNum;
-      fibNum = j;
-      j += t;
-   }
-}
-```
-
-
-To use the generator, simply call the next() method to access the values
-returned by the function:
-
-```
- var gen = fib();
- for (var i = 0; i < 10; i++) {
-   document.write(**_gen.next()_** " ");
- }
-```
-
-
-**See Also:**
-- [Iterator](TopLevel.Iterator.md)
-- [StopIteration](TopLevel.StopIteration.md)
-
-
-## Constructor Summary
-
-| Constructor | Description |
-| --- | --- |
-| [Generator](#generator)() |  |
-
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [close](TopLevel.Generator.md#close)() | Closes the iteration of the generator. |
-| [next](TopLevel.Generator.md#next)() | Resumes the iteration of the generator by continuing the function  at the statement after the **yield** statement. |
-| [send](TopLevel.Generator.md#sendobject)([Object](TopLevel.Object.md)) | Allows you to control the resumption of the iterative algorithm. |
-
-### 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
-
-### Generator()
-- Generator()
-  - : 
-
-
----
-
-## Method Details
-
-### close()
-- close(): void
-  - : Closes the iteration of the generator. Any finally clauses active in
-      the generator function are run. If a finally clause throws any
-      exception other than StopIteration, the exception is propagated to
-      the caller of the close() method.
-
-
-
----
-
-### next()
-- next(): [Object](TopLevel.Object.md)
-  - : Resumes the iteration of the generator by continuing the function
-      at the statement after the **yield** statement. This function throws a
-      StopIterator exception when there are no additional iterative steps.
-
-
-    **Returns:**
-    - the result of resuming the iterative algorithm or a StopIterator
-      exception if the sequence is exhausted.
-
-
-    **See Also:**
-    - [StopIteration](TopLevel.StopIteration.md)
-
-
----
-
-### send(Object)
-- send(value: [Object](TopLevel.Object.md)): [Object](TopLevel.Object.md)
-  - : Allows you to control the resumption of the iterative algorithm. Once a
-      generator has been started by calling its next() method, you can use
-      send() and pass a specific value that will be treated as the result
-      of the last **yield**. The generator will then return the operand of the
-      subsequent **yield**.
-      
-      
-      You can't start a generator at an arbitrary point; you must start
-      it with next() before you can send() it a specific value. Note that
-      calling send(undefined) is equivalent to calling next(). However,
-      starting a newborn generator with any value other than 'undefined' when
-      calling send() will result in a TypeError exception.
-
-
-    **Parameters:**
-    - value - the value to use.
-
-
----
-
-<!-- prettier-ignore-end -->

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

@@ -1,98 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class IOError
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [TopLevel.Error](TopLevel.Error.md)
-    - [TopLevel.IOError](TopLevel.IOError.md)
-
-This error indicates an I/O related error in the system. The IOError
-is always related to a systems internal Java exception. The class provides
-access to some more details about this internal Java exception.
-
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [causeFullName](#causefullname): [String](TopLevel.String.md) | If the exception is associated with a root cause, the property  contains the full name of the associated Java exception. |
-| [causeMessage](#causemessage): [String](TopLevel.String.md) | If the exception is associated with a root cause, the property  contains the message of the associated Java exception. |
-| [causeName](#causename): [String](TopLevel.String.md) | If the exception is associated with a root cause, the property  contains the simplified name of the associated Java exception. |
-| [javaFullName](#javafullname): [String](TopLevel.String.md) | The full name of the underlying Java exception. |
-| [javaMessage](#javamessage): [String](TopLevel.String.md) | The message of the underlying Java exception. |
-| [javaName](#javaname): [String](TopLevel.String.md) | The simplified name of the underlying Java exception. |
-
-## Constructor Summary
-
-| Constructor | Description |
-| --- | --- |
-| [IOError](#ioerror)() |  |
-
-## Method Summary
-
-### Methods inherited from class Error
-
-[captureStackTrace](TopLevel.Error.md#capturestacktraceerror-function), [toString](TopLevel.Error.md#tostring)
-### 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
-
-### causeFullName
-- causeFullName: [String](TopLevel.String.md)
-  - : If the exception is associated with a root cause, the property
-      contains the full name of the associated Java exception.
-
-
-
----
-
-### causeMessage
-- causeMessage: [String](TopLevel.String.md)
-  - : If the exception is associated with a root cause, the property
-      contains the message of the associated Java exception.
-
-
-
----
-
-### causeName
-- causeName: [String](TopLevel.String.md)
-  - : If the exception is associated with a root cause, the property
-      contains the simplified name of the associated Java exception.
-
-
-
----
-
-### javaFullName
-- javaFullName: [String](TopLevel.String.md)
-  - : The full name of the underlying Java exception.
-
-
----
-
-### javaMessage
-- javaMessage: [String](TopLevel.String.md)
-  - : The message of the underlying Java exception.
-
-
----
-
-### javaName
-- javaName: [String](TopLevel.String.md)
-  - : The simplified name of the underlying Java exception.
-
-
----
-
-## Constructor Details
-
-### IOError()
-- IOError()
-  - : 
-
-
----
-
-<!-- prettier-ignore-end -->