yonote/yjs
23
0
Fork 0
Code Pull Requests 1 Releases Activity

return unobserve functions from observe and observeDeep methods

Browse Source
This commit is contained in:
Ewan 2024-10-17 15:38:54 +11:00
parent a304024a76
commit 31dc29ab37
No known key found for this signature in database
GPG Key ID: 0BB54F4AFF8B9843
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/types/AbstractType.js
View File

@ -364,20 +364,26 @@ export class AbstractType {
/** /**
* Observe all events that are created on this type. * Observe all events that are created on this type.
* Returns a function to stop sending events to the provided callback once called
* *
* @param {function(EventType, Transaction):void} f Observer function * @param {function(EventType, Transaction):void} f Observer function
* @returns {function():void}
*/ */
observe (f) { observe (f) {
addEventHandlerListener(this._eH, f) addEventHandlerListener(this._eH, f)
return () => this.unobserve(f)
} }
/** /**
* Observe all events that are created by this type and its children. * Observe all events that are created by this type and its children.
* Returns a function to stop sending events to the provided callback once called
* *
* @param {function(Array<YEvent<any>>,Transaction):void} f Observer function * @param {function(Array<YEvent<any>>,Transaction):void} f Observer function
* @returns {function():void}
*/ */
observeDeep (f) { observeDeep (f) {
addEventHandlerListener(this._dEH, f) addEventHandlerListener(this._dEH, f)
return () => this.unobserveDeep(f)
} }
/** /**