Gaia/System/NewModule - Revision history

Alive: /* If the parent module is based on BaseModule */

2015-05-13T06:50:14Z

If the parent module is based on BaseModule

← Older revision		Revision as of 06:50, 13 May 2015
Line 34:		Line 34:

	=== If the parent module is based on BaseModule ===		=== If the parent module is based on BaseModule ===
	# Put the module in the parent module's SUB_MODULES if you think it's blocking the starting progress of the parent module. # If the new module is not as important to block the parent, use this.loadWhenIdle([NEW_MODULE]) in parent's start function		# Put the module in the parent module's SUB_MODULES if you think it's blocking the starting progress of the parent module.
			# If the new module is not as important to block the parent, use this.loadWhenIdle([NEW_MODULE]) in parent's start function
	# If the new module is only serving some on demand request, consider to lazy load the new module in the parent module's event handler and start it.		# If the new module is only serving some on demand request, consider to lazy load the new module in the parent module's event handler and start it.

Alive: /* If the parent module is based on BaseModule */

2015-05-13T06:49:45Z

If the parent module is based on BaseModule

← Older revision		Revision as of 06:49, 13 May 2015
Line 34:		Line 34:

	=== If the parent module is based on BaseModule ===		=== If the parent module is based on BaseModule ===
	1. Put the module in the parent module's SUB_MODULES if you think it's blocking the starting progress of the parent module. 2. If the new module is not as important to block the parent, use this.loadWhenIdle([NEW_MODULE]) in parent's start function		# Put the module in the parent module's SUB_MODULES if you think it's blocking the starting progress of the parent module. # If the new module is not as important to block the parent, use this.loadWhenIdle([NEW_MODULE]) in parent's start function
	3. If the new module is only serving some on demand request, consider to lazy load the new module in the parent module's event handler and start it.		# If the new module is only serving some on demand request, consider to lazy load the new module in the parent module's event handler and start it.

	=== If the parent module is not based on BaseModule ===		=== If the parent module is not based on BaseModule ===
	# Lazy load the module in the parent module's start function and return a promise including the promise of the lazy loader		# Lazy load the module in the parent module's start function and return a promise including the promise of the lazy loader

Alive: /* If the parent module is not based on BaseModule */

2015-05-13T06:49:25Z

If the parent module is not based on BaseModule

← Older revision		Revision as of 06:49, 13 May 2015
Line 37:		Line 37:
	3. If the new module is only serving some on demand request, consider to lazy load the new module in the parent module's event handler and start it.		3. If the new module is only serving some on demand request, consider to lazy load the new module in the parent module's event handler and start it.
	=== If the parent module is not based on BaseModule ===		=== If the parent module is not based on BaseModule ===
			# Lazy load the module in the parent module's start function and return a promise including the promise of the lazy loader
	1. Lazy load the module in the parent module's start function and return a promise including the promise of the lazy loader		# If the new module is only serving some on demand request, consider to lazy load the new module in the parent module's event handler and start it.
	2. If the new module is only serving some on demand request, consider to lazy load the new module in the parent module's event handler and start it.

	== Samples ==		== Samples ==

Alive: /* If the parent module is not based on BaseModule */

2015-05-13T06:48:53Z

If the parent module is not based on BaseModule

← Older revision		Revision as of 06:48, 13 May 2015
Line 37:		Line 37:
	3. If the new module is only serving some on demand request, consider to lazy load the new module in the parent module's event handler and start it.		3. If the new module is only serving some on demand request, consider to lazy load the new module in the parent module's event handler and start it.
	=== If the parent module is not based on BaseModule ===		=== If the parent module is not based on BaseModule ===

	1. Lazy load the module in the parent module's start function and return a promise including the promise of the lazy loader		1. Lazy load the module in the parent module's start function and return a promise including the promise of the lazy loader
	2. If the new module is only serving some on demand request, consider to lazy load the new module in the parent module's event handler and start it.		2. If the new module is only serving some on demand request, consider to lazy load the new module in the parent module's event handler and start it.

Alive: /* Sample for the new module which does not block the first view and the parent is not a baseModule */

2015-05-13T06:48:39Z

Sample for the new module which does not block the first view and the parent is not a baseModule

