abstract-object
v3.0.0
Published
AbstractObject with Object State Events Support
Downloads
902
Maintainers
Readme
AbtractObject
AbstractObject with Object State Supports and free
method provides.
The derived class should overwrite the initialize
and finalize
methods.
State-able Ability
add the Object State Supports and free
method to your class directly.
You must call the _constructor
of the state-able ability in the constructor method.
import {stateable} from 'abstract-object'
export class MyStateObject {
constructor() {
this._constructor.apply(this, arguments)
}
}
stateable(MyStateObject)
export default MyStateObject
Let state-able object supports the event.
import {stateable} from 'abstract-object'
import {eventable} from 'events-ex'
class MyObject {
constructor() {
this._constructor.apply(this, arguments)
}
}
stateable(MyObject)
eventable(MyObject)
AbstractObject
Methods:
create
(class, ...): thecreate
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.
createWith
(class, arguments): thecreateWith
class method uses to create a new object instance(the util.createObjectWith is the same function).class
: the class constructor to create a new instance.arguments
(array): the arguments will be passed into the class constructor.
initialize(...)
: abstract initialization method after a new instance creating....
: the constructor's arguments should be passed into initialize method.
finalize
(...): abstract finalization method before the instance destroying....
: the free(destroy)'s arguments should be passed into finalize method.
- (deprecated)
init(...)
: abstract initialization method after a new instance creating.- init method is deprecated, pls use initialize method instead
...
: the constructor's arguments should be passed into init method.
- (deprecated)
final
(...): abstract finalization method before the instance destroying.- final method is deprecated, pls use finalize instead
...
: the free(destroy)'s arguments should be passed into final method.
free
(...): free the class instance....
: optional arguments will be passed into final method to process.
isIniting
(),isInited
(),isDestroying
(),isDestroyed
() object state testing methods:- to test object state
only added/injected eventable ability:
- Methods:
dispatch
(event, args[, callback]): dispath an event or callbackevent
: the event nameargs
: the args are passed to event or callbackcallback
: optional, it will not dispatch event if the callback is exists, unless the callback return false.
dispatchError
(error[, callback]):error
: the error instance.callback
: optional, it will not dispatch'error'
event if the callback is exists, unless the callback return false.
- Events:
'initing'
: emit before the initialize method'inited'
: emit after the initialize method'destroying'
: emit before the finalize method'destroyed'
: emit after the finalize method
- Methods:
Usage
import {AbstractObject} from 'abstract-object'
class MyObject extends AbstractObject {
initialize(a, b) {
this.a = a
this.b = b
this.cache = {}
}
finalize() {
this.cache = null
}
}
const myObj = new MyObject(1, 2)
RefObject
RefObject has been moved to ref-object
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.
AbstractError Classes
It has been moved to abstract-error.
Changes
V3.x
- broken change Remove deprecated
ref-object.js
,RefObject.js
andeventable-ref-object.js
files- these files are now part of the ref-object.
- broken change Remove deprecated
util
to util-ex package. - broken change Remove deprecated
Error
to abstract-error package.
V2.1.x
- add the state-able ability to any class.
- move RefObject to ref-object
- decoupled the abstract-object completely.
- All parts can be used individually.
- stateable = require('abstract-object/ability')
- eventable = require('events-ex/eventable')
- refCountable = require('ref-object/ability')
V2.x
- separate eventable from AbstractObject
- the new EventableObject can be as [email protected]
- separate eventable from RefObject too
- the new EventableRefObject can be as [email protected]
- add the eventable function to eventable any class('abstract-object/eventable').
- use the eventable plugin(events-ex) to implement eventable object.
- move all util functions to util-ex
- move enhanced inheritance Functions to inherits-ex.
- move AbstractError to abstract-error
V1.x
- AbstractObject inherits from EventEmitter.
- RefObject inherits from AbstractObject
- AbstractError