sfcc-dev-mcp 1.0.0

package/docs/TopLevel/ES6Iterator.md

@@ -0,0 +1,33 @@
+## Package: TopLevel
+
+# Class ES6Iterator
+
+## Inheritance Hierarchy
+
+- ES6Iterator
+
+## Description
+
+This isn't a built-in type. It describes the properties an object must have in order to work as an iterator since ECMAScript 2015.
+
+## Constructor Summary
+
+## Method Summary
+
+### next
+
+**Signature:** `next() : Object`
+
+Returns an iterator result object.
+
+## Method Detail
+
+## Method Details
+
+### next
+
+**Signature:** `next() : Object`
+
+**Description:** Returns an iterator result object. An iterator result object can have two properties: done and value. If done is false or undefined, then the value property contains an iterator value. The value property may not be present if the value would be undefined. After a call that returns a result where done equals true, all subsequent calls must also return done as true.
+
+---

package/docs/TopLevel/Error.md

@@ -0,0 +1,88 @@
+## Package: TopLevel
+
+# Class Error
+
+## Inheritance Hierarchy
+
+- Object
+  - Error
+
+## Description
+
+Error represents a generic exception.
+
+## Properties
+
+### message
+
+**Type:** String
+
+An error message that provides details about the exception.
+
+### name
+
+**Type:** String
+
+The name of the error based on the constructor used.
+
+### stack
+
+**Type:** String
+
+The script stack trace. 
+ This property is filled on throwing or via an explicit call captureStackTrace(Error, Function).
+
+## Constructor Summary
+
+Error() Constructs the Error object.
+
+Error(msg : String) Constructs the Error object using the specified message.
+
+## Method Summary
+
+### captureStackTrace
+
+**Signature:** `static captureStackTrace(error : Error, constructorOpt : Function) : void`
+
+Fills the stack property for the passed error.
+
+### toString
+
+**Signature:** `toString() : String`
+
+Returns a String representation of the Error.
+
+## Constructor Detail
+
+## Method Detail
+
+## Method Details
+
+### captureStackTrace
+
+**Signature:** `static captureStackTrace(error : Error, constructorOpt : Function) : void`
+
+**Description:** Fills the stack property for the passed error. The optional constructorOpt parameter allows you to pass in a function value. When collecting the stack trace all frames above the topmost call to this function, including that call, are left out of the stack trace. This can be useful to hide implementation details that won’t be useful to the user. The usual way of defining a custom error that captures a stack trace would be: function MyError() { // fill the stack trace, but hide the call to MyError Error.captureStackTrace(this, MyError); }
+
+**API Versioned:**
+
+From version 21.2.
+
+**Parameters:**
+
+- `error`: The error whose stack trace should be filled.
+- `constructorOpt`: An optional filter to hide the topmost stack frames.
+
+---
+
+### toString
+
+**Signature:** `toString() : String`
+
+**Description:** Returns a String representation of the Error.
+
+**Returns:**
+
+a String representation of the Error.
+
+---

package/docs/TopLevel/EvalError.md

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

package/docs/TopLevel/Fault.md

@@ -0,0 +1,87 @@
+## Package: TopLevel
+
+# Class Fault
+
+## Inheritance Hierarchy
+
+- Object
+  - TopLevel.Error
+  - Fault
+
+## Description
+
+This error indicates an RPC related error in the system. The Fault is always related to a systems internal Java exception. The class provides access to some more details about this internal Java exception. In particular it provides details about the error send from the remote system.
+
+## 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.
+
+### faultActor
+
+**Type:** String
+
+Provides some information on who cause the fault along the message
+ path.
+
+### faultCode
+
+**Type:** String
+
+An identifier for the specific fault.
+
+### faultDetail
+
+**Type:** String
+
+More detailed information about the fault.
+
+### faultString
+
+**Type:** String
+
+A human readable description for the fault.
+
+### 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
+
+Fault()
+
+## Method Summary
+
+## Constructor Detail

package/docs/TopLevel/Float32Array.md

@@ -0,0 +1,124 @@
+## Package: TopLevel
+
+# Class Float32Array
+
+## Inheritance Hierarchy
+
+- Object
+  - Float32Array
+
+## Description
+
+An optimized array to store 32-bit floating point 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
+
+Float32Array() Creates an empty array.
+
+Float32Array(length : Number) Creates an array with the given element count.
+
+Float32Array(typedArray : Object) Creates an array as a copy of the passed typed array.
+
+Float32Array(array : Array) Creates an array as a copy of the passed array.
+
+Float32Array(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) : Float32Array`
+
+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) : Float32Array`
+
+**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/Float64Array.md

@@ -0,0 +1,124 @@
+## Package: TopLevel
+
+# Class Float64Array
+
+## Inheritance Hierarchy
+
+- Object
+  - Float64Array
+
+## Description
+
+An optimized array to store 64-bit floating point 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
+
+Float64Array() Creates an empty array.
+
+Float64Array(length : Number) Creates an array with the given element count.
+
+Float64Array(typedArray : Object) Creates an array as a copy of the passed typed array.
+
+Float64Array(array : Array) Creates an array as a copy of the passed array.
+
+Float64Array(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) : Float64Array`
+
+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) : Float64Array`
+
+**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/Function.md

@@ -0,0 +1,105 @@
+## Package: TopLevel
+
+# Class Function
+
+## Inheritance Hierarchy
+
+- Object
+  - Function
+
+## Description
+
+The Function class represent a JavaScript function.
+
+## Properties
+
+### length
+
+**Type:** Number
+
+The number of named arguments that were specified
+ when the function was declared.
+
+### prototype
+
+**Type:** Object
+
+An object that defines properties and methods
+ shared by all objects created with that
+ constructor function.
+
+## Constructor Summary
+
+Function(args : String...) 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
+
+### apply
+
+**Signature:** `apply(thisobj : Object, args : Array) : Object`
+
+Invokes this function as a method of the specified object passing the specified Array of arguments.
+
+### call
+
+**Signature:** `call(thisobj : Object, args : Object...) : Object`
+
+Invokes this function as a method of the specified object passing the specified optional arguments.
+
+### toString
+
+**Signature:** `toString() : String`
+
+Returns a String representation of this function object.
+
+## Constructor Detail
+
+## Method Detail
+
+## Method Details
+
+### apply
+
+**Signature:** `apply(thisobj : Object, args : Array) : Object`
+
+**Description:** 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
+
+**Signature:** `call(thisobj : Object, args : Object...) : Object`
+
+**Description:** 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
+
+**Signature:** `toString() : String`
+
+**Description:** Returns a String representation of this function object.
+
+**Returns:**
+
+a String representation of this function object.
+
+---

package/docs/TopLevel/Generator.md

@@ -0,0 +1,78 @@
+## Package: TopLevel
+
+# Class Generator
+
+## Inheritance Hierarchy
+
+- Object
+  - Generator
+
+## Description
+
+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() " "); }
+
+## Constructor Summary
+
+Generator()
+
+## Method Summary
+
+### close
+
+**Signature:** `close() : void`
+
+Closes the iteration of the generator.
+
+### next
+
+**Signature:** `next() : Object`
+
+Resumes the iteration of the generator by continuing the function at the statement after the yield statement.
+
+### send
+
+**Signature:** `send(value : Object) : Object`
+
+Allows you to control the resumption of the iterative algorithm.
+
+## Constructor Detail
+
+## Method Detail
+
+## Method Details
+
+### close
+
+**Signature:** `close() : void`
+
+**Description:** 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
+
+**Signature:** `next() : Object`
+
+**Description:** 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
+
+---
+
+### send
+
+**Signature:** `send(value : Object) : Object`
+
+**Description:** 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.
+
+---