Registers a listener that is called each time the object or a primitive value at this path is updated.
The provided listener receives a PathObject representing the path at which there was an object change, and, if applicable, an ObjectMessage that carried the operation that led to the change.
By default, subscriptions observe nested changes, but you can configure the observation depth
using the options parameter.
A PathObject subscription observes whichever value currently exists at this path. The subscription remains active even if the path temporarily does not resolve to any value (for example, if an entry is removed from a map). If the object instance at this path changes, the subscription automatically switches to observe the new instance and stops observing the old one.
An event listener function.
Optional options: PathObjectSubscriptionOptions
Optional subscription configuration.
A Subscription object that allows the provided listener to be deregistered from future updates.
Registers a subscription listener and returns an async iterator that yields subscription events each time the object or a primitive value at this path is updated.
This method functions in the same way as the regular PathObject.subscribe() method,
but instead returns an async iterator that can be used in a for await...of loop for convenience.
Optional options: PathObjectSubscriptionOptions
Optional subscription configuration.
An async iterator that yields PathObjectSubscriptionEvent objects.
Generated using TypeDoc
PathObjectBase defines the set of common methods on a PathObject that are present regardless of the underlying type.