From ad887027218ba30dc2d3de441b513f6d18ce9e9f Mon Sep 17 00:00:00 2001 From: Gary Roberts Date: Tue, 13 Sep 2016 12:52:04 +0100 Subject: [PATCH] Corrected misleading routeParams docs comment. The actual type of this.props.params.portfolioId will be a string as opposed to a number. --- docs/API.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/API.md b/docs/API.md index 7fb751060a..9ea96c2568 100644 --- a/docs/API.md +++ b/docs/API.md @@ -544,7 +544,7 @@ The dynamic segments of the URL. The route that rendered this component. #### `routeParams` -A subset of `this.props.params` that were directly specified in this component's route. For example, if the route's path is `users/:userId` and the URL is `/users/123/portfolios/345` then `this.props.routeParams` will be `{userId: '123'}`, and `this.props.params` will be `{userId: '123', portfolioId: 345}`. +A subset of `this.props.params` that were directly specified in this component's route. For example, if the route's path is `users/:userId` and the URL is `/users/123/portfolios/345` then `this.props.routeParams` will be `{userId: '123'}`, and `this.props.params` will be `{userId: '123', portfolioId: '345'}`. #### `children` The matched child route element to be rendered. If the route has [named components](/docs/API.md#named-components) then this will be undefined, and the components will instead be available as direct properties on `this.props`.