← Older revision		Revision as of 06:48, 13 May 2015
Line 83:		Line 83:
	ChildModule.prototype.start = function() {};		ChildModule.prototype.start = function() {};

	// ~~parent~~.js		// parent_module.js
	ParentModule.prototype.start = function() {		ParentModule.prototype.start = function() {
	return Service.request('schedule', () => { // This is exactly what BaseModule.prototype.loadWhenIdle does		return Service.request('schedule', () => { // This is exactly what BaseModule.prototype.loadWhenIdle does

Alive: /* Sample for the child module which does not block the first view and the parent module is a base module */

2015-05-13T06:48:15Z

Sample for the child module which does not block the first view and the parent module is a base module

← Older revision		Revision as of 06:48, 13 May 2015
Line 72:		Line 72:

	// core.js		// core.js
	Core~~.prototype.~~_start = function() {		BaseModule.create(Core, {
	return this.loadWhenIdle(['SideTester']);		_start = function() {
	};		return this.loadWhenIdle(['SideTester']);
			};
			});

	=== Sample for the new module which does not block the first view and the parent is not a baseModule ===		=== Sample for the new module which does not block the first view and the parent is not a baseModule ===

Alive: /* Sample for the module which does block the first view */

2015-05-13T06:47:13Z

Sample for the module which does block the first view

← Older revision		Revision as of 06:47, 13 May 2015
Line 44:		Line 44:
	1. Core is an existing module who blocks the first view		1. Core is an existing module who blocks the first view
	2. ParentModule is an existing module who does not block the first view		2. ParentModule is an existing module who does not block the first view
	=== Sample for the module which does block the first view ===		=== Sample for the module which does block the first view and the parent module is a base module ===
	// ftu_loader.js		// ftu_loader.js
	var FtuLoader = function() {};		var FtuLoader = function() {};

Alive: /* Sample for the module which does not block the first view */

2015-05-13T06:46:56Z

Sample for the module which does not block the first view

← Older revision		Revision as of 06:46, 13 May 2015
Line 59:		Line 59:
	Core.SUB_MODULES = ['FtuLoader'];		Core.SUB_MODULES = ['FtuLoader'];

	=== Sample for the module which does not block the first view ===		=== Sample for the child module which does not block the first view and the parent module is a base module ===
	// side_tester.js		// side_tester.js
	var SideTester = function() {};		var SideTester = function() {};

Alive: /* Samples */

2015-05-13T06:46:18Z

Samples

← Older revision		Revision as of 06:46, 13 May 2015
Line 41:		Line 41:

	== Samples ==		== Samples ==
	In the following sample, ~~assume~~ Core is an existing module who blocks the first view		In the following sample,
	~~and you decide to implement a new child~~ module ~~under Core.~~		1. Core is an existing module who blocks the first view
			2. ParentModule is an existing module who does not block the first view
	=== Sample for the module which does block the first view ===		=== Sample for the module which does block the first view ===
	// ftu_loader.js		// ftu_loader.js
Line 61:		Line 62:
	// side_tester.js		// side_tester.js
	var SideTester = function() {};		var SideTester = function() {};
	BaseModule.create(~~SideTest~~, {		BaseModule.create(SideTester, {
	name: 'SideTester',		name: 'SideTester',
	_start: function() {		_start: function() {
Line 82:		Line 83:
	// parent.js		// parent.js
	ParentModule.prototype.start = function() {		ParentModule.prototype.start = function() {
	return Service.request('schedule', () => {		return Service.request('schedule', () => { // This is exactly what BaseModule.prototype.loadWhenIdle does
	return LazyLoader.load('child_module.js');		return LazyLoader.load('child_module.js');
	}).then(() => {		}).then(() => {

Alive at 06:44, 13 May 2015

2015-05-13T06:44:45Z

← Older revision		Revision as of 06:44, 13 May 2015
Line 39:		Line 39:
	1. Lazy load the module in the parent module's start function and return a promise including the promise of the lazy loader		1. Lazy load the module in the parent module's start function and return a promise including the promise of the lazy loader
	2. If the new module is only serving some on demand request, consider to lazy load the new module in the parent module's event handler and start it.		2. If the new module is only serving some on demand request, consider to lazy load the new module in the parent module's event handler and start it.

			== Samples ==
			In the following sample, assume Core is an existing module who blocks the first view
			and you decide to implement a new child module under Core.
			=== Sample for the module which does block the first view ===
			// ftu_loader.js
			var FtuLoader = function() {};
			BaseModule.create(FtuLoader, {
			name: 'FtuLoader',
			_start: function() {
			return LazyLoader.load('shared/js/test.js').then(() => {
			// Do something...
			});
			}
			});

			// core.js
			Core.SUB_MODULES = ['FtuLoader'];

			=== Sample for the module which does not block the first view ===
			// side_tester.js
			var SideTester = function() {};
			BaseModule.create(SideTest, {
			name: 'SideTester',
			_start: function() {
			return LazyLoader.load('shared/js/async.js').then(() => {
			// Do something...
			});
			}
			});

			// core.js
			Core.prototype._start = function() {
			return this.loadWhenIdle(['SideTester']);
			};

			=== Sample for the new module which does not block the first view and the parent is not a baseModule ===
			// side_tester.js
			var ChildModule = function() {};
			ChildModule.prototype.start = function() {};

			// parent.js
			ParentModule.prototype.start = function() {
			return Service.request('schedule', () => {
			return LazyLoader.load('child_module.js');
			}).then(() => {
			this.child = new ChildModule();
			return this.child.start();
			});
			};