3.8 KiB
File: "reactive-property.js" Where: {client|server}
#ReactiveProperty A simple class that provides an reactive property interface
new ReactiveProperty(defaultValue, [reactive]) Anywhere
Arguments
- defaultValue {any}
Set the default value for the reactive property - reactive {boolean} (Optional = true) Allow the user to disable reactivity
This api should only be in the internal.api.md
ReactiveProperty = function(defaultValue, reactive) { ...reactive-property.js:18
ReactiveProperty.value {any} Anywhere
This property is private
This property value is defined in ReactiveProperty
This contains the non reactive value, should only be used as a getter for
internal use
self.value = defaultValue;reactive-property.js:27
ReactiveProperty.get() Anywhere
This method get is defined in ReactiveProperty
Usage:
var foo = new ReactiveProperty('bar');
foo.get(); // equals "bar"
self.get = function() { ...reactive-property.js:44
ReactiveProperty.set(value) Anywhere
This method set is defined in ReactiveProperty
Arguments
- value {any}
Usage:
var foo = new ReactiveProperty('bar');
foo.set('bar');
self.set = function(value) { ...reactive-property.js:58
ReactiveProperty.dec([by]) Anywhere
This method dec is defined in ReactiveProperty
Arguments
- by {number} (Optional = 1) Value to decrease by
Usage:
var foo = new ReactiveProperty('bar');
foo.set(0);
foo.dec(5); // -5
self.dec = function(by) { ...reactive-property.js:75
ReactiveProperty.inc([by]) Anywhere
This method inc is defined in ReactiveProperty
Arguments
- by {number} (Optional = 1) Value to increase by
Usage:
var foo = new ReactiveProperty('bar');
foo.set(0);
foo.inc(5); // 5
self.inc = function(by) { ...reactive-property.js:90
ReactiveProperty.getset([value]) Anywhere
This method getset is defined in ReactiveProperty
Arguments
- value {any} (Optional)
Value to set property - if undefined the act like
get
Returns {any} Returns value if no arguments are passed to the function
Usage:
var foo = new ReactiveProperty('bar');
foo.getset(5);
foo.getset(); // returns 5
self.getset = function(value) { ...reactive-property.js:106
ReactiveProperty.toString() Anywhere
This method toString is defined in ReactiveProperty
Usage:
var foo = new ReactiveProperty('bar');
foo.toString(); // returns 'bar'
self.toString = function() { ...reactive-property.js:122
ReactiveProperty.toText() Anywhere
This method toText is defined in ReactiveProperty
Usage:
var foo = new ReactiveProperty('bar');
foo.toText(); // returns 'bar'
self.toText = self.toString;reactive-property.js:135