feat: add support for custom router state serializer #361
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.
This PR adds support for custom router state serializers to both
provideGlobalRouterStore
andprovideLocalRouterStore
, bringing feature parity with@ngrx/router-store
.Problem
As noted in the comparison documentation, Router Component Store previously used a serializer similar to
MinimalRouterStateSerializer
but did not support custom router state serializers, unlike NgRx Router Store which supports this through a serializer setting.Solution
This implementation adds:
Core API
RouterStateSerializer<T>
interface - Allows custom serializers with type safetyROUTER_STATE_SERIALIZER
injection token - Enables dependency injection of custom serializersRouterStoreConfig<T>
interface - Configuration object for provider functionsProvider Updates
Both provider functions now accept an optional configuration parameter:
Example Custom Serializer
Backward Compatibility
✅ Zero breaking changes - All existing code continues to work unchanged. When no custom serializer is provided, the default
MinimalRouterStateSerializer
is used automatically.Use Cases
This feature enables:
Testing
Documentation
This brings Router Component Store to full feature parity with
@ngrx/router-store
regarding custom serialization while maintaining the lightweight, type-safe approach that makes it an excellent alternative to both NgRx Router Store andActivatedRoute
.Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.