attribute

Attribute setter/getter component.

Installation

$ npm install attribute

Test

$ component install -d
$ component build -d
$ open test/index.html

API

Attribute(obj)

The Attribute must be used as an object mixin (or a prototype mixin).
Objects that gain Attribute capabilities become Emitters.

As a mixin:

var Attribute = require('attribute');
var user = { id: '007' };

Attribute(user);
user.set('name', 'James');

As a prototype mixin:

var Attribute = require('attribute');
var User = function(id){ this.id = id; };
var user = new User('007');

Attribute(User.prototype);
user.set('name', 'James');

Attribute#get(name:String)

Return the value of the attribute name.

Attribute#set(key:String, value:*, options:Object)

Set the attribute [key] to [value].
If key is an Object of values to set:
call set_all.
If the value is changed and options.silent is true:
emit chage:[key] event,
emit change event.
Return this for chaining.

Attribute#set_all(values:Object, options:Object)

Set the attribute [key] to [value].
If options.silent is true:
emit chage:[key] event for each changed value.
If at least one of the value is changed: emit change event.
Return this for chaining.

Attribute#del(key:String)

Delete the attribute key. If the attribute has been removed:
emit delete:[key] event. Return this for chaining.

Attribute#has(key:String)

Return true if the attribute key is present,
false otherwise.

License

(The MIT License)

Copyright (c) 2012 Enrico Marino and Federico Spini

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.