Platform: Docs for router-store has wrong config

Created on 29 Sep 2018  路  2Comments  路  Source: ngrx/platform

Other information:

code in platform/docs/router-store/api.md

interface StoreRouterConfig {
  stateKey?: string;
  serializer?: new (...args: any[]) => RouterStateSerializer;
  navigationActionTiming?: NavigationActionTiming;
}

but in "@ngrx/router-store": "^6.1.0",

export interface StoreRouterConfig {
    stateKey?: string;
}
export declare type StoreRouterConfigFunction = () => StoreRouterConfig;

How to config router with new version?
I have not used before

I would be willing to submit a PR for the docs :heart:

[x ] Yes (Assistance is provided if you need help submitting a pull request)
[ ] No

All 2 comments

This will become available in the next version.
To use it now you can install ngrx from the nightly builds.

I think it is confusing, as it is not present on main package but referenced on the main documentation. At least an explanation pointing that to use it ngrx router nightly builds is needed, could avoid misunderstandings.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

ghost picture ghost  路  3Comments

NathanWalker picture NathanWalker  路  3Comments

brandonroberts picture brandonroberts  路  3Comments

oxiumio picture oxiumio  路  3Comments

itprodavets picture itprodavets  路  3Comments