Document customizing getKey and getData fetching #241
Conversation
…erent route parameter value to them)
|
docs/resources/creation.md
Outdated
| @@ -17,9 +17,9 @@ export const userProfileResource = createResource({ | |||
| | Property | type | Description | | |||
| | --------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | |||
| | `type` | `string` | Used as a namespace for this resource. Each resource should have a unique type | | |||
| | `getKey` | `(routerContext, customContext) => string` | The return value of this function is used to identify this resource within the `type` namespace. The function itself is supplied with `routerContext` and `customContext` so that the composition of keys can use this data if required | | |||
| | `getData` | `(routerExtendedContext, customContext) => Promise<any>` | This function is used to load the data for the resource. The function should return a promise and resolve with the resource data object. NOTE: You may not use `getData` and `getDataLoader` on the same resource | | |||
| | `getKey` | `(routerContext, customContext) => string` | The return value of this function is used to identify this resource within the `type` namespace. The function itself is supplied with `routerContext` and `customContext` so that the composition of keys can use this data if required. `customContext` comes from the top level Router component, therefore changing it will cause a re-render of almost everything in your React app. You may want to pass a custom `routerContext` instead. How to do this - see the ["Accessing resource state for another route or url"](https://atlassian-labs.github.io/react-resource-router/#/resources/usage?id=accessing-resource-state-for-another-route-or-url) section. The router will fetch and cache data for that route then. | | |||
There was a problem hiding this comment.
I don't quite understand this sentence in the context of getKey function.
therefore changing it will cause a re-render of almost everything in your React app
customContext is immutable within getKey function scope, isn't it?
There was a problem hiding this comment.
That's what Alberto said, can you please clarify with him, and make edits if necessary?
Afaiu, if we put a new prop into customContext, it means that all child components of Router will get re-evaluated. And it was not recommended for that reason. But yes, adding more specific details here'd be helpful, I just don't have them :)
There was a problem hiding this comment.
Maybe the confusion is because describing side effects of changing customContext while we talk about resources is misleading. Maybe something like this is easer to grasp?
The function itself is supplied with
routerContextandcustomContextso that the composition of keys can use this data if required.customContextcomes from the top level Router component and therefore is value is equal across resources.routerContextcontains the current route and location data, which comes from the current URL or from some manually provided value (see the "Accessing resource state for another route or url" section). The router will fetch and cache data for that route then.
There was a problem hiding this comment.
Lgtm. @liamqma is Alberto's version clearer? I've updated the PR.
There was a problem hiding this comment.
Make senses. Thank you @albertogasparin and @DmitryGonchar
e.g. to pass a different route parameter value to them.
These clarifications are result of a pairing session with @albertogasparin