sfcc-dev-mcp 1.0.0

package/docs/TopLevel/ArrayBuffer.md

@@ -0,0 +1,79 @@
+## Package: TopLevel
+
+# Class ArrayBuffer
+
+## Inheritance Hierarchy
+
+- Object
+  - ArrayBuffer
+
+## Description
+
+The ArrayBuffer represents a generic array of bytes with fixed length. To access and manipulate content, use DataView or a typed array.
+
+## Properties
+
+### byteLength
+
+**Type:** Number
+
+The number of bytes in the array buffer.
+
+## Constructor Summary
+
+ArrayBuffer() Creates an empty array buffer.
+
+ArrayBuffer(byteLength : Number) Creates an array buffer with the given number of bytes.
+
+## Method Summary
+
+### isView
+
+**Signature:** `static isView(object : Object) : boolean`
+
+Returns if the given object is one of the views for an ArrayBuffer, such as a typed array or a DataView.
+
+### slice
+
+**Signature:** `slice(begin : Number, end : Number) : ArrayBuffer`
+
+Returns a new array buffer with a copy of the data of this buffer.
+
+## Constructor Detail
+
+## Method Detail
+
+## Method Details
+
+### isView
+
+**Signature:** `static isView(object : Object) : boolean`
+
+**Description:** Returns if the given object is one of the views for an ArrayBuffer, such as a typed array or a DataView.
+
+**Parameters:**
+
+- `object`: The object to check.
+
+**Returns:**
+
+true if the passed object is a view to an array buffer else return false.
+
+---
+
+### slice
+
+**Signature:** `slice(begin : Number, end : Number) : ArrayBuffer`
+
+**Description:** Returns a new array buffer with a copy of the data of this buffer.
+
+**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/BigInt.md

@@ -0,0 +1,132 @@
+## Package: TopLevel
+
+# Class BigInt
+
+## Inheritance Hierarchy
+
+- Object
+  - BigInt
+
+## Description
+
+A BigInt object is a wrapper for a primitive bigint value. bigint values can be numbers too large to be stored as number values. A bigint literal in code is an integer number with an appended n. Example: var hugeNumber = 1245678901234567890n; var hugeNumberObject = BigInt( hugeNumber );
+
+## Constructor Summary
+
+BigInt() Constructs a BigInt with value 0.
+
+BigInt(value : BigInt) Constructs a new BigInt using the specified BigInt.
+
+BigInt(value : String) Constructs a BigInt using the specified value.
+
+## Method Summary
+
+### asIntN
+
+**Signature:** `static asIntN(bits : Number, value : BigInt) : BigInt`
+
+Clamps the given BigInt value to a signed integer with a given precision.
+
+### asUintN
+
+**Signature:** `static asUintN(bits : Number, value : BigInt) : BigInt`
+
+Clamps the given BigInt value to an unsigned integer with a given precision.
+
+### toLocaleString
+
+**Signature:** `toLocaleString() : String`
+
+Converts this BigInt to a String using local number formatting conventions.
+
+### toString
+
+**Signature:** `toString() : String`
+
+A String representation of this BigInt.
+
+### toString
+
+**Signature:** `toString(radix : Number) : String`
+
+Converts the BigInt into a string using the specified radix (base).
+
+## Constructor Detail
+
+## Method Detail
+
+## Method Details
+
+### asIntN
+
+**Signature:** `static asIntN(bits : Number, value : BigInt) : BigInt`
+
+**Description:** Clamps the given BigInt value to a signed integer with a given precision.
+
+**Parameters:**
+
+- `bits`: Number of bits required for resulting integer.
+- `value`: The value to be clamped to the given number of bits.
+
+**Returns:**
+
+The value modulo 2bits, as a signed integer.
+
+---
+
+### asUintN
+
+**Signature:** `static asUintN(bits : Number, value : BigInt) : BigInt`
+
+**Description:** Clamps the given BigInt value to an unsigned integer with a given precision.
+
+**Parameters:**
+
+- `bits`: Number of bits required for resulting integer.
+- `value`: The value to be clamped to the given number of bits.
+
+**Returns:**
+
+The value modulo 2bits, as an unsigned integer.
+
+---
+
+### toLocaleString
+
+**Signature:** `toLocaleString() : String`
+
+**Description:** Converts this BigInt to a String using local number formatting conventions. The current implementation actually only returns the same as toString().
+
+**Returns:**
+
+a String using local number formatting conventions.
+
+---
+
+### toString
+
+**Signature:** `toString() : String`
+
+**Description:** A String representation of this BigInt.
+
+**Returns:**
+
+a String representation of this BigInt.
+
+---
+
+### toString
+
+**Signature:** `toString(radix : Number) : String`
+
+**Description:** Converts the BigInt into a string using the specified radix (base).
+
+**Parameters:**
+
+- `radix`: the radix to use.
+
+**Returns:**
+
+a String representation of this BigInt.
+
+---

