blinx
Version:
The Scalable JavaScript Application Framework
126 lines (105 loc) • 5.89 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: constants.js</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Source: constants.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>export default {
/**
* <ul>
*<li> EVENT_ENUM: ENUM constant for the types of events
*<li>"KEEP_ON": The event will be listened even when the module has not been rendered.
*<li> "RE_PLAY": Non rendered modules with replay events will be queued on publishing. Will automatically call the callback once the rendering is complete.
*<li> "PLAY_AFTER_RENDER",{@defaultvalue} If the event is of this type then the module starts listening
* to the event once the rendering completes.
* </ul>
*/
EVENT_ENUM: {
keepOn: "KEEP_ON",
replay: "RE_PLAY",
playAfterRender: "PLAY_AFTER_RENDER"
},
/**
* Based on the module lifecycle. The following events occur
* <ul>
*<li> 1) resolveRenderOn: event occurs just before resolveRenderOn method is called
*<li> 2) render: event occurs when page renders(in case template passed) or just before render method is called
*<li> 3) onRenderComplete: event is fired just before onRenderComplete method is called
*<li> 4) onStatusChange: event is fired whenever the status of module is changed. The status change events are mentioned
* on the next section
*<li> 5) destroy: event occurs when module is destroyed.
* </ul>
*/
MODULE_EVENTS: {
resolveRenderOn: "resolveRenderOn",
render: "render",
onRenderComplete: "onRenderComplete",
onStatusChange: "__onStatusChange",
destroy: "destroy"
},
/**
*
* LIFECYCLE EVENTS LIST:
* <ul>
*<li>1)"LIFECYCLE:CREATED",
*<li>2)"LIFECYCLE:KEEP_ON_&_REPLAY_SUBSCRIBED",
*<li>3)"LIFECYCLE:INIT_ON_SUBSCRIBED",
*<li>4)"LIFECYCLE:RESOLVE_RENDER_ON_CALLED",
*<li>5)"LIFECYCLE:LISTENS_TO_PLAY_AFTER_RENDER_SUBSCRIBED",
*<li>6)"LIFECYCLE:ON_RENDER_CALLED",
*<li>7)"LIFECYCLE:ON_RENDER_CAOMPLETE_CALLED"
* </ul>
*/
onStatusChange_EVENTS: {
onCreate: "LIFECYCLE:CREATED",
keepOnReplaySubscribed: "LIFECYCLE:KEEP_ON_&_REPLAY_SUBSCRIBED",
initOnSubscribed: "LIFECYCLE:INIT_ON_SUBSCRIBED",
resolveRenderOnCalled: "LIFECYCLE:RESOLVE_RENDER_ON_CALLED",
listensToPlayAfterRenderSubscribed: "LIFECYCLE:LISTENS_TO_PLAY_AFTER_RENDER_SUBSCRIBED",
renderCalled: "LIFECYCLE:ON_RENDER_CALLED",
onRenderCompleteCalled: "LIFECYCLE:ON_RENDER_CAOMPLETE_CALLED"
},
/**
* @readonly
* @private
* @constant {Object} lifeCycleFlags following fields
* <ul>
* <li>booted: true </li>
* <li>rendered: false</li>
* <li>preRenderResolved: false</li>
* </ul>
*/
lifeCycleFlags: {
booted: true,
preRenderResolved: false,
rendered: false
}
}
</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-interfaces_store.html">interfaces/store</a></li><li><a href="module-Module.html">Module</a></li><li><a href="The%2520publisher%2520subscriber%2520module%2520for%2520Blinx.%250AIt%2520is%2520responsible%2520for%2520the%2520communication%2520between%2520the%2520modules%2520through%2520eventsmodule_.html">The publisher subscriber module for Blinx.
It is responsible for the communication between the modules through events</a></li></ul><h3>Classes</h3><ul><li><a href="module-Module-Module.html">Module</a></li></ul><h3>Global</h3><ul><li><a href="global.html#_callRender">_callRender</a></li><li><a href="global.html#_callResolveRenderOn">_callResolveRenderOn</a></li><li><a href="global.html#_emitLifeCycleEvent">_emitLifeCycleEvent</a></li><li><a href="global.html#_listenForInitOn">_listenForInitOn</a></li><li><a href="global.html#_lockEvents">_lockEvents</a></li><li><a href="global.html#_onBreath">_onBreath</a></li><li><a href="global.html#_registerModule">_registerModule</a></li><li><a href="global.html#_registerSubscription">_registerSubscription</a></li><li><a href="global.html#_startExec">_startExec</a></li><li><a href="global.html#attachListener">attachListener</a></li><li><a href="global.html#checkIfModuleHasInitOn">checkIfModuleHasInitOn</a></li><li><a href="global.html#createInstance">createInstance</a></li><li><a href="global.html#deleteInstance">deleteInstance</a></li><li><a href="global.html#destroyInstance">destroyInstance</a></li><li><a href="global.html#destroyModuleInstance">destroyModuleInstance</a></li><li><a href="global.html#eventQ">eventQ</a></li><li><a href="global.html#findInstance">findInstance</a></li><li><a href="global.html#insertInstance">insertInstance</a></li><li><a href="global.html#isBrowser">isBrowser</a></li><li><a href="global.html#isGlobalPubsub">isGlobalPubsub</a></li><li><a href="global.html#isModuleRendered">isModuleRendered</a></li><li><a href="global.html#isServer">isServer</a></li><li><a href="global.html#lifeCycleFlags">lifeCycleFlags</a></li><li><a href="global.html#PubSubHelper">PubSubHelper</a></li><li><a href="global.html#subscriptions">subscriptions</a></li><li><a href="global.html#use">use</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Feb 06 2017 13:40:46 GMT+0530 (IST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>