Skip to content
This repository has been archived by the owner on Jun 9, 2023. It is now read-only.

Latest commit

 

History

History
48 lines (37 loc) · 3.08 KB

cp.rx.go.Statement.Modifier.md

File metadata and controls

48 lines (37 loc) · 3.08 KB

docs » cp.rx.go.Statement.Modifier


A Statement.Modifier is an extension to a Statement that provides additional configuration details. They are initiated via the modifier method of a defined Statement.

All Statement.Modifier instances will also have the methods defined by Statement.

Submodules

API Overview

  • Functions - API calls offered directly by the extension
  • is
  • Methods - API calls which can only be made on an object returned by a constructor
  • context
  • toObservable

API Documentation

Functions

Signature cp.rx.go.Statement.Modifier.is(thing) -> boolean
Type Function
Description Checks if the thing is a Statement.Modifier.
Parameters
  • thing - The thing to check.
Returns
  • true if the thing is a Statement.Modifier.

Methods

Signature cp.rx.go.Statement.Modifier:context() -> table
Type Method
Description Returns the context table for the Statement.Modifier.
Parameters
  • None
Returns
  • The context table.
Signature cp.rx.go.Statement.Modifier:toObservable() -> cp.rx.Observable
Type Method
Description Creates a new Observable instance for the current configuration.
Parameters
  • None
Returns
  • The new Observable instance.