Skip to content

docs(core): remove reference to ServerTransferStateModule from TransferState - #71052

Merged
kirjs merged 1 commit into
angular:mainfrom
GabeSilvaDev:docs/transfer-state-removed-module
Oct 1, 2026
Merged

kirjs merged 1 commit into
angular:mainfrom
GabeSilvaDev:docs/transfer-state-removed-module

Conversation

@GabeSilvaDev

@GabeSilvaDev GabeSilvaDev commented Sep 29, 2026 •

Copy link
Copy Markdown
Contributor

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
  • CI related changes
  • Documentation content changes
  • angular.dev application / infrastructure changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

The TransferState API docs still tell users to import ServerTransferStateModule when using the server without renderApplication.

That module was removed in v18 in #54874, and the update guide already tells users to remove the import because it is no longer needed.

What is the new behavior?

The outdated server note is removed from the JSDoc. TransferState is providedIn: 'root', so no setup is needed on the server either.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

This is a JSDoc-only change in packages/core/src/transfer_state.ts.

@pullapprove
pullapprove Bot requested a review from JeanMeche September 29, 2026 17:58
@angular-robot angular-robot Bot added area: docs Related to the documentation area: core Issues related to the framework runtime labels Sep 29, 2026
@ngbot ngbot Bot added this to the Backlog milestone Sep 29, 2026
Comment thread packages/core/src/transfer_state.ts Outdated
Comment on lines +61 to +63
* On the client, just inject this token using DI and use it, it will be lazily initialized.
* On the server it's already included if `renderApplication` function is used. Otherwise, import
* the `ServerTransferStateModule` module to make the `TransferState` available.
* On the server it's set up by `provideServerRendering()` (or `ServerModule` in NgModule-based
* applications), so no additional import is needed.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The token is provided in root. Am I missing something we don't even need to mention that at all ?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, it's providedIn: 'root', so there's nothing to set up on either side. Updated to drop the server note entirely.

…erState

ServerTransferStateModule was removed in v18. TransferState is provided in root, so no setup is needed on the server either; drop the outdated server note.
@GabeSilvaDev
GabeSilvaDev force-pushed the docs/transfer-state-removed-module branch from c492880 to f34025f Compare September 30, 2026 04:35
@JeanMeche JeanMeche added action: merge The PR is ready for merge by the caretaker target: patch This PR is targeted for the next patch release labels Sep 30, 2026
@kirjs
kirjs merged commit 8608325 into angular:main Oct 1, 2026
25 of 27 checks passed
@kirjs

kirjs commented Oct 1, 2026

Copy link
Copy Markdown
Contributor

This PR was merged into the repository. The changes were merged into the following branches:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

action: merge The PR is ready for merge by the caretaker area: core Issues related to the framework runtime area: docs Related to the documentation target: patch This PR is targeted for the next patch release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants