Skip to content
Snippets Groups Projects
Commit f87604e6 authored by Mathis Neumann's avatar Mathis Neumann
Browse files

improve documentation

parent 35f2aa32
Branches
Tags
No related merge requests found
import Ember from 'ember'; import Ember from 'ember';
// TODO: update cytoscape instead of complete rerender // TODO: update cytoscape instead of complete rerender
/**
* The changelog parser takes a changelog (as a plain JS object) and updates the internal
* state of the Ember Data store automatically. Supports CREATE, UPDATE, DELETE and APPEND operations
*
* @class ChangelogParserService
* @extends {Ember.Service}
*/
export default Ember.Service.extend({ export default Ember.Service.extend({
store: Ember.inject.service(), store: Ember.inject.service(),
/**
* Parse a list of changelogs
* @param {Array} changelogs List of changelogs, as plain JavaScript objects
* @method parse
* @public
*/
parse(changelogs) { parse(changelogs) {
this.debug('store', this.get('store')); this.debug('store', this.get('store'));
this.debug('parsing changelogs', changelogs); this.debug('parsing changelogs', changelogs);
changelogs.forEach(this.parseSingle.bind(this)); changelogs.forEach(this.parseSingle.bind(this));
}, },
/**
* Parse a single changelog
*
* @param {Object} changelog changelog as plain JavaScript object, see backend documentation for data structure
* @method parseSingle
* @public
*/
parseSingle(changelog) { parseSingle(changelog) {
const operation = this.get(`operations.${changelog.operation}`); const operation = this.get(`operations.${changelog.operation}`);
if(!operation) { if(!operation) {
......
import Ember from 'ember'; import Ember from 'ember';
/**
* Stores changelogs which were received via ChangelogStreamService and applies the {ChangelogParserService} if triggered externally
*
* @class ChangelogQueueService
* @extends {Ember.Service}
* @uses ChangelogStreamService
* @uses ChangelogParserService
*/
export default Ember.Service.extend({ export default Ember.Service.extend({
changelogParser: Ember.inject.service(), changelogParser: Ember.inject.service(),
_private: { _private: {
......
...@@ -8,7 +8,6 @@ import Ember from 'ember'; ...@@ -8,7 +8,6 @@ import Ember from 'ember';
* *
* @class VisualisationEventsService * @class VisualisationEventsService
* @extends {Ember.Service} * @extends {Ember.Service}
* @public
*/ */
export default Ember.Service.extend(Ember.Evented, { export default Ember.Service.extend(Ember.Evented, {
/** /**
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment