sfcc-dev-mcp 1.0.19 → 1.0.21

package/docs/dw_system/Cache.md

@@ -1,102 +0,0 @@
-## Package: dw.system
-
-# Class Cache
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.system.Cache
-
-## Description
-
-The Cache class represents a custom cache. A cache stores data over multiple requests. Each cartridge can define its own caches for different business requirements. To limit the visibility of cache entries by scope, for example, by site, catalog, or external system, include the scope reference when constructing the key. For example: var cache = CacheMgr.getCache( 'SiteConfigurations' ); cache.get( Site.current.ID + "config", function loadSiteConfiguration() {return loadCfg( Site.current );} ); Do not build the cache key using personal user data, since the key might be visible in log messages. There is never a guarantee that a stored object can be retrieved from the cache. The storage allocated for entries is limited and clearing or invalidation might occur at any time. To maintain the cache size limits, the cache evicts entries that are less likely to be used again. For example, the cache might evict an entry because it hasn't been used recently or very often. Cache entries aren't synchronized between different application servers. The cache returns immutable copies of the original objects put into the cache. Lists are converted to arrays during this process. Only JavaScript primitive values and tree-like object structures can be stored as entries. Object structures can consist of arrays, lists, and basic JavaScript objects. Script API classes are not supported, except List and its subclasses. null can be stored as a value. undefined can't be stored. See CacheMgr for details about how to configure a custom cache.
-
-## Constructor Summary
-
-## Method Summary
-
-### get
-
-**Signature:** `get(key : String, loader : Function) : Object`
-
-Returns the value associated with key in this cache, or invokes the loader function to generate the entry if there is no entry found.
-
-### get
-
-**Signature:** `get(key : String) : Object`
-
-Returns the value associated with key in this cache.
-
-### invalidate
-
-**Signature:** `invalidate(key : String) : void`
-
-Removes the cache entry for key (if one exists) manually before the cache's eviction strategy goes into effect.
-
-### put
-
-**Signature:** `put(key : String, value : Object) : void`
-
-Stores the specified entry directly into the cache, replacing any previously cached entry for key if one exists.
-
-## Method Detail
-
-## Method Details
-
-### get
-
-**Signature:** `get(key : String, loader : Function) : Object`
-
-**Description:** Returns the value associated with key in this cache, or invokes the loader function to generate the entry if there is no entry found. The generated entry is stored for future retrieval. If the loader function returns undefined, this value is not stored in the cache.
-
-**Parameters:**
-
-- `key`: The cache key.
-- `loader`: The loader function that is called if no value is stored in the cache.
-
-**Returns:**
-
-The value found in the cache or the value returned from the loader function call.
-
----
-
-### get
-
-**Signature:** `get(key : String) : Object`
-
-**Description:** Returns the value associated with key in this cache. If there is no entry in the cache then undefined is returned.
-
-**Parameters:**
-
-- `key`: The cache key.
-
-**Returns:**
-
-The stored value or undefined if no value is found in the cache.
-
----
-
-### invalidate
-
-**Signature:** `invalidate(key : String) : void`
-
-**Description:** Removes the cache entry for key (if one exists) manually before the cache's eviction strategy goes into effect.
-
-**Parameters:**
-
-- `key`: The cache key.
-
----
-
-### put
-
-**Signature:** `put(key : String, value : Object) : void`
-
-**Description:** Stores the specified entry directly into the cache, replacing any previously cached entry for key if one exists. Storing undefined as value has the same effect as calling invalidate(String) for that key.
-
-**Parameters:**
-
-- `key`: The cache key.
-- `value`: The value to be store in the cache.
-
----

package/docs/dw_system/CacheMgr.md

@@ -1,42 +0,0 @@
-## Package: dw.system
-
-# Class CacheMgr
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.system.CacheMgr
-
-## Description
-
-The CacheMgr class is the entry point for using custom caches. The CacheMgr can manage multiple custom caches that share one storage space. Each individual cache has a unique ID and an optional expiration time that specifies the maximum time (in seconds) an entry is stored in the cache. For registering caches inside the cartridge root folder, a 'package.json' file with a 'caches' entry must exist. The registration of caches is independent of any site context. "caches": "./caches.json" The caches entry links to a JSON file, with a path relative to the 'package.json' file. This file lists all registered caches inside the caches property: { "caches": [ { "id": "UnlimitedTestCache" }, { "id": "TestCacheWithExpiration", "expireAfterSeconds": 10 } ] }
-
-## Constructor Summary
-
-## Method Summary
-
-### getCache
-
-**Signature:** `static getCache(cacheID : String) : Cache`
-
-Returns the defined cache instance for the given ID.
-
-## Method Detail
-
-## Method Details
-
-### getCache
-
-**Signature:** `static getCache(cacheID : String) : Cache`
-
-**Description:** Returns the defined cache instance for the given ID. Throws an exception when the requested cache has not been defined in any caches.json descriptor.
-
-**Parameters:**
-
-- `cacheID`: The ID of the cache.
-
-**Returns:**
-
-The registered cache.
-
----

