fix(container-reference): add/update API reference blocks #12511
+53
−11
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.
Description (required)
Updates
container-reference.mdx
(no text changes, only API documentation) with the following changes:create()
typestreaming
defaultrenderers
defaultrenderToString()
typerenderToResponse()
typerouteType
type: the type we show is incomplete, we are missingredirect
andfallback
. Since the type is public, I think we can just useRouteType
both inContainerRenderOptions
and the option description to prevent an outdated type.partial
toContainerRenderOptions
(the option is already documented)Note:
AstroContainerOptions
is incomplete based on the source code but I recall at least one of the available option do not work (withastro/astro#11585) so it is probably fine to leave it as it is for now!Related issues & labels (optional)
consistency/formatting
,improve or update documentation