PrivateCoffee/element-web
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

Update documentation for GroupStore.registerListener

Browse source
This commit is contained in:
Luke Barnard 2018-05-01 16:57:28 +01:00
parent 56ec7713bb
commit bd703b17e5
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
src/stores/GroupStore.js
View file

@ -167,11 +167,12 @@ class GroupStore extends EventEmitter {
* immediately triggers an update to send the current state of the * immediately triggers an update to send the current state of the
* store (which could be the initial state). * store (which could be the initial state).
* *
* This also causes a fetch of all data of the specified group, * If a group ID is specified, this also causes a fetch of all data
* which might cause 4 separate HTTP requests, but only if said * of the specified group, which might cause 4 separate HTTP
* requests aren't already ongoing. * requests, but only if said requests aren't already ongoing.
* *
* @param {string} groupId the ID of the group to fetch data for. * @param {string?} groupId the ID of the group to fetch data for.
* Optional.
* @param {function} fn the function to call when the store updates. * @param {function} fn the function to call when the store updates.
* @return {Object} tok a registration "token" with a single * @return {Object} tok a registration "token" with a single
* property `unregister`, a function that can * property `unregister`, a function that can