docs: add note about using set() third param for logging #712
Conversation
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 523af89:
|
readme.md
Outdated
| devtools will only log actions from each separated store unlike in a typical *combined reducers* redux store. See an approach to combining stores https://github.com/pmndrs/zustand/issues/163 | ||
|
|
||
| Because of this, actions will be logged as "anonymous" by default. To set a default log action type for all actions from your store: `devtools(store, {name: 'MyStore', anonymousActionType: 'MyStoreAction'})` |
There was a problem hiding this comment.
This seems an overlap with L442 example. Just a little bit though. If you have an idea to make the docs compact, it's welcomed.
readme.md
Outdated
| devtools will only log actions from each separated store unlike in a typical *combined reducers* redux store. See an approach to combining stores https://github.com/pmndrs/zustand/issues/163 | ||
|
|
||
| Because of this, actions will be logged as "anonymous" by default. To set a default log action type for all actions from your store: `devtools(store, {name: 'MyStore', anonymousActionType: 'MyStoreAction'})` |
There was a problem hiding this comment.
The recommended approach is to use the third parameter instead of anonymousActionType so let's mention that first.
And then after that let's just write "If the third parameter is not passed, the action type by default becomes "anonymous". You can customize this via the anonymousActionType devtools option. Eg devtool(..., { anonymousActionType: 'unknown', ... })"
It doesn't make sense to use or encourage the store name as anonymousActionType because you can already see the store instance in top right drop-down.
readme.md
Outdated
| devtools will only log actions from each separated store unlike in a typical *combined reducers* redux store. See an approach to combining stores https://github.com/pmndrs/zustand/issues/163 | ||
|
|
||
| Because of this, actions will be logged as "anonymous" by default. To set a default log action type for all actions from your store: `devtools(store, {name: 'MyStore', anonymousActionType: 'MyStoreAction'})` | ||
|
|
||
| Alternatively, `set` functions take a third parameter which can be used to log any action type you choose: |
There was a problem hiding this comment.
Now that we're writing this first, let's write this: "You can log an action for each set by passing an action type to the third parameter. Example:"
|
With the suggested changes, lgtm. |
Yep |
|
Hey, sorry, I didn't realise you were waiting for me! I will try and make the suggested changes over xmas when I have some free time. I've been a bit busy the last week or so. |
|
Found the free time :) |
Newcomers to zustand may be confused why devtools doesn't show action types by default (I was!), so I've added a note to the readme following this comment from @devanshj