sfcc-dev-mcp 1.0.0

package/docs/TopLevel/Symbol.md

@@ -0,0 +1,78 @@
+## Package: TopLevel
+
+# Class Symbol
+
+## Inheritance Hierarchy
+
+- Object
+  - Symbol
+
+## Description
+
+Symbol is a primitive data type that can serve as object properties. Symbol instance can be created explicitly or via a global registry, see for(String).
+
+## Constants
+
+## Properties
+
+## Constructor Summary
+
+Symbol() Creates a new symbol.
+
+Symbol(description : String) Creates a new symbol.
+
+## Method Summary
+
+### for
+
+**Signature:** `static for(key : String) : Symbol`
+
+Obtains a symbol from the global registry.
+
+### keyFor
+
+**Signature:** `static keyFor(symbol : Symbol) : String`
+
+Returns the key within the global symbol registry under which the given symbol is stored.
+
+## Constructor Detail
+
+## Method Detail
+
+## Method Details
+
+### for
+
+**Signature:** `static for(key : String) : Symbol`
+
+**Description:** Obtains a symbol from the global registry. If no symbol exists for the key within the registry a new symbol is created and stored in the global registry.
+
+**API Versioned:**
+
+From version 21.2.
+
+**Parameters:**
+
+- `key`: The key for a symbol within the global registry.
+
+**Returns:**
+
+The found or newly created symbol.
+
+---
+
+### keyFor
+
+**Signature:** `static keyFor(symbol : Symbol) : String`
+
+**Description:** Returns the key within the global symbol registry under which the given symbol is stored.
+
+**Parameters:**
+
+- `symbol`: The symbol to look for.
+
+**Returns:**
+
+The key for the given symbol if the symbol is known to the global registry, else return undefined.
+
+---

package/docs/TopLevel/SyntaxError.md

@@ -0,0 +1,23 @@
+## Package: TopLevel
+
+# Class SyntaxError
+
+## Inheritance Hierarchy
+
+- Object
+  - TopLevel.Error
+  - SyntaxError
+
+## Description
+
+Represents a syntax error.
+
+## Constructor Summary
+
+SyntaxError() Constructs the error.
+
+SyntaxError(msg : String) Constructs the error with the specified message.
+
+## Method Summary
+
+## Constructor Detail

package/docs/TopLevel/SystemError.md

@@ -0,0 +1,62 @@
+## Package: TopLevel
+
+# Class SystemError
+
+## Inheritance Hierarchy
+
+- Object
+  - TopLevel.Error
+  - SystemError
+
+## Description
+
+This error indicates an error in the system, which doesn't fall into any of the other error categories like for example IOError. The SystemError is always related to a systems internal Java exception. The class provides access to some more details about this internal Java exception.
+
+## Properties
+
+### causeFullName
+
+**Type:** String
+
+If the exception is associated with a root cause, the property
+ contains the full name of the associated Java exception.
+
+### causeMessage
+
+**Type:** String
+
+If the exception is associated with a root cause, the property
+ contains the message of the associated Java exception.
+
+### causeName
+
+**Type:** String
+
+If the exception is associated with a root cause, the property
+ contains the simplified name of the associated Java exception.
+
+### javaFullName
+
+**Type:** String
+
+The full name of the underlying Java exception.
+
+### javaMessage
+
+**Type:** String
+
+The message of the underlying Java exception.
+
+### javaName
+
+**Type:** String
+
+The simplified name of the underlying Java exception.
+
+## Constructor Summary
+
+SystemError()
+
+## Method Summary
+
+## Constructor Detail

package/docs/TopLevel/TypeError.md

@@ -0,0 +1,23 @@
+## Package: TopLevel
+
+# Class TypeError
+
+## Inheritance Hierarchy
+
+- Object
+  - TopLevel.Error
+  - TypeError
+
+## Description
+
+Represents a type error.
+
+## Constructor Summary
+
+TypeError() Constructs the error.
+
+TypeError(msg : String) Constructs the error with the specified message.
+
+## Method Summary
+
+## Constructor Detail

package/docs/TopLevel/URIError.md

@@ -0,0 +1,23 @@
+## Package: TopLevel
+
+# Class URIError
+
+## Inheritance Hierarchy
+
+- Object
+  - TopLevel.Error
+  - URIError
+
+## Description
+
+Represents a URI error.
+
+## Constructor Summary
+
+URIError() Constructs the error.
+
+URIError(msg : String) Constructs the error with the specified message.
+
+## Method Summary
+
+## Constructor Detail

package/docs/TopLevel/Uint16Array.md

@@ -0,0 +1,124 @@
+## Package: TopLevel
+
+# Class Uint16Array
+
+## Inheritance Hierarchy
+
+- Object
+  - Uint16Array
+
+## Description
+
+An optimized array to store 16-bit unsigned integer numbers. Elements of this array are stored in an ArrayBuffer object.
+
+## Constants
+
+## Properties
+
+### buffer
+
+**Type:** ArrayBuffer
+
+The array buffer referenced by this typed array.
+
+### byteLength
+
+**Type:** Number
+
+The number of bytes in the array buffer used by this typed array.
+
+### byteOffset
+
+**Type:** Number
+
+The start offset for this typed array within the array buffer.
+
+### length
+
+**Type:** Number
+
+The number of elements.
+
+## Constructor Summary
+
+Uint16Array() Creates an empty array.
+
+Uint16Array(length : Number) Creates an array with the given element count.
+
+Uint16Array(typedArray : Object) Creates an array as a copy of the passed typed array.
+
+Uint16Array(array : Array) Creates an array as a copy of the passed array.
+
+Uint16Array(buffer : ArrayBuffer, byteOffset : Number, length : Number) Creates a typed array as a view on the given ArrayBuffer.
+
+## Method Summary
+
+### get
+
+**Signature:** `get(index : Number) : Number`
+
+Returns the value at the specified index.
+
+### set
+
+**Signature:** `set(values : Object, offset : Number) : void`
+
+Copies all values from the source array into this typed array.
+
+### subarray
+
+**Signature:** `subarray(begin : Number, end : Number) : Uint16Array`
+
+Returns a new array object based on the same ArrayBuffer store.
+
+## Constructor Detail
+
+## Method Detail
+
+## Method Details
+
+### get
+
+**Signature:** `get(index : Number) : Number`
+
+**Description:** 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
+
+**Signature:** `set(values : Object, offset : Number) : void`
+
+**Description:** 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
+
+**Signature:** `subarray(begin : Number, end : Number) : Uint16Array`
+
+**Description:** Returns a new array object based on the same ArrayBuffer 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.
+
+---

package/docs/TopLevel/Uint32Array.md

@@ -0,0 +1,124 @@
+## Package: TopLevel
+
+# Class Uint32Array
+
+## Inheritance Hierarchy
+
+- Object
+  - Uint32Array
+
+## Description
+
+An optimized array to store 32-bit unsigned integer numbers. Elements of this array are stored in an ArrayBuffer object.
+
+## Constants
+
+## Properties
+
+### buffer
+
+**Type:** ArrayBuffer
+
+The array buffer referenced by this typed array.
+
+### byteLength
+
+**Type:** Number
+
+The number of bytes in the array buffer used by this typed array.
+
+### byteOffset
+
+**Type:** Number
+
+The start offset for this typed array within the array buffer.
+
+### length
+
+**Type:** Number
+
+The number of elements.
+
+## Constructor Summary
+
+Uint32Array() Creates an empty array.
+
+Uint32Array(length : Number) Creates an array with the given element count.
+
+Uint32Array(typedArray : Object) Creates an array as a copy of the passed typed array.
+
+Uint32Array(array : Array) Creates an array as a copy of the passed array.
+
+Uint32Array(buffer : ArrayBuffer, byteOffset : Number, length : Number) Creates a typed array as a view on the given ArrayBuffer.
+
+## Method Summary
+
+### get
+
+**Signature:** `get(index : Number) : Number`
+
+Returns the value at the specified index.
+
+### set
+
+**Signature:** `set(values : Object, offset : Number) : void`
+
+Copies all values from the source array into this typed array.
+
+### subarray
+
+**Signature:** `subarray(begin : Number, end : Number) : Uint32Array`
+
+Returns a new array object based on the same ArrayBuffer store.
+
+## Constructor Detail
+
+## Method Detail
+
+## Method Details
+
+### get
+
+**Signature:** `get(index : Number) : Number`
+
+**Description:** 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
+
+**Signature:** `set(values : Object, offset : Number) : void`
+
+**Description:** 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
+
+**Signature:** `subarray(begin : Number, end : Number) : Uint32Array`
+
+**Description:** Returns a new array object based on the same ArrayBuffer 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.
+
+---

package/docs/TopLevel/Uint8Array.md

