@alterior/runtime 3.4.1 → 3.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +1 -1
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -53,7 +53,7 @@ Modules can optionally define lifecycle methods which are invoked by the runtime
53
53
 
54
54
  Many execution modules represent a service which can be turned on and off. Alterior has support baked in for this with Roles. Such modules can register a Role which allows the status of the service to be controlled and queried programmatically by using the `RolesService` injectable service.
55
55
 
56
- To register a role, use `RolesService.registerRole(roleRegistration)`. You will need to provide `start()` and `stop()` methods which will be executed when the roles service decides to start/stop your role. You will also need to specify an `identifier` which is used when referring to the role in configuration and the environment.
56
+ To register a role, use `RolesService.registerRole(roleRegistration)`. This is usually done within the `altOnInit()` method of a class marked with `@Module()`. You will need to provide `start()` and `stop()` methods which will be executed when the roles service decides to start/stop your role. You will also need to specify an `identifier` which is used when referring to the role in configuration and the environment.
57
57
 
58
58
  ## Configuring enabled roles
59
59
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@alterior/runtime",
3
- "version": "3.4.1",
3
+ "version": "3.5.0",
4
4
  "description": "Core runtime for Alterior apps",
5
5
  "author": "The Alterior Project (https://github.com/alterior-mvc)",
6
6
  "license": "MIT",
@@ -39,12 +39,12 @@
39
39
  "dependencies": {
40
40
  "@alterior/annotations": "^3.4.0",
41
41
  "@alterior/common": "^3.4.0",
42
- "@alterior/di": "^3.4.1",
42
+ "@alterior/di": "^3.5.0",
43
43
  "tslib": "^2.3.1"
44
44
  },
45
45
  "peerDependencies": {
46
46
  "reflect-metadata": "^0.1.13",
47
47
  "zone.js": "^0.11.4"
48
48
  },
49
- "gitHead": "5de51ec91748dcfc2ebc5db648f59e0da154b347"
49
+ "gitHead": "1fb8fea8c8d957fe543f7b6f69ae99c6bcc20156"
50
50
  }