chore: update README for custom loader

kevinvdburgt-archive · May 9, 2021 · 51c2e0d · 51c2e0d
1 parent abde826
commit 51c2e0d
Showing 1 changed file with 13 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -404,7 +404,19 @@ TypedConfigModule.forRoot({
 
 ### Using custom loader
 
-If native loaders provided by `nest-typed-config` can't meet your needs, 
+If native loaders provided by `nest-typed-config` can't meet your needs, you can implement a custom  loader. This can be achieved by providing a function which returns the configuration object synchronously or asynchronously through the `load` option. For example:
+
+```ts
+TypedConfigModule.forRoot({
+    schema: RootConfig,
+    load: async () => {
+        return {
+            host: '127.0.0.1',
+            port: 3000
+        }
+    },
+})
+```
 
 ## License