Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: replace interfaces with type aliases on configuration page #2117

Closed
wants to merge 1 commit into from
Closed

docs: replace interfaces with type aliases on configuration page #2117

wants to merge 1 commit into from

Conversation

micalevisk
Copy link
Member

@micalevisk micalevisk commented Nov 22, 2021

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Docs
  • Other... Please describe:

What is the current behavior?

Examples on https://docs.nestjs.com/techniques/configuration are taking in count @nestjs/config@1.1.0

What is the new behavior?

After this change on @nestjs/config: nestjs/config@b85f734 we can no longer use TypeScript interfaces on ConfigService type arg due to TSC constraint errors (see microsoft/TypeScript#42825 (comment))

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

I chose to update only the interface that will be passed to ConfigService, not the ones used by ConfigService#get, let me know if this is fine

After this change on `@nestjs/config`: nestjs/config@b85f734
we can no longer use TypeScript interfaces on `ConfigService` type arg due to TSC constraint errors
@kamilmysliwiec
Copy link
Member

Actually, that's a regression that our e2e should have caught. I've just reverted that commit & will think how to address this issue.

@micalevisk micalevisk deleted the patch-1 branch November 22, 2021 13:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants