docs: correct custom loader example in README - Githubissues

Nikaple / nest-typed-config

Intuitive, type-safe configuration module for Nest framework ✨

MIT License

204 stars 25 forks source link

docs: correct custom loader example in README #498

Closed techzealot closed 10 months ago

techzealot commented 10 months ago

TypedConfigModule should not use async funtion,or the config will not work.

PR Checklist

Please check if your PR fulfills the following requirements:

[x] The commit message follows our guidelines: https://github.com/Nikaple/nest-typed-config/blob/main/CONTRIBUTING.md
[ ] Tests for the changes have been added (for bug fixes / features)
[ ] Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

[ ] Related issue linked using fixes #number
[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[x] Other... Please describe: docs

What is the current behavior?

when we cutom our own loader following by the example using async funtion,the config will not work.

Issue Number: N/A

What is the new behavior?

TypedConfigModule should not use async function in the example

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

github-actions[bot] commented 8 months ago

:tada: This PR is included in version 2.9.3 :tada:

The release is available on:

Your semantic-release bot :package::rocket: