# cp.rx.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

  • create

Methods - API calls which can only be made on an object returned by a constructor

  • cancel

# API Documentation

# Constructors

# create

Signature cp.rx.Reference.create(action) -> cp.rx.Reference
Type Constructor
Description Creates a new Reference.
Parameters
  • action - The action to run when the reference is canceld. It will only be run once.
Returns
Notes None
Examples None
Source src/extensions/cp/rx/Reference.lua line 15

# Methods

# cancel

Signature cp.rx.Reference:cancel() -> nil
Type Method
Description Unsubscribes the reference, performing any necessary cleanup work.
Parameters
  • None
Returns
  • Nothing
Notes None
Examples None
Source src/extensions/cp/rx/Reference.lua line 33