Getting Started
Contributing
Control CommandPost
Plugins
Internationalisation
CommandPost API
Bundled Plugins API
Hammerspoon API
Reference
​
A handle representing the link between an Observer and an Observable, as well as any work required to clean up after the Observable completes or the Observer cancels.
API Overview
- Constructors - API calls which return an object, typically one that offers API methods
- Methods - API calls which can only be made on an object returned by a constructor
API Documentation
Constructors
Signature
cp.rx.Reference.create(action) -> cp.rx.ReferenceType
Constructor
Description
Creates a new Reference.
Parameters
- action - The action to run when the reference is canceld. It will only be run once.
Returns
Methods
Signature
cp.rx.Reference:cancel() -> nilType
Method
Description
Unsubscribes the reference, performing any necessary cleanup work.
Parameters
- None
Returns
- Nothing
Last modified 1mo ago
Export as PDF
Copy link