Share and use objects with ease.
JavaScript
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src-test
src
LICENSE
README.md
gset-min.js

README.md

GSet

Share and use objects with ease.

3/28/11 version 1.0.1 by Bemi Faison (bemson@gmail.com)

DESCRIPTION

Formerly named Proxy, the GSet instance protects an object from unwanted access and manipulation, while providing a collection of scoped methods. The GSet constructor introduces the GVS pattern, which offers a simple syntax for defining getter/setter methods.

FILES

  • gset-min.js - GSet library (minified with the YUI Compressor version 2.4.2)
  • src/ - Directory containing the GSet source code
  • src-test/ - Test suite for GSet
  • LICENSE - The legal terms and conditions under which GSet may be used
  • README.md - This readme file

INSTALLATION

Use GSet within a web browser. Load the src/gset.js file like any other external JavaScript library file.

USAGE

Instantiate a GSet using the new operator and the required arguments, source and scheme. Functions within the scheme execute within the scope of the source object.

var pxy = new GSet(anyObject, {
  myMethod: function () {
    var thatObject = this;
    thatObject.privateMethod();
  },
  gvsMethod: [
    function getter() {
      return this.someThing;
    },
    function vetter(param1, param2, ...) {
      return validateBeforeSetting(arguments);
    },
    function setter(param1, param2, ...) {
      this.someThing = param1 ? param2 : param3;
      return param4 ? true : false;
    }
  ]
});

Invoke GSet methods like any other object.

var getResult = pxy.gvsMethod();
var setResult = pxy.gvsMethod(arg1, arg2, ...);

More usage information is available in the GSet wiki.

LICENSE

GSet is available under the terms of the MIT-License.

Copyright 2010, Bemi Faison