Skip to content

Commit ea7af60

Browse files
authored
docs: clarify store subscribe (#19)
1 parent 816dcf5 commit ea7af60

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

packages/amos-core/src/store.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,10 @@ export interface Store {
5353
snapshot: () => Readonly<Snapshot>;
5454

5555
/**
56-
* Subscribe the update of the store. The event contains all mutated boxes
57-
* and its original state.
56+
* Subscribe to store updates.
5857
*
59-
* It only will be fired after the root dispatch completed.
58+
* The provided listener is called with no arguments after the root
59+
* dispatch has finished processing all mutations.
6060
*/
6161
subscribe: (fn: () => void) => Unsubscribe;
6262

0 commit comments

Comments
 (0)