[docs] TypeScript withEnvironment: add ExternalServiceResource to union type example#1048
Merged
sebastienros merged 1 commit intoMay 23, 2026
Conversation
Documents microsoft/aspire#17393 — TypeScript withEnvironment now accepts IResourceBuilder<ExternalServiceResource>, matching the C# overload. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
14 tasks
sebastienros
approved these changes
May 23, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the integration authoring documentation to reflect Aspire 13.4’s expanded TypeScript withEnvironment union support by including IResourceBuilder<ExternalServiceResource> in the [AspireUnion] example.
Changes:
- Added
typeof(IResourceBuilder<ExternalServiceResource>)to the[AspireUnion]declaration in the Union types documentation example.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents changes from microsoft/aspire#17393 by
@maddymontaquila.Targeting
release/13.4based on the source PR milestone13.4(exact match on microsoft/aspire.dev).Why this PR is needed
Aspire 13.4 extended the TypeScript
withEnvironmentdispatcher to acceptIResourceBuilder<ExternalServiceResource>as a value, matching the long-standing C#WithEnvironment(name, externalService)overload. Previously the generated TypeScript union omittedExternalServiceResource, causing type-checking failures when users tried to pass an external service resource. For example, this pattern now works:The documentation's Union types section showed the
withEnvironmentexample withoutExternalServiceResourcein the[AspireUnion]declaration. This PR corrects that example.Changes
src/frontend/src/content/docs/extensibility/multi-language-integration-authoring.mdx— addedIResourceBuilder<ExternalServiceResource>to the[AspireUnion]example in the Union types section.Files modified
src/frontend/src/content/docs/extensibility/multi-language-integration-authoring.mdx(updated)