wheels-loud-accessors

Attribute accessors that emit events. Fully compatible with CommonJS / Node, AMD and standard browser script tag include

npm install wheels-loud-accessors
4 downloads in the last month

Wheels Loud Accessors

A constructor for objects with attribute accessors that emit change or read events upon setting or getting an attribute. Fully compatible with CommonJS (Node), AMD and standard browser script tag include.

Install

wheels-loud-accessors can be included in a project with CommonJS / npm, AMD or standard browser script tag. Its dependencies are wheels-pubsub and wheels-class.

npm

npm install wheels-loud-accessors

AMD / RequireJS

// Remember to provide the dependencies `wheels-pubsub` and `wheels-class`
require(["wheels-loud-accessors"], function( LoudAccessors ) {
  var foo = new LoudAccessors();
});

Traditional browser script tag

<script type="text/javascript" src="path/to/wheels-class.js"></script>
<script type="text/javascript" src="path/to/wheels-pubsub.js"></script>
<script type="text/javascript" src="path/to/wheels-loud-accessors.js"></script>
<script type="text/javascript">
  var foo = new Wheels.LoudAccessors();
</script>

Usage

LoudAccessors is a class (created with wheels-class) inheriting from wheels-pubsub and introducing get and set instance methods, as well as an attrAccessors class method.

Setters:

var foo = new LoudAccessors();

foo.on("change", function( evt, attribute, val ) {
  console.log("Attribute " + attribute + " was set to value " + val );
});

foo.set( "bar", 123 ); // console: Attribute bar was set to value 123

foo.set( "bar", 234, { silent: true } ); // 'silently' set attribute, no event triggered

Getters:

var foo = new LoudAccessors();

foo.on("read", function( evt, attribute, val ) {
  console.log("Attribute " + attribute + " was read" );
});

foo.get( "bar" ); // console: Attribute bar was read

foo.get( "bar", { silent: true } ); // 'silently' get attribute, no event triggered

In JavaScript engines that support Object.defineProperty, we can even do without get and set methods:

var Foo = LoudAccessors.subclass(function() {
      this.attrAccessors("bar")
    }),
    foo = new Foo();

foo.on("change", function( evt, attribute, val ) {
  console.log("Attribute " + attribute + " was set to value " + val );
});
foo.on("read", function( evt, attribute, val ) {
  console.log("Attribute " + attribute + " was read" );
});

foo.bar = 123;      // console: Attribute bar was set to value 123
var qux = foo.bar;  // console: Attribute bar was read
npm loves you