Class: Base

(abstract) Help4.jscore.Base(classConfigopt, isDerivedopt)

JS base class

Constructor

(abstract) new Base(classConfigopt, isDerivedopt)

Parameters:
Name Type Attributes Default Description
classConfig Help4.jscore.Base.Params <optional>
isDerived boolean <optional>
 false
Properties:
Name Type Description
____classConfig Help4.jscore.Base.ClassConfig class configuration
_listeners Object event listeners
Source:

Methods

(protected) ____defineStaticProperties()

auto define all to be cleaned properties
Source:
Throws:
Error

(protected) ____getClassConfig() → {Help4.jscore.Base.Params}

Source:
Returns:
Type
Help4.jscore.Base.Params

(protected) ____mergeDerivedParam(level0, type, value)

Parameters:
Name Type Description
level0 Help4.jscore.Base.Params
type string
value *
Source:
Throws:
Error

(protected) ____mergeDerivedParams(level0, level1)

Parameters:
Name Type Description
level0 Help4.jscore.Base.Params
level1 Help4.jscore.Base.Params
Source:
Throws:
Error

(protected) ____resolveDerivedParams(classConfig)

Parameters:
Name Type Description
classConfig Help4.jscore.Base.Params
Source:

(protected) _destroyControl(…keys)

destroys class properties
Parameters:
Name Type Attributes Description
keys string <repeatable>
Source:

(protected) _fireEvent(event) → {Help4.jscore.Base}

fires an event that can be observed from outside
Parameters:
Name Type Description
event Object the event to be fired
Source:
Returns:
Type
Help4.jscore.Base

(async, protected) _fireEvent2(event) → {Promise.<Array.<Help4.EmbeddedEvent.EventResponse>>}

fires an event that can be observed from outside
Parameters:
Name Type Description
event Object the event to be fired
Source:
Returns:
Type
Promise.<Array.<Help4.EmbeddedEvent.EventResponse>>

(protected) _fireEventSync(event) → {Array.<Help4.EmbeddedEvent.EventResponse>}

fires an event that can be observed from outside
Parameters:
Name Type Description
event Object the event to be fired
Source:
Returns:
Type
Array.<Help4.EmbeddedEvent.EventResponse>

addListener(eventType, listener) → {Help4.jscore.Base}

add an event listener
Parameters:
Name Type Description
eventType string | Array.<string> event type to be observed
listener Help4.EmbeddedEvent.Listener the callback function
Source:
Returns:
Type
Help4.jscore.Base

addListenerSync(eventType, listener) → {Help4.jscore.Base}

add an event listener
Parameters:
Name Type Description
eventType string | Array.<string> event type to be observed
listener Help4.EmbeddedEvent.Listener the callback function
Source:
Returns:
Type
Help4.jscore.Base

destroy()

destroy instance
Source:

isDestroyed() → {boolean}

whether instance is destroyed
Source:
Returns:
Type
boolean

removeListener(eventType, listener) → {Help4.jscore.Base}

remove an event listener
Parameters:
Name Type Description
eventType string | Array.<string>
listener Help4.EmbeddedEvent.Listener
Source:
Returns:
Type
Help4.jscore.Base

Type Definitions

ClassConfig

the class configuration
Type:
  • Object
Properties:
Name Type Attributes Description
config Object configuration
statics Object properties w/o intelligence but w/ automatic creation and cleanup; Help4.jscore.Base.Static
derived Object <optional>
<nullable>
 hand-over of derived class params
Source:

Params

the class parameters
Type:
  • Object
Properties:
Name Type Attributes Description
config Object <optional>
<nullable>
 configuration
statics Object <optional>
<nullable>
 properties w/o intelligence but w/ automatic creation and cleanup; Help4.jscore.Base.Static
derived Object <optional>
<nullable>
 hand-over of derived class params
Source:

Static

Type:
  • Object
Properties:
Name Type Attributes Default Description
init * <optional>
 null
destroy boolean <optional>
 true
Source: