freight.js

<!DOCTYPE html><html lang="en"><head><title>freight</title></head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0"><meta name="groc-relative-root" content=""><meta name="groc-document-path" content="freight"><meta name="groc-project-path" content="src/freight.js"><link rel="stylesheet" type="text/css" media="all" href="assets/style.css"><script type="text/javascript" src="assets/behavior.js"></script><body><div id="meta"><div class="file-path">src/freight.js</div></div><div id="document"><div class="segment"><div class="code"><div class="wrapper">var Definition = require('./definition.js'); var Freight = function() { var self = this;</div></div></div><div class="segment"><div class="comments doc-section"><div class="wrapper"> Determin how service id are distinques of normal string arguments in configuration</div></div><div class="code"><div class="wrapper"> self.idPrefix = ':';</div></div></div><div class="segment"><div class="comments doc-section doc-section-private"><div class="wrapper">Private the array of definitions this container managers</div></div><div class="code"><div class="wrapper"> self._definitions = [];</div></div></div><div class="segment"><div class="comments doc-section doc-section-private"><div class="wrapper">Private the hash with parameters this container holds</div></div><div class="code"><div class="wrapper"> self._parameters = {};</div></div></div><div class="segment"><div class="comments doc-section"><div class="wrapper">Method getService() Get and service of parameter from the container Parameters: <ul> <li>id must be a string.</li> </ul> Returns a mixed</div></div><div class="code"><div class="wrapper"> self.get = function get(id) { var res = false; try { res = self.getParameter(id); } catch(e) { res = self.getService(id); } return res; };</div></div></div><div class="segment"><div class="comments doc-section"><div class="wrapper">Method isId() Check wether the string an parameter id Parameters: <ul> <li>str must be a string.</li> </ul> Returns a Boolean</div></div><div class="code"><div class="wrapper"> self.isId = function isId(val) { if(typeof val !== 'string') return false; return ((val.indexOf(self.idPrefix) === 0) ? (true) : (false)); };</div></div></div><div class="segment"><div class="comments doc-section"><div class="wrapper">Method setParameter() Set a parameter on this container Parameters: <ul> <li>id must be a string.</li> <li>val must be a mixed.</li> </ul></div></div><div class="code"><div class="wrapper"> self.setParameter = function setParameter(id, val) { self._parameters[id] = val; return self; };</div></div></div><div class="segment"><div class="comments doc-section"><div class="wrapper"> Retrieve a parameter from the container Parameters: <ul> <li>id must be a string.</li> </ul> Returns a mixed</div></div><div class="code"><div class="wrapper"> self.getParameter = function getParameter(id) { var res = self._parameters[id]; if(res === undefined) throw new Error('Parameter "'+id+'" not found.'); return res; };</div></div></div><div class="segment"><div class="comments doc-section"><div class="wrapper">Method findTaggedServiceIds() Return an array of service ids from services with the given tag Parameters: <ul> <li>tag must be a string.</li> </ul> Returns an Array</div></div><div class="code"><div class="wrapper"> self.findTaggedServiceIds = function findTaggedServiceIds(tag) { var res = []; self._definitions.forEach(function(d){ if(d.tags.indexOf(tag) !== -1) { res.push(d.id); } }); return res; };</div></div></div><div class="segment"><div class="comments doc-section"><div class="wrapper">Method getDefinition() Return a service definition from the container Parameters: <ul> <li>id must be a string.</li> </ul> Returns a Definition</div></div><div class="code"><div class="wrapper"> self.getDefinition = function getDefinition(id) { var def = false; self._definitions.forEach(function(d){ if(d.id == id) { def = d; } }); return def; };</div></div></div><div class="segment"><div class="comments doc-section"><div class="wrapper">Method getService() Return an service by its id Parameters: <ul> <li>id must be a string.</li> </ul> Returns a mixed</div></div><div class="code"><div class="wrapper"> self.getService = function getService(id) { var def = self.getDefinition(id); if(def === false) throw new Error('Service "'+id+'" not found.'); var service = def.retrieve(); return service; };</div></div></div><div class="segment"><div class="comments doc-section"><div class="wrapper">Method register() Register a new service as the specified id Parameters: <ul> <li>id must be a string.</li> <li>conf must be an Object. (the configuration hash for the individual service)</li> </ul> Returns a Definition</div></div><div class="code"><div class="wrapper"> self.register = function register(id, conf) { var def = new Definition(id, conf, self); self._definitions.push(def); return def; };</div></div></div><div class="segment"><div class="comments doc-section"><div class="wrapper">Method registerAll() Register several definitions from an configuration hash (e.g. json) Parameters: <ul> <li>conf must be an Object. (the services)</li> </ul> Returns an Array (a array of registered definitions)</div></div><div class="code"><div class="wrapper"> self.registerAll = function build(conf) { var res = []; Object.keys(conf).forEach(function(id){ res.push(self.register(id, conf[id])); }); return res; }; }; module.exports = Freight;</div></div></div></div></body></html>