@@ -0,0 +1,124 @@
+## Package: TopLevel
+
+# Class Uint8Array
+
+## Inheritance Hierarchy
+
+- Object
+  - Uint8Array
+
+## Description
+
+An optimized array to store 8-bit unsigned integer numbers. Elements of this array are stored in an ArrayBuffer object.
+
+## Constants
+
+## Properties
+
+### buffer
+
+**Type:** ArrayBuffer
+
+The array buffer referenced by this typed array.
+
+### byteLength
+
+**Type:** Number
+
+The number of bytes in the array buffer used by this typed array.
+
+### byteOffset
+
+**Type:** Number
+
+The start offset for this typed array within the array buffer.
+
+### length
+
+**Type:** Number
+
+The number of elements.
+
+## Constructor Summary
+
+Uint8Array() Creates an empty array.
+
+Uint8Array(length : Number) Creates an array with the given element count.
+
+Uint8Array(typedArray : Object) Creates an array as a copy of the passed typed array.
+
+Uint8Array(array : Array) Creates an array as a copy of the passed array.
+
+Uint8Array(buffer : ArrayBuffer, byteOffset : Number, length : Number) Creates a typed array as a view on the given ArrayBuffer.
+
+## Method Summary
+
+### get
+
+**Signature:** `get(index : Number) : Number`
+
+Returns the value at the specified index.
+
+### set
+
+**Signature:** `set(values : Object, offset : Number) : void`
+
+Copies all values from the source array into this typed array.
+
+### subarray
+
+**Signature:** `subarray(begin : Number, end : Number) : Uint8Array`
+
+Returns a new array object based on the same ArrayBuffer store.
+
+## Constructor Detail
+
+## Method Detail
+
+## Method Details
+
+### get
+
+**Signature:** `get(index : Number) : Number`
+
+**Description:** 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
+
+**Signature:** `set(values : Object, offset : Number) : void`
+
+**Description:** 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
+
+**Signature:** `subarray(begin : Number, end : Number) : Uint8Array`
+
+**Description:** Returns a new array object based on the same ArrayBuffer 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.
+
+---

package/docs/TopLevel/Uint8ClampedArray.md

@@ -0,0 +1,124 @@
+## Package: TopLevel
+
+# Class Uint8ClampedArray
+
+## Inheritance Hierarchy
+
+- Object
+  - Uint8ClampedArray
+
+## Description
+
+An optimized array to store 8-bit unsigned integer numbers. If a value outside of the range 0-255 is attempted to be set, either 0 or 255 is set instead. Elements of this array are stored in an ArrayBuffer object.
+
+## Constants
+
+## Properties
+
+### buffer
+
+**Type:** ArrayBuffer
+
+The array buffer referenced by this typed array.
+
+### byteLength
+
+**Type:** Number
+
+The number of bytes in the array buffer used by this typed array.
+
+### byteOffset
+
+**Type:** Number
+
+The start offset for this typed array within the array buffer.
+
+### length
+
+**Type:** Number
+
+The number of elements.
+
+## Constructor Summary
+
+Uint8ClampedArray() Creates an empty array.
+
+Uint8ClampedArray(length : Number) Creates an array with the given element count.
+
+Uint8ClampedArray(typedArray : Object) Creates an array as a copy of the passed typed array.
+
+Uint8ClampedArray(array : Array) Creates an array as a copy of the passed array.
+
+Uint8ClampedArray(buffer : ArrayBuffer, byteOffset : Number, length : Number) Creates a typed array as a view on the given ArrayBuffer.
+
+## Method Summary
+
+### get
+
+**Signature:** `get(index : Number) : Number`
+
+Returns the value at the specified index.
+
+### set
+
+**Signature:** `set(values : Object, offset : Number) : void`
+
+Copies all values from the source array into this typed array.
+
+### subarray
+
+**Signature:** `subarray(begin : Number, end : Number) : Uint8ClampedArray`
+
+Returns a new array object based on the same ArrayBuffer store.
+
+## Constructor Detail
+
+## Method Detail
+
+## Method Details
+
+### get
+
+**Signature:** `get(index : Number) : Number`
+
+**Description:** 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
+
+**Signature:** `set(values : Object, offset : Number) : void`
+
+**Description:** 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
+
+**Signature:** `subarray(begin : Number, end : Number) : Uint8ClampedArray`
+
+**Description:** Returns a new array object based on the same ArrayBuffer 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.
+
+---