Skip to content

Latest commit

 

History

History
115 lines (81 loc) · 2.56 KB

api.md

File metadata and controls

115 lines (81 loc) · 2.56 KB

#ReactiveProperty A simple class that provides an reactive property interface

new ReactiveProperty(defaultValue)  Anywhere

Arguments

  • defaultValue {any}
    Set the default value for the reactive property

This api should only be in the internal.api.md

ReactiveProperty = function(defaultValue) { ... reactive-property.js:10

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:36

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:50

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:67

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:82

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:98