Methods
define(struct, declaration) → {void}
A wrapper function to create a package and define a class within it.
The pack() function is called on the structure and declaration() is executed as a callback.
Parameters:
| Name | Type | Description |
|---|---|---|
struct |
string | A reverse domain notation of the package you'd like to create along with a class name |
declaration |
function | A function that would be executed as soon as the package variable is created and should declare a class for the package. |
- Since:
- 1.0.0
- Source:
Returns:
- Type
- void
inc(struct, local) → {void|object}
A function to load a package, class or a property of a reverse domain notated instance and bring it as a global root variable or return it as a result
If you don't include any objects with conflicting names you can save some time and instead of calling (for example) new com.magadanski.EventDispatcher()
you can simply do an inc('com.magadanski.EventDispatcher') and then new EventDispatcher().
If there is a class from a different package with the same name, you can pass true as the local attribute to get reference to the full class anme returned.
For example you can do var MagadanskiEventDispatcher = inc('com.magadanski.EventDispatcher', true) and then you can do new MagadanskiEventDispatcher()
to instantiate the class.
Parameters:
| Name | Type | Description |
|---|---|---|
struct |
string | The reverse domain notation of the package, class or property you'd like to have as global |
local |
bool | Whether you'd like to make this as a global variable or you'd like the result returned to you to assign to a local variable |
- Since:
- 1.0.0
- Source:
Returns:
Would not return anything of local is false. If the second function parameter is true then this would return the object rather than making it global.
- Type
- void | object
pack(struct) → {object}
A function to automatically create (if not already defined) an object with all necessary properties to represent a package in a revrese domain notation.
The framework's packages currently all appear as com.magadanski.{package}.{subpackage}, where "{package}" and "{subpackage}" are names of the
corresponding items ({subpackage} is rarely seen).
If you'd like to create a custom package you can use pack('com.myDomain.myPackage') to create an object with the corresponding structure.
Parameters:
| Name | Type | Description |
|---|---|---|
struct |
string | A reverse domain notation of the package you'd like to create |
- Since:
- 1.0.0
- Source:
Returns:
The object in the end of the packge you've defined
- Type
- object