Class UFService

The UFService implements a dependency injection mechanism.

Services are registered with a name using registerFactory, registerConstructor, registerSingletonFactory, registerSingletonConstructor, registerStatic.

A service may depend on other services. When a service is requested, the dependent services are injected into the service provider function (either a factory or constructor function).

Use getInstance to get a service.

To inject services into a call use call.

To construct a class (via new) injecting services into the constructor function use construct.

Add '()' to a service name to get a factory function (no parameters) that can be used to create instances for that service. The factory function will call getInstance to get the service instance.

Example

// some model and controller class
class MainModel {
  // ...
}
class MainController {
  // ...
}
// a view for an enemy
class EnemyView {
  // ...
}
// register services
UFService.registerConstructor('game.models.MainModel', MainModel);
UFService.registerConstructor('game.controllers.MainController', MainController);
UFService.registerConstructor('game.views.Enemy', EnemyView);
Copy

Example

// some factory function to create a view
function viewFactory(aMainData, aMainController) {
  // create view
  return {
    // some public methods
  };
}

const viewInstance = UF.callWithServices(
  viewFactory, ['game.models.MainModel', 'game.controllers.MainController']
);
Copy

Example

// Creates a view with factory function
function viewFactory(aMainData, aMainController, anEnemyFactory) {
  const enemies = [];
  // ...
  function createEnemies(aCount) {
    for(let index = 0; index < aCount; index++) {
      enemies.push(anEnemyFactory());
    }
  }
  return {
    // some public methods
  };
}
// note the () with last service name
const viewInstance = UF.callWithServices(
  viewFactory, ['game.models.MainModel', 'game.controllers.MainController', 'game.views.Enemy()']
);
Copy