JSPM

  • Created
  • Published
  • Downloads 12
  • Score
    100M100P100Q52837F

AbstractObject with Object State Events Support, RefObject with RefCount and AddRef/Release Support.

Package Exports

  • abstract-object
  • abstract-object/Error
  • abstract-object/RefObject
  • abstract-object/lib/util
  • abstract-object/util

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (abstract-object) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

AbtractObject

Build Status

NPM NPM

AbstractObject with Object State Events Supports and free method provides.

The derived class should overwrite the init, final methods.

  • Methods:

    • create(class): the create class method uses to create a new object instance(the util.createObject is the same function).
      • class: the class constructor to create a new instance.
      • ...: the left arguments will be passed into the class constructor.
    • init: abstract initialization method after a new instance creating.
      • the constructor's arguments should be passed into init method.
    • final: abstract finalization method before the instance destroying.
    • free: free the class instance.
  • Events:

    • 'initing': emit before the init method
    • 'inited': emit after the init method
    • 'destroying': emit before the final method
    • 'destroyed': emit after the final method

RefObject

The RefObject is derived from AbstractObject. and add the RefCount and AddRef/Release Supports.

  • methods:
    • release/free: Decrements reference count for this instance. If it is becoming less than 0, the object would be (self) destroyed.
    • addRef: Increments the reference count for this instance and returns the new reference count.

Usage:

AbstractObject = require('abstract-object')
RefObject = require('abstract-object/RefObject')
inherits = require('abstract-object/lib/util').inherits
createObject = AbstractObject.createObject

class MyObject
  inherits MyObject, RefObject
  init: (@a,@b)->
    super()

myObj = createObject(MyObject, 1, 2)

# if you do not wanna use `AbstractObject.create`, you MUST remember this:
# even the constructor is empty, you should can the parent's constructor manually.
# myObj = new MyObject()

class MyObject
  inherits MyObject, RefObject
  constructor: ->
    # must call super method here:
    super
  init: (@a,@b)->
    # must call super method here for RefObject initialization:
    super()

the javascript:

var AbstractObject = require('abstract-object')
var RefObject = require('abstract-object/RefObject')
var util = require('abstract-object/lib/util')
var createObject = AbstractObject.createObject

//if you do not wanna to use the 'AbstractObject.create'(createObject):
var MyObject = function() {
  //super call
  MyObject.__super__.constructor.apply(this, arguments);
}
// or, this MUST use 'AbstractObject.create'
var MyObject = function(){}


util.inherits(MyObject, RefObject)


MyObject.prototype.init = function(a,b) {
  //super call
  MyObject.__super__.init.call(this);
  this.a = a
  this.b = b
}


var myObj = createObject(MyObject, 1, 2)
//or this,  must overwrite the constructor and call the super constructor.
var myObj = new MyObject(1,2)