getConfig Method Guidelines for SuiteCommerce Configuration

The getConfig(key) method is essential for accessing configuration properties within SuiteCommerce. Here are some crucial guidelines on how to use this method effectively:

Dot-Notation

You can easily access the hierarchy of configuration properties using dot-notation. For instance, calling getConfig('checkoutApp') will yield a JavaScript object that contains the skipLogin property value. The following API calls all retrieve the value of the skipLogin property:

getConfig('checkoutApp.skipLogin')
getConfig('checkoutApp').skipLogin
getConfig().checkoutApp.skipLogin

Read-Only Values

It’s important to note that the getConfig() method returns a copy of the configuration or configuration property, meaning that the values are read-only. If you wish to modify a configuration property, you'll need to do so through the SuiteCommerce Configuration record. For guidance, refer to the Site Configuration documentation.

Avoid Using getConfig() Without a Key

Although using getConfig() without specifying a key is an option, it’s generally discouraged. Without a key, the application attempts to return the entire configuration object, which may result in an excessively large object on certain pages, potentially causing an internal error (e.g., InternalError: too much recursion) or a range error (e.g., RangeError: Maximum call stack size exceeded).

By following these guidelines, you can effectively utilize the getConfig() method while avoiding common pitfalls associated with read-only values and overloading the configuration object.