forerunnerdb
Version:
A NoSQL document store database for browsers and Node.js.
105 lines (74 loc) • 4.76 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: SkeletonModule.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: SkeletonModule.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>"use strict";
/*
* This is a skeleton module definition that you can use as a springboard to
* develop new modules easily. It includes registering the module with
* ForerunnerDB and shows how to use common helper methods such as mixins
* and method synthesis, as well as providing a pattern to allow the constructor
* method to be overridden by other modules.
*/
var Shared,
Collection,
MyModule;
Shared = require('./Shared');
/**
* Create a constructor method that calls the instance's init method.
* This allows the constructor to be overridden by other modules because
* they can override the init method with their own.
* @class
* @constructor
*/
MyModule = function () {
this.init.apply(this, arguments);
};
MyModule.prototype.init = function () {
//var self = this;
};
// Tell ForerunnerDB about our new module
Shared.addModule('MyModule', MyModule);
// Mixin some commonly used methods
Shared.mixin(MyModule.prototype, 'Mixin.Common');
Shared.mixin(MyModule.prototype, 'Mixin.ChainReactor');
Shared.mixin(MyModule.prototype, 'Mixin.Constants');
Shared.mixin(MyModule.prototype, 'Mixin.Events');
// Grab the collection module for use later
Collection = Shared.modules.Collection;
// Synthesize the getter/setter method "name()"
Shared.synthesize(MyModule.prototype, 'name');
// Add a new method to the Collection module
Collection.prototype.myNewCollectionMethod = function () {
};
// Tell ForerunnerDB that our module has finished loading
Shared.finishModule('MyModule');
module.exports = MyModule;</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="ActiveBucket.html">ActiveBucket</a></li><li><a href="Angular.html">Angular</a></li><li><a href="AutoBind.html">AutoBind</a></li><li><a href="Collection.html">Collection</a></li><li><a href="CollectionGroup.html">CollectionGroup</a></li><li><a href="Condition.html">Condition</a></li><li><a href="Core.html">Core</a></li><li><a href="Db.html">Db</a></li><li><a href="Document.html">Document</a></li><li><a href="Grid.html">Grid</a></li><li><a href="Highchart.html">Highchart</a></li><li><a href="Index2d.html">Index2d</a></li><li><a href="IndexBinaryTree.html">IndexBinaryTree</a></li><li><a href="IndexHashMap.html">IndexHashMap</a></li><li><a href="Infinilist.html">Infinilist</a></li><li><a href="KeyValueStore.html">KeyValueStore</a></li><li><a href="Metrics.html">Metrics</a></li><li><a href="MyModule.html">MyModule</a></li><li><a href="NodeApiClient.html">NodeApiClient</a></li><li><a href="NodeApiServer.html">NodeApiServer</a></li><li><a href="NodeRAS.html">NodeRAS</a></li><li><a href="Odm.html">Odm</a></li><li><a href="OldView.html">OldView</a></li><li><a href="Operation.html">Operation</a></li><li><a href="Overload.html">Overload</a></li><li><a href="Overview.html">Overview</a></li><li><a href="Overview_init.html">init</a></li><li><a href="Path.html">Path</a></li><li><a href="Persist.html">Persist</a></li><li><a href="Procedure.html">Procedure</a></li><li><a href="ReactorIO.html">ReactorIO</a></li><li><a href="Section.html">Section</a></li><li><a href="Serialiser.html">Serialiser</a></li><li><a href="Shared.overload.html">overload</a></li><li><a href="View.html">View</a></li></ul><h3>Mixins</h3><ul><li><a href="ChainReactor.html">ChainReactor</a></li><li><a href="Common.html">Common</a></li><li><a href="Constants.html">Constants</a></li><li><a href="Events.html">Events</a></li><li><a href="Matching.html">Matching</a></li><li><a href="Shared.html">Shared</a></li><li><a href="Sorting.html">Sorting</a></li><li><a href="Tags.html">Tags</a></li><li><a href="Triggers.html">Triggers</a></li><li><a href="Updating.html">Updating</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Mar 01 2018 11:34:22 GMT+0000 (GMT)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>