Methods
browserSessionBuilder()
- Source:
Type Definitions
ApplicationBuilderConstructor() → {ApplicationBuilderInstance}
- Source:
Returns:
ApplicationBuilderExports
- Source:
Properties:
Name | Type | Description |
---|---|---|
application |
ApplicationPrototypeConstructor | |
builder |
ApplicationBuilderConstructor |
ApplicationBuilderInstance
- Source:
Properties:
Name | Type | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
bind |
ApplicationPrototypeBind | attach a new Method |
|||||||||||||||
on |
ApplicationPrototypeListener | listen an event |
|||||||||||||||
once |
ApplicationPrototypeListener | listen an event once |
|||||||||||||||
off |
ApplicationPrototypeListenerRemove | listen an event |
|||||||||||||||
crudEvents |
ApplicationPrototypeCrudEvents | listen an event once |
|||||||||||||||
require |
ApplicationBuilderRequire | The class to register |
|||||||||||||||
Promise |
function |
Properties
|
|||||||||||||||
isNode |
function | returns true if application is running in a node env |
|||||||||||||||
isBrowser |
function | returns true if application is running in a browser env |
|||||||||||||||
runModulesInFiles |
function | enable/disable to run modules in Blob files, returns current state |
|||||||||||||||
debugEnabled |
function | enable/disable debug mode, returns current state |
|||||||||||||||
consoleOptions |
function | update console options. |
|||||||||||||||
modulePath |
function | update current modules path, default returns current module path |
|||||||||||||||
moduleRegister |
ApplicationModuleRegister | register new modules |
|||||||||||||||
moduleResolve |
ApplicationModuleResolve | resolves module's meta, and index that info in Application's store |
|||||||||||||||
NodeInterface |
ApplicationNodeInterface | returns interface for accessing Node Env, is defined only in node env |
load Application Framework
Type:
- Object
ApplicationBuilderRequire(events, callbackopt) → {PromiseLike.<any>}
- Source:
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
events |
string | Array.<string> | List of Events Names or Array of Events Mapping like [ "uriLoad :: uri-load", "ePrototype :: extensions/prototype" ] |
|
callback |
function |
<optional> |
Callback that will receive Module |
Returns:
- Type
- PromiseLike.<any>
ApplicationConsoleOptions
- Source:
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
file |
Boolean |
<optional> |
enable/disable showing filename in console log. default value is |
contextName |
Boolean |
<optional> |
enable/disable showing context Execution info in console log. default value is |
timestamp |
Boolean |
<optional> |
enable/disable showing current timestamp in console log. default value is |
logType |
Boolean |
<optional> |
enable/disable showing log type in console log. default value is `true |
Type:
- Object
ApplicationModule
- Source:
Properties:
Name | Type | Description |
---|---|---|
$request |
PromiseLike | resolves module exports |
exports |
function | module exports handler |
atime |
Number | unix time in milliseconds |
Application |
function | returns current application |
cache |
function | returns module's reserved cache object |
require |
function | require modules from module's folder |
resourceUrl |
function | returns module's resource URL |
meta |
ApplicationModuleMeta | module's meta information |
Type:
- Object
ApplicationModuleMeta
- Source:
Properties:
Name | Type | Description |
---|---|---|
store |
ApplicationModuleStore | same as |
$requestQuery |
PromiseLike.<String> | XMLHttpRequest used for obtaining Module's Content |
module_path |
String | module's path |
path |
String | module's internal path used as identifier of module |
name |
String | module's name |
__dirname |
String | module's dirname |
Type:
- Object
ApplicationModuleRegister(path, modules) → {ApplicationModuleStore}
- Source:
Parameters:
Name | Type | Description |
---|---|---|
path |
String | path that will be used as |
modules |
Array.<String> | list of modules names that should be registered |
Returns:
ApplicationModuleResolve(module, pathopt) → {ApplicationModuleMeta}
- Source:
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
module |
String | module name |
|
path |
String |
<optional> |
module path |
Returns:
ApplicationModuleStore
- Source:
modules store where are indexed modules
Type:
- Object
ApplicationNodeInterface
- Source:
Properties:
Name | Type | Description |
---|---|---|
process |
function | |
global |
function | |
require |
function | |
globalReference |
function | returns NodeJS require reference by it's name |
Type:
- Object
ApplicationPrototypeBind(event, callbackopt, listenersConfigopt) → {String}
- Source:
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
event |
String | function | event name of function with name |
|
callback |
function | BindListenerConfig |
<optional> |
function that will listen data |
listenersConfig |
BindListenerConfig | string |
<optional> |
of lis event name of function with name |
Returns:
- Type
- String
ApplicationPrototypeConstructor() → {ApplicationPrototypeInstance}
- Source:
Returns:
ApplicationPrototypeCrudEvents(context, publicMethods, privateMethods) → {ApplicationPrototypeInstance}
- Source:
Parameters:
Name | Type | Description |
---|---|---|
context |
Object.<any> | will be used as a base for ApplicationPrototype instance that will be returned |
publicMethods |
Object.<function()> | list of public methods avaiable from returned instance |
privateMethods |
Object.<function()> | list of private methods available only for instance's methods |
Returns:
ApplicationPrototypeInstance
- Source:
Properties:
Name | Type | Description |
---|---|---|
bind |
ApplicationPrototypeBind | attach a new Method |
on |
ApplicationPrototypeListener | listen an event |
once |
ApplicationPrototypeListener | listen an event once |
off |
ApplicationPrototypeListenerRemove | listen an event |
crudEvents |
ApplicationPrototypeCrudEvents | listen an event once |
configuration for binded listeners
Type:
- object
ApplicationPrototypeListener(event, callbackopt, specifiedEventId) → {String}
- Source:
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
event |
String | function | event name of function with name |
|
callback |
function |
<optional> |
function that will listen data |
specifiedEventId |
String | event name of function with name |
Returns:
- Type
- String
ApplicationPrototypeListenerRemove(event, specifiedEventId) → {String}
- Source:
Parameters:
Name | Type | Description |
---|---|---|
event |
String | event or events names sepparated by comma |
specifiedEventId |
String | event name of function with name |
Returns:
- Type
- String
BindListenerConfig
- Source:
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
listenedBefore |
Boolean |
<optional> |
true
|
allow listners before method call |
listenedOn |
Boolean |
<optional> |
true
|
allow listners on method call ( is after ) |
listenedAfter |
Boolean |
<optional> |
true
|
allow listners after method call ( is after small delay ) |
allowInterruption |
Boolean |
<optional> |
true
|
configuration for binded listeners
Type:
- object
BrowserSessionModule(objectStoreArg, objectStoreConfopt) → {Promise.<ApplicationPrototypeInstance>}
- Source:
browserSessionBuilder description
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
objectStoreArg |
string | object | name or object of strategyStore |
|
objectStoreConf |
object |
<optional> |
Returns:
session application
- Type
- Promise.<ApplicationPrototypeInstance>
ModuleResourceUrl
- Source:
resources url is composed from module's plath
+ resource path
Type:
- String