Question 1

How do I set up aurelia-configuration with Aurelia CLI?

Accepted Answer

You need to manually add an entry in the aurelia.json file under dependencies, specifying the path and main file for the plugin, as shown in the README. This extra configuration step is required for proper module resolution in CLI-based projects.

Question 2

Can aurelia-configuration load config from an API instead of a file?

Accepted Answer

Yes, you can use the merge method to integrate configuration objects fetched from an API into the local settings. However, the initial load still requires a JSON file, and updates need to be manually merged, which might not be seamless for real-time changes.

Question 3

What's the difference between aurelia-configuration and just using environment variables?

Accepted Answer

Aurelia-configuration provides a structured, namespaced way to manage settings with environment-specific cascading and dynamic switching, while environment variables are simpler but lack organization and built-in fallback mechanisms for complex apps.

Question 4

How to switch environments based on the URL in aurelia-configuration?

Accepted Answer

Use the setEnvironments method during bootstrapping to map domains to environments, like specifying development for localhost. The plugin will automatically detect the current domain and apply the corresponding configuration.

Question 5

Is aurelia-configuration compatible with Webpack builds?

Accepted Answer

Yes, but you must use PLATFORM.moduleName to help Webpack resolve the module, as specified in the README. This ensures the plugin is correctly bundled and avoids runtime errors.

Question 6

How can I set a default value if a config key is missing?

Accepted Answer

Use the get method with a second argument for the default value, such as config.get('api.key', 'default123'). This provides a fallback and prevents null returns for missing settings in your code.

Aurelia-Configuration

What is Aurelia-Configuration?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions