runtime-config-loader 6.0.0 → 6.0.1

package/README.md

@@ -8,51 +8,50 @@ This library provides an easy way to load one or more JSON files with configurat
 
 ## How to Implement
 
-In your `app.module.ts` file, add the following to the `@NgModule` decorator:
+In your `app.config.ts` file, add the following to the `providers` array:
 
 ```ts
-imports: [..., RuntimeConfigLoaderModule, ...],
+import { provideRuntimeConfig } from 'runtime-config-loader';
+
+export const appConfig: ApplicationConfig = {
+  providers: [
+    ...,
+    provideRuntimeConfig({ configUrl: './assets/config.json' }),
+    ...
+  ]
+};
 ```
 
-That's it; it's that simple. In the `RuntimeConfigLoaderModule`, the `APP_INITIALIZER` token is used to run a function which loads the configuration from a file or an API endpoint that can be used throughout the application.
+That's it; it's that simple. The `provideRuntimeConfig` function sets up the `APP_INITIALIZER` token to load the configuration from a file or an API endpoint before the application starts.
 
-If you implement the library exactly as it is above, the configuration file needs to be in the `./assets/config.json` location as mentioned above. If you'd like to load the file from a different location, provide that location in the `.forRoot()` method when importing the `RuntimeConfigLoaderModule`:
+### Configuration
 
-```ts
-imports: [
-  ...,
-  RuntimeConfigLoaderModule.forRoot(
-    { configUrl: './path/to/config/config.json' }
-  ),
-  ...]
-```
+The `provideRuntimeConfig` function accepts a configuration object with a `configUrl` property. This can be a single string or an array of strings.
 
-If you want to load multiple files, the value of `configUrl` should be an array of strings:
+#### Single Config File
+
+The default location is `./assets/config.json`. If you'd like to load the file from a different location:
 
 ```ts
-imports: [
-  ...,
-  RuntimeConfigLoaderModule.forRoot(
-    { configUrl: ['./path/to/config/config-1.json', './path/to/config/config-2.json'] }
-  ),
-  ...]
+provideRuntimeConfig({ configUrl: './path/to/config/config.json' });
 ```
 
-> Make sure that the path(s) you provide here is accessible by the Angular application, meaning that the file is somewhere the app can load it. In my opinion, the `assets` folder is the easiest place to work from.
-
-## Multiple Config Paths
+#### Multiple Config Files
 
-One reason you may want to load multiple configuration objects is so that you can set the configuration on your machine without affecting anyone else. For example, you could have a `local.config.json` file that is not included in source control. Some of the values in that file would overwrite the values in a config file that everyone can use. Another use case is that some config values don't change between environments, and some do. The ones that don't change could go in one file, the ones that do change could go in a second file. Each developer/environment can provide the second file with values they want or need.
-
-It's important to know that if an attribute is repeated in two configuration files, the latest value is kept. So, let's say you have `apiUrl` in both files, `config-1.json` and `config-2.json`. Let's assume the files are passed in to the `forRoot` method like this:
+You can load multiple files (or API endpoints) and they will be merged into a single configuration object.
 
 ```ts
-imports: [
-  ...,
-  RuntimeConfigLoaderModule.forRoot(
-    { configUrl: ['./path/to/config/config-1.json', './path/to/config/config-2.json'] }
-  ),
-  ...]
+provideRuntimeConfig({
+	configUrl: [
+		'./path/to/config/config-1.json',
+		'./path/to/config/config-2.json',
+	],
+});
 ```
 
-In this case, the `apiUrl` value from `config-2.json` will override the value from `config-1.json`.
+If an attribute is repeated in multiple configuration files, the latest value is kept. For example, if `apiUrl` exists in both files above, the value from `config-2.json` will override the value from `config-1.json`.
+
+> [!TIP]
+> This is useful for maintaining local overrides (e.g., `local.config.json` ignored by git) or separating environment-specific values from global ones.
+
+Make sure that the path(s) you provide are accessible by the Angular application. The `assets` folder is generally the easiest place to serve these files.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "runtime-config-loader",
-  "version": "6.0.0",
+  "version": "6.0.1",
   "author": {
     "email": "preston.j.lamb@gmail.com",
     "name": "Preston Lamb",