package/docs/dw_system/HookMgr.md

@@ -1,66 +0,0 @@
-## Package: dw.system
-
-# Class HookMgr
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.system.HookMgr
-
-## Description
-
-This class provides functionality to call hooks. A hook is an extension point in the business logic, where you can register scripts to customize functionality.
-
-## Constructor Summary
-
-## Method Summary
-
-### callHook
-
-**Signature:** `static callHook(extensionPoint : String, function : String, args : Object...) : Object`
-
-Calls a hook on base of the specified extensionPoint and function.
-
-### hasHook
-
-**Signature:** `static hasHook(extensionPoint : String) : boolean`
-
-Checks whether a hook is registered or a system default implementation exists for this extension point.
-
-## Method Detail
-
-## Method Details
-
-### callHook
-
-**Signature:** `static callHook(extensionPoint : String, function : String, args : Object...) : Object`
-
-**Description:** Calls a hook on base of the specified extensionPoint and function. If a hook throws an exception, then this method will also throw an exception. If no hook and no system default implementation is provided, then this method will return undefined. Sample: dw.system.HookMgr.callHook( "dw.order.calculate", "calculate", basket );
-
-**Parameters:**
-
-- `extensionPoint`: the extension point to call
-- `function`: the script function to call
-- `args`: the Array of function parameters
-
-**Returns:**
-
-the object returned by the hook or undefined
-
----
-
-### hasHook
-
-**Signature:** `static hasHook(extensionPoint : String) : boolean`
-
-**Description:** Checks whether a hook is registered or a system default implementation exists for this extension point. extensionPoint refers to the same name used to register a script as implementation. With this method it's only possible to check for a whole script registered but it is not possible to check, whether an individual function is implemented. Sample: dw.system.HookMgr.hasHook( "dw.order.calculate" );
-
-**Parameters:**
-
-- `extensionPoint`: the extension point
-
-**Returns:**
-
-true, if a hook is registered or a default implementation exists, otherwise false
-
----

package/docs/dw_system/InternalObject.md

@@ -1,56 +0,0 @@
-## Package: dw.system
-
-# Class InternalObject
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.system.InternalObject
-
-## Description
-
-Class used to wrap internal objects to hide them from B2C Commerce Script code.
-
-## Constructor Summary
-
-## Method Summary
-
-### toString
-
-**Signature:** `toString() : String`
-
-Returns a string representation of this object.
-
-### valueOf
-
-**Signature:** `valueOf() : String`
-
-Returns a string representation of this object.
-
-## Method Detail
-
-## Method Details
-
-### toString
-
-**Signature:** `toString() : String`
-
-**Description:** Returns a string representation of this object.
-
-**Returns:**
-
-a string representation of this object.
-
----
-
-### valueOf
-
-**Signature:** `valueOf() : String`
-
-**Description:** Returns a string representation of this object.
-
-**Returns:**
-
-a string representation of this object.
-
----

package/docs/dw_system/JobProcessMonitor.md

@@ -1,124 +0,0 @@
-## Package: dw.system
-
-# Class JobProcessMonitor
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.system.JobProcessMonitor
-
-## Description
-
-Reserved for future use.
-
-## Properties
-
-### totalWork
-
-**Type:** Number
-
-Reserved for future use. Gets the total work count.
-
-### workMessage
-
-**Type:** String
-
-Reserved for future use. Gets the work message.
-
-## Constructor Summary
-
-## Method Summary
-
-### getTotalWork
-
-**Signature:** `getTotalWork() : Number`
-
-Reserved for future use.
-
-### getWorkMessage
-
-**Signature:** `getWorkMessage() : String`
-
-Reserved for future use.
-
-### setTotalWork
-
-**Signature:** `setTotalWork(totalWork : Number) : void`
-
-Reserved for future use.
-
-### setWorkMessage
-
-**Signature:** `setWorkMessage(msg : String) : void`
-
-Reserved for future use.
-
-### worked
-
-**Signature:** `worked(worked : Number) : void`
-
-Reserved for future use.
-
-## Method Detail
-
-## Method Details
-
-### getTotalWork
-
-**Signature:** `getTotalWork() : Number`
-
-**Description:** Reserved for future use. Gets the total work count.
-
-**Returns:**
-
-the total work count.
-
----
-
-### getWorkMessage
-
-**Signature:** `getWorkMessage() : String`
-
-**Description:** Reserved for future use. Gets the work message.
-
-**Returns:**
-
-the work message.
-
----
-
-### setTotalWork
-
-**Signature:** `setTotalWork(totalWork : Number) : void`
-
-**Description:** Reserved for future use. Sets the total work count.
-
-**Parameters:**
-
-- `totalWork`: the total work count.
-
----
-
-### setWorkMessage
-
-**Signature:** `setWorkMessage(msg : String) : void`
-
-**Description:** Reserved for future use. Sets the work message.
-
-**Parameters:**
-
-- `msg`: the messageto use. If msg is null, then an empty string will be used.
-
----
-
-### worked
-
-**Signature:** `worked(worked : Number) : void`
-
-**Description:** Reserved for future use. Increments the count of work items by the value of the specified parameter.
-
-**Parameters:**
-
-- `worked`: the number of items worked.
-
----

package/docs/dw_system/Log.md

@@ -1,237 +0,0 @@
-## Package: dw.system
-
-# Class Log
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.system.Log
-
-## Description
-
-A log4j like logger instance. To obtain such an instance, use the Logger.getRootLogger() or Logger.getLogger(String) or Logger.getLogger(String, String) methods.
-
-## Properties
-
-### debugEnabled
-
-**Type:** boolean (Read Only)
-
-This method returns true if debug logging is enabled for this logging instance.
-
-### errorEnabled
-
-**Type:** boolean (Read Only)
-
-This method returns true if error logging is enabled for this logging instance.
-
-### infoEnabled
-
-**Type:** boolean (Read Only)
-
-This method returns true if information logging is enabled for this logging instance.
-
-### NDC
-
-**Type:** LogNDC (Read Only)
-
-The Nested Diagnostic Context for this script call.
-
-### warnEnabled
-
-**Type:** boolean (Read Only)
-
-This method returns true if warning logging is enabled for this logging instance.
-
-## Constructor Summary
-
-## Method Summary
-
-### debug
-
-**Signature:** `debug(msg : String, args : Object...) : void`
-
-The method reports an debug level message.
-
-### error
-
-**Signature:** `error(msg : String, args : Object...) : void`
-
-The method reports an error level message.
-
-### fatal
-
-**Signature:** `fatal(msg : String, args : Object...) : void`
-
-The method reports an warning level message.
-
-### getNDC
-
-**Signature:** `static getNDC() : LogNDC`
-
-Returns the Nested Diagnostic Context for this script call.
-
-### info
-
-**Signature:** `info(msg : String, args : Object...) : void`
-
-The method reports an information level message.
-
-### isDebugEnabled
-
-**Signature:** `isDebugEnabled() : boolean`
-
-This method returns true if debug logging is enabled for this logging instance.
-
-### isErrorEnabled
-
-**Signature:** `isErrorEnabled() : boolean`
-
-This method returns true if error logging is enabled for this logging instance.
-
-### isInfoEnabled
-
-**Signature:** `isInfoEnabled() : boolean`
-
-This method returns true if information logging is enabled for this logging instance.
-
-### isWarnEnabled
-
-**Signature:** `isWarnEnabled() : boolean`
-
-This method returns true if warning logging is enabled for this logging instance.
-
-### warn
-
-**Signature:** `warn(msg : String, args : Object...) : void`
-
-The method reports an warning level message.
-
-## Method Detail
-
-## Method Details
-
-### debug
-
-**Signature:** `debug(msg : String, args : Object...) : void`
-
-**Description:** The method reports an debug level message. Arguments can be embedded into the message, e.g. like "Failure {0} in {1}". The method implements the Java MessageFormat.format() syntax.
-
-**Parameters:**
-
-- `msg`: the message to log.
-- `args`: the arguments to insert into the message.
-
----
-
-### error
-
-**Signature:** `error(msg : String, args : Object...) : void`
-
-**Description:** The method reports an error level message. Arguments can be embedded into the message, e.g. like "Failure {0} in {1}". The method implements the Java MessageFormat.format() syntax.
-
-**Parameters:**
-
-- `msg`: the message to log.
-- `args`: the arguments to insert into the message.
-
----
-
-### fatal
-
-**Signature:** `fatal(msg : String, args : Object...) : void`
-
-**Description:** The method reports an warning level message. Arguments can be embedded into the message, e.g. like "Failure {0} in {1}". The method implements the Java MessageFormat.format() syntax. Note: Fatal log messages are always enabled and optionally send via E-Mail.
-
-**Parameters:**
-
-- `msg`: the message to log.
-- `args`: the arguments to insert into the message.
-
----
-
-### getNDC
-
-**Signature:** `static getNDC() : LogNDC`
-
-**Description:** Returns the Nested Diagnostic Context for this script call.
-
-**Returns:**
-
-the nested diagnostic context
-
----
-
-### info
-
-**Signature:** `info(msg : String, args : Object...) : void`
-
-**Description:** The method reports an information level message. Arguments can be embedded into the message, e.g. like "Failure {0} in {1}". The method implements the Java MessageFormat.format() syntax.
-
-**Parameters:**
-
-- `msg`: the message to log.
-- `args`: the arguments to insert into the message.
-
----
-
-### isDebugEnabled
-
-**Signature:** `isDebugEnabled() : boolean`
-
-**Description:** This method returns true if debug logging is enabled for this logging instance.
-
-**Returns:**
-
-true if logging of debug messages is enabled, false otherwise.
-
----
-
-### isErrorEnabled
-
-**Signature:** `isErrorEnabled() : boolean`
-
-**Description:** This method returns true if error logging is enabled for this logging instance.
-
-**Returns:**
-
-true if logging of error messages is enabled, false otherwise.
-
----
-
-### isInfoEnabled
-
-**Signature:** `isInfoEnabled() : boolean`
-
-**Description:** This method returns true if information logging is enabled for this logging instance.
-
-**Returns:**
-
-true if logging of information messages is enabled, false otherwise.
-
----
-
-### isWarnEnabled
-
-**Signature:** `isWarnEnabled() : boolean`
-
-**Description:** This method returns true if warning logging is enabled for this logging instance.
-
-**Returns:**
-
-true if logging of warning messages is enabled, false otherwise.
-
----
-
-### warn
-
-**Signature:** `warn(msg : String, args : Object...) : void`
-
-**Description:** The method reports an warning level message. Arguments can be embedded into the message, e.g. like "Failure {0} in {1}". The method implements the Java MessageFormat.format() syntax.
-
-**Parameters:**
-
-- `msg`: the message to log.
-- `args`: the arguments to insert into the message.
-
----