package/docs/TopLevel/Boolean.md

@@ -0,0 +1,62 @@
+## Package: TopLevel
+
+# Class Boolean
+
+## Inheritance Hierarchy
+
+- Object
+  - Boolean
+
+## Description
+
+Provides support for boolean values.
+
+## Constructor Summary
+
+Boolean(value : String) Constructs the Boolean using the specified String value.
+
+Boolean(value : Number) Constructs the Boolean using the specified Number value.
+
+## Method Summary
+
+### toString
+
+**Signature:** `toString() : String`
+
+Returns true or false depending on the value used to create the Boolean.
+
+### valueOf
+
+**Signature:** `valueOf() : Object`
+
+Returns the primitive boolean contained in the Boolean object.
+
+## Constructor Detail
+
+## Method Detail
+
+## Method Details
+
+### toString
+
+**Signature:** `toString() : String`
+
+**Description:** Returns true or false depending on the value used to create the Boolean.
+
+**Returns:**
+
+true or false depending on the value used to create the Boolean.
+
+---
+
+### valueOf
+
+**Signature:** `valueOf() : Object`
+
+**Description:** Returns the primitive boolean contained in the Boolean object.
+
+**Returns:**
+
+the primitive boolean contained in the Boolean object.
+
+---

package/docs/TopLevel/ConversionError.md

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

package/docs/TopLevel/DataView.md

@@ -0,0 +1,352 @@
+## Package: TopLevel
+
+# Class DataView
+
+## Inheritance Hierarchy
+
+- Object
+  - DataView
+
+## Description
+
+The DataView provides low level access to ArrayBuffer.
+
+## Properties
+
+### buffer
+
+**Type:** ArrayBuffer
+
+The array buffer referenced by this view.
+
+### byteLength
+
+**Type:** Number
+
+The number of bytes in the array buffer used by this view.
+
+### byteOffset
+
+**Type:** Number
+
+The start offset for this view within the array buffer.
+
+## Constructor Summary
+
+DataView(buffer : ArrayBuffer, byteOffset : Number, byteLength : Number) Creates a data view on the given ArrayBuffer.
+
+## Method Summary
+
+### getFloat32
+
+**Signature:** `getFloat32(byteOffset : Number, littleEndian : boolean) : Number`
+
+Returns the 32-bit floating point number at the given offset.
+
+### getFloat64
+
+**Signature:** `getFloat64(byteOffset : Number, littleEndian : boolean) : Number`
+
+Returns the 64-bit floating point number at the given offset.
+
+### getInt16
+
+**Signature:** `getInt16(byteOffset : Number, littleEndian : boolean) : Number`
+
+Returns the 16-bit signed integer number at the given offset.
+
+### getInt32
+
+**Signature:** `getInt32(byteOffset : Number, littleEndian : boolean) : Number`
+
+Returns the 32-bit signed integer number at the given offset.
+
+### getInt8
+
+**Signature:** `getInt8(byteOffset : Number) : Number`
+
+Returns the 8-bit signed integer number at the given offset.
+
+### getUint16
+
+**Signature:** `getUint16(byteOffset : Number, littleEndian : boolean) : Number`
+
+Returns the 16-bit unsigned integer number at the given offset.
+
+### getUint32
+
+**Signature:** `getUint32(byteOffset : Number, littleEndian : boolean) : Number`
+
+Returns the 32-bit unsigned integer number at the given offset.
+
+### getUint8
+
+**Signature:** `getUint8(byteOffset : Number) : Number`
+
+Returns the 8-bit unsigned integer number at the given offset.
+
+### setFloat32
+
+**Signature:** `setFloat32(byteOffset : Number, value : Number, littleEndian : boolean) : void`
+
+Writes a 32-bit floating point number into the byte array at the given offset.
+
+### setFloat64
+
+**Signature:** `setFloat64(byteOffset : Number, value : Number, littleEndian : boolean) : void`
+
+Writes a 64-bit floating point number into the byte array at the given offset.
+
+### setInt16
+
+**Signature:** `setInt16(byteOffset : Number, value : Number, littleEndian : boolean) : void`
+
+Writes a 16-bit signed integer number into the byte array at the given offset.
+
+### setInt32
+
+**Signature:** `setInt32(byteOffset : Number, value : Number, littleEndian : boolean) : void`
+
+Writes a 32-bit signed integer number into the byte array at the given offset.
+
+### setInt8
+
+**Signature:** `setInt8(byteOffset : Number, value : Number) : void`
+
+Writes an 8-bit signed integer number into the byte array at the given offset.
+
+### setUint16
+
+**Signature:** `setUint16(byteOffset : Number, value : Number, littleEndian : boolean) : void`
+
+Writes a 16-bit unsigned integer number into the byte array at the given offset.
+
+### setUint32
+
+**Signature:** `setUint32(byteOffset : Number, value : Number, littleEndian : boolean) : void`
+
+Writes a 32-bit unsigned integer number into the byte array at the given offset.
+
+### setUint8
+
+**Signature:** `setUint8(byteOffset : Number, value : Number) : void`
+
+Writes an 8-bit unsigned integer number into the byte array at the given offset.
+
+## Constructor Detail
+
+## Method Detail
+
+## Method Details
+
+### getFloat32
+
+**Signature:** `getFloat32(byteOffset : Number, littleEndian : boolean) : Number`
+
+**Description:** Returns the 32-bit floating point number at the given offset.
+
+**Parameters:**
+
+- `byteOffset`: The offset within the view.
+- `littleEndian`: Optional. Default is false. Use true if the number is stored in little-endian format.
+
+---
+
+### getFloat64
+
+**Signature:** `getFloat64(byteOffset : Number, littleEndian : boolean) : Number`
+
+**Description:** Returns the 64-bit floating point number at the given offset.
+
+**Parameters:**
+
+- `byteOffset`: The offset within the view.
+- `littleEndian`: Optional. Default is false. Use true if the number is stored in little-endian format.
+
+---
+
+### getInt16
+
+**Signature:** `getInt16(byteOffset : Number, littleEndian : boolean) : Number`
+
+**Description:** Returns the 16-bit signed integer number at the given offset.
+
+**Parameters:**
+
+- `byteOffset`: The offset within the view.
+- `littleEndian`: Optional. Default is false. Use true if the number is stored in little-endian format.
+
+---
+
+### getInt32
+
+**Signature:** `getInt32(byteOffset : Number, littleEndian : boolean) : Number`
+
+**Description:** Returns the 32-bit signed integer number at the given offset.
+
+**Parameters:**
+
+- `byteOffset`: The offset within the view.
+- `littleEndian`: Optional. Default is false. Use true if the number is stored in little-endian format.
+
+---
+
+### getInt8
+
+**Signature:** `getInt8(byteOffset : Number) : Number`
+
+**Description:** Returns the 8-bit signed integer number at the given offset.
+
+**Parameters:**
+
+- `byteOffset`: The offset within the view.
+
+---
+
+### getUint16
+
+**Signature:** `getUint16(byteOffset : Number, littleEndian : boolean) : Number`
+
+**Description:** Returns the 16-bit unsigned integer number at the given offset.
+
+**Parameters:**
+
+- `byteOffset`: The offset within the view.
+- `littleEndian`: Optional. Default is false. Use true if the number is stored in little-endian format.
+
+---
+
+### getUint32
+
+**Signature:** `getUint32(byteOffset : Number, littleEndian : boolean) : Number`
+
+**Description:** Returns the 32-bit unsigned integer number at the given offset.
+
+**Parameters:**
+
+- `byteOffset`: The offset within the view.
+- `littleEndian`: Optional. Default is false. Use true if the number is stored in little-endian format.
+
+---
+
+### getUint8
+
+**Signature:** `getUint8(byteOffset : Number) : Number`
+
+**Description:** Returns the 8-bit unsigned integer number at the given offset.
+
+**Parameters:**
+
+- `byteOffset`: The offset within the view.
+
+---
+
+### setFloat32
+
+**Signature:** `setFloat32(byteOffset : Number, value : Number, littleEndian : boolean) : void`
+
+**Description:** Writes a 32-bit floating point number into the byte array at the given offset.
+
+**Parameters:**
+
+- `byteOffset`: The offset within the view.
+- `value`: The value to be written.
+- `littleEndian`: Optional. Default is false. Use true if the little-endian format is to be used.
+
+---
+
+### setFloat64
+
+**Signature:** `setFloat64(byteOffset : Number, value : Number, littleEndian : boolean) : void`
+
+**Description:** Writes a 64-bit floating point number into the byte array at the given offset.
+
+**Parameters:**
+
+- `byteOffset`: The offset within the view.
+- `value`: The value to be written.
+- `littleEndian`: Optional. Default is false. Use true if the little-endian format is to be used.
+
+---
+
+### setInt16
+
+**Signature:** `setInt16(byteOffset : Number, value : Number, littleEndian : boolean) : void`
+
+**Description:** Writes a 16-bit signed integer number into the byte array at the given offset.
+
+**Parameters:**
+
+- `byteOffset`: The offset within the view.
+- `value`: The value to be written.
+- `littleEndian`: Optional. Default is false. Use true if the little-endian format is to be used.
+
+---
+
+### setInt32
+
+**Signature:** `setInt32(byteOffset : Number, value : Number, littleEndian : boolean) : void`
+
+**Description:** Writes a 32-bit signed integer number into the byte array at the given offset.
+
+**Parameters:**
+
+- `byteOffset`: The offset within the view.
+- `value`: The value to be written.
+- `littleEndian`: Optional. Default is false. Use true if the little-endian format is to be used.
+
+---
+
+### setInt8
+
+**Signature:** `setInt8(byteOffset : Number, value : Number) : void`
+
+**Description:** Writes an 8-bit signed integer number into the byte array at the given offset.
+
+**Parameters:**
+
+- `byteOffset`: The offset within the view.
+- `value`: The value to be written.
+
+---
+
+### setUint16
+
+**Signature:** `setUint16(byteOffset : Number, value : Number, littleEndian : boolean) : void`
+
+**Description:** Writes a 16-bit unsigned integer number into the byte array at the given offset.
+
+**Parameters:**
+
+- `byteOffset`: The offset within the view.
+- `value`: The value to be written.
+- `littleEndian`: Optional. Default is false. Use true if the little-endian format is to be used.
+
+---
+
+### setUint32
+
+**Signature:** `setUint32(byteOffset : Number, value : Number, littleEndian : boolean) : void`
+
+**Description:** Writes a 32-bit unsigned integer number into the byte array at the given offset.
+
+**Parameters:**
+
+- `byteOffset`: The offset within the view.
+- `value`: The value to be written.
+- `littleEndian`: Optional. Default is false. Use true if the little-endian format is to be used.
+
+---
+
+### setUint8
+
+**Signature:** `setUint8(byteOffset : Number, value : Number) : void`
+
+**Description:** Writes an 8-bit unsigned integer number into the byte array at the given offset.
+
+**Parameters:**
+
+- `byteOffset`: The offset within the view.
+- `value`: The value to be written.
+
+---