The output type of this Motel instance. That is, the type of object you'll dispatch from your observer callbacks. For example, in a Redux app this would probably be your Redux action type.
Connect a MutationObserver to the given root DOM element and begin watchng for vacancies.
It also synchronously finds pre-existing vacancies in the root's subtree and reports them to observers.
Observers should thus be attached before calling this method, or some vacancies may go undetected.
This is especially relevant if you're using SSR.
Vacancies occurring on or anywhere below this element will be observed.
Stop listening for vacancies.
Create a wildcard observer that sees every vacancy.
The special "*" string, which represents
a pattern that matches everything.
A callback function that runs whenever a vacancy is found.
Create an observer that matches vacancies based on the given string pattern. Pattern matching follows the rules of a UrlPattern object.
A pattern string as described here.
A callback function that runs whenever a vacancy is found.
Create an observer that matches vacancies based on a regex.
A pattern string as described here.
A callback function that runs whenever a vacancy is found.
Subscribe to the output of this instance. That is, a stream
of objects of type <A>. Every dispatched object will be
seen by the subscriber.
A callback function which receives
objects of type A dispatched from your vacancy
observers.
Create a new instance with the given options.
Generated using TypeDoc
This is your main API entry point to this library.
An instance of this class manages your vacancy observers, including methods for adding observers and listening on a DOM element. Typically the instance would be created at application startup time and would last for the duration of the app.
Internally, it creates a
MutationObserverwhich does the actual work of detecting vacancies.For convenience, methods on this class are chainable, allowing patterns like this:
const vacancies = Motel.create() .observe(...observer callback...) .observe(...observer callback...) .observe(...observer callback...) .subscribe(action => store.dipatch(action)) .connect(document.querySelector('#root'));...however note that it may be better to break these calls across different modules.