package/docs/dw_system/LogNDC.md

@@ -1,88 +0,0 @@
-## Package: dw.system
-
-# Class LogNDC
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.system.LogNDC
-
-## Description
-
-A Nested Diagnostic Context, or NDC in short, is an instrument to distinguish interleaved log output from different sources. Log output is typically interleaved when a server handles multiple script calls near-simultaneously.
-
-## Constructor Summary
-
-## Method Summary
-
-### peek
-
-**Signature:** `peek() : String`
-
-Looks at the last diagnostic context at the top of this NDC without removing it.
-
-### pop
-
-**Signature:** `pop() : String`
-
-Clients should call this method before leaving a diagnostic context.
-
-### push
-
-**Signature:** `push(message : String) : void`
-
-Push new diagnostic context information for the current script execution.
-
-### remove
-
-**Signature:** `remove() : void`
-
-Remove the diagnostic context for this script call.
-
-## Method Detail
-
-## Method Details
-
-### peek
-
-**Signature:** `peek() : String`
-
-**Description:** Looks at the last diagnostic context at the top of this NDC without removing it. The returned value is the value that was pushed last. If no context is available, then the empty string "" is returned.
-
-**Returns:**
-
-String The innermost diagnostic context.
-
----
-
-### pop
-
-**Signature:** `pop() : String`
-
-**Description:** Clients should call this method before leaving a diagnostic context. The returned value is the value that was pushed last. If no context is available, then the empty string "" is returned. NOTE: The NDC is removed after every script execution.
-
-**Returns:**
-
-String The innermost diagnostic context.
-
----
-
-### push
-
-**Signature:** `push(message : String) : void`
-
-**Description:** Push new diagnostic context information for the current script execution.
-
-**Parameters:**
-
-- `message`: - The new diagnostic context information.
-
----
-
-### remove
-
-**Signature:** `remove() : void`
-
-**Description:** Remove the diagnostic context for this script call.
-
----