docs/Kronicle.html
<!DOCTYPE html>
<html>
<head>
<title>Kronicle.js</title>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<link rel="stylesheet" media="all" href="docco.css" />
</head>
<body>
<div id="container">
<div id="background"></div>
<ul id="jump_to">
<li>
<a class="large" href="javascript:void(0);">Jump To …</a>
<a class="small" href="javascript:void(0);">+</a>
<div id="jump_wrapper">
<div id="jump_page">
<a class="source" href="Core.html">
Core.js
</a>
<a class="source" href="EventTypes.html">
EventTypes.js
</a>
<a class="source" href="Kronicle.html">
Kronicle.js
</a>
<a class="source" href="Module.html">
Module.js
</a>
<a class="source" href="ArrayDataSource.html">
ArrayDataSource.js
</a>
<a class="source" href="Component.html">
Component.js
</a>
<a class="source" href="Controller.html">
Controller.js
</a>
<a class="source" href="DataSource.html">
DataSource.js
</a>
<a class="source" href="DataSources.html">
DataSources.js
</a>
<a class="source" href="DataSourcesEvents.html">
DataSourcesEvents.js
</a>
<a class="source" href="View.html">
View.js
</a>
</div>
</li>
</ul>
<ul class="sections">
<li id="title">
<div class="annotation">
<h1>Kronicle.js</h1>
</div>
</li>
<li id="section-1">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-1">¶</a>
</div>
</div>
<div class="content"><div class='highlight'><pre>import {Core} from <span class="hljs-string">'./Core.js'</span>;
import {events} from <span class="hljs-string">'./EventTypes.js'</span>;
import {<span class="hljs-keyword">default</span> as PubSub} from <span class="hljs-string">'pubsub-js'</span>;</pre></div></div>
</li>
<li id="section-2">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-2">¶</a>
</div>
<h1 id="main-kronicle-class">Main Kronicle Class</h1>
<p>depends: <a href="Core.html">Kronicle.Core</a>, <a href="EventTypes.html">Kronicle.EventTypes</a>, pubsub-js
The main Kronicle Class, constructor takes no arguments
The class has one property</p>
<ul>
<li>core - the core object initialized with a null value.
Use build method to setup a core with an array of Kronicle modules passed as an argument.</li>
</ul>
</div>
<div class="content"><div class='highlight'><pre>export <span class="hljs-keyword">class</span> Kronicle {
constructor(){
<span class="hljs-keyword">this</span>.core = <span class="hljs-literal">null</span>;
}</pre></div></div>
</li>
<li id="section-3">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-3">¶</a>
</div>
<h2 id="build-method">build method</h2>
<p>Takes an array of Kronicle Modules as an argument and initializes the core. Returns a reference to the object.</p>
</div>
<div class="content"><div class='highlight'><pre> build (args = { modules: [] }) {
<span class="hljs-keyword">this</span>.core = <span class="hljs-keyword">new</span> Core(args.modules);
<span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>;
}</pre></div></div>
</li>
<li id="section-4">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-4">¶</a>
</div>
<h2 id="initialize-method">initialize method</h2>
<p>Takes a callback as an argument.
Callback is called when Kronicle Core is initialized. </p>
</div>
<div class="content"><div class='highlight'><pre> initialize(cb) {
PubSub.subscribe(events.Initialized, cb);
<span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>;
}</pre></div></div>
</li>
<li id="section-5">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-5">¶</a>
</div>
<h2 id="beforemodulesload-method">beforeModulesLoad method</h2>
<p>Takes a callback as an argument.
Callback is called before any Kronicle modules are loaded, callback receives all modules as an argument ie cb(modules).</p>
</div>
<div class="content"><div class='highlight'><pre> beforeModulesLoad(cb) {
PubSub.subscribe(events.BeforeModulesLoad, cb);
<span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>;
}</pre></div></div>
</li>
<li id="section-6">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-6">¶</a>
</div>
<h2 id="moduleloaded-method">moduleLoaded method</h2>
<p>Takes a callback as an argument.
Callback is called as each module is loaded, callback receives module as an argument ie cb(module)</p>
</div>
<div class="content"><div class='highlight'><pre> moduleLoaded(cb) {
PubSub.subscribe(events.ModuleLoaded, cb);
<span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>;
}</pre></div></div>
</li>
<li id="section-7">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-7">¶</a>
</div>
<h2 id="aftermodulesload-method">afterModulesLoad method</h2>
<p>Takes a callback as an argument.
Callback is called after all modules are loaded, callback receives all modules as argument ie cb(modules)</p>
</div>
<div class="content"><div class='highlight'><pre> afterModulesLoad(cb){
PubSub.subscribe(events.AfterModulesLoad, cb);
<span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>;
}</pre></div></div>
</li>
<li id="section-8">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-8">¶</a>
</div>
<h2 id="ready-method">ready method</h2>
<p>Takes a callback as an argument.
Callback is called after all modules are loaded an Kronicle is ready for use.</p>
</div>
<div class="content"><div class='highlight'><pre> ready(cb) {
PubSub.subscribe(events.Ready, cb);
<span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>;
}</pre></div></div>
</li>
<li id="section-9">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-9">¶</a>
</div>
<h2 id="start-method">start method</h2>
<p>Takes a callback as an argument.
Callback is called when Kronicle is ready to be used, callback receives the core with added modules as a callback.
Should be used as main entry point for kronicle apps.</p>
</div>
<div class="content"><div class='highlight'><pre> start(cb){
cb.call(<span class="hljs-keyword">this</span>, <span class="hljs-keyword">this</span>.core.addedModules);
PubSub.publish(events.Start);
<span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>;
}
}</pre></div></div>
</li>
</ul>
</div>
</body>
</html>