Release Note for 4.2 - Initial draft. (#6390)

* Release Note for 4.2 - Initial draft.

* update dep

* documentation

* fix

* remove script

* lint

Co-authored-by: Eugenio Romano <eugenio.romano@alfresco.com>
Co-authored-by: Eugenio Romano <eromano@users.noreply.github.com>
This commit is contained in:
Francesco Corti
2020-12-07 21:03:41 +00:00
committed by GitHub
co-authored by Eugenio Romano Eugenio Romano
parent 27167b3420
commit 5a4cc4edda
214 changed files with 5178 additions and 4950 deletions
+34 -34
View File
@@ -51,49 +51,49 @@ export class AppComponent {
### Methods
- **assert**(test?: `boolean`, message?: `string`, optionalParams: `any[]`)<br/>
* **assert**(test?: `boolean`, message?: `string`, optionalParams: `any[]`)<br/>
Logs a message if a boolean test fails.
- _test:_ `boolean` - (Optional) Test value (typically a boolean expression)
- _message:_ `string` - (Optional) Message to show if test is false
- _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format
- **debug**(message?: `any`, optionalParams: `any[]`)<br/>
* *test:* `boolean` - (Optional) Test value (typically a boolean expression)
* *message:* `string` - (Optional) Message to show if test is false
* *optionalParams:* `any[]` - Interpolation values for the message in "printf" format
* **debug**(message?: `any`, optionalParams: `any[]`)<br/>
Logs a message at the "DEBUG" level.
- _message:_ `any` - (Optional) Message to log
- _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format
- **error**(message?: `any`, optionalParams: `any[]`)<br/>
* *message:* `any` - (Optional) Message to log
* *optionalParams:* `any[]` - Interpolation values for the message in "printf" format
* **error**(message?: `any`, optionalParams: `any[]`)<br/>
Logs a message at the "ERROR" level.
- _message:_ `any` - (Optional) Message to log
- _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format
- **getLogLevel**(level: `string`): [`LogLevelsEnum`](../../../lib/core/models/log-levels.model.ts)<br/>
* *message:* `any` - (Optional) Message to log
* *optionalParams:* `any[]` - Interpolation values for the message in "printf" format
* **getLogLevel**(level: `string`): [`LogLevelsEnum`](../../../lib/core/models/log-levels.model.ts)<br/>
Converts a log level name string into its numeric equivalent.
- _level:_ `string` - Level name
- **Returns** [`LogLevelsEnum`](../../../lib/core/models/log-levels.model.ts) - Numeric log level
- **group**(groupTitle?: `string`, optionalParams: `any[]`)<br/>
* *level:* `string` - Level name
* **Returns** [`LogLevelsEnum`](../../../lib/core/models/log-levels.model.ts) - Numeric log level
* **group**(groupTitle?: `string`, optionalParams: `any[]`)<br/>
Starts an indented group of log messages.
- _groupTitle:_ `string` - (Optional) Title shown at the start of the group
- _optionalParams:_ `any[]` - Interpolation values for the title in "printf" format
- **groupEnd**()<br/>
* *groupTitle:* `string` - (Optional) Title shown at the start of the group
* *optionalParams:* `any[]` - Interpolation values for the title in "printf" format
* **groupEnd**()<br/>
Ends a indented group of log messages.
- **info**(message?: `any`, optionalParams: `any[]`)<br/>
* **info**(message?: `any`, optionalParams: `any[]`)<br/>
Logs a message at the "INFO" level.
- _message:_ `any` - (Optional) Message to log
- _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format
- **log**(message?: `any`, optionalParams: `any[]`)<br/>
* *message:* `any` - (Optional) Message to log
* *optionalParams:* `any[]` - Interpolation values for the message in "printf" format
* **log**(message?: `any`, optionalParams: `any[]`)<br/>
Logs a message at any level from "TRACE" upwards.
- _message:_ `any` - (Optional) Message to log
- _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format
- **messageBus**(text: `string`, logLevel: `string`)<br/>
* *message:* `any` - (Optional) Message to log
* *optionalParams:* `any[]` - Interpolation values for the message in "printf" format
* **messageBus**(text: `string`, logLevel: `string`)<br/>
Triggers notification callback for log messages.
- _text:_ `string` - Message text
- _logLevel:_ `string` - Log level for the message
- **trace**(message?: `any`, optionalParams: `any[]`)<br/>
* *text:* `string` - Message text
* *logLevel:* `string` - Log level for the message
* **trace**(message?: `any`, optionalParams: `any[]`)<br/>
Logs a message at the "TRACE" level.
- _message:_ `any` - (Optional) Message to log
- _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format
- **warn**(message?: `any`, optionalParams: `any[]`)<br/>
* *message:* `any` - (Optional) Message to log
* *optionalParams:* `any[]` - Interpolation values for the message in "printf" format
* **warn**(message?: `any`, optionalParams: `any[]`)<br/>
Logs a message at the "WARN" level.
- _message:_ `any` - (Optional) Message to log
- _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format
* *message:* `any` - (Optional) Message to log
* *optionalParams:* `any[]` - Interpolation values for the message in "printf" format
## Details
@@ -110,7 +110,7 @@ There are 6 levels of logs that you can use:
| ERROR | 1 |
| SILENT | 0 |
You can set the default log level using the **_logLevel_** property in `app.config.json`.
You can set the default log level using the ***logLevel*** property in `app.config.json`.
The factory setting for this property is `TRACE`.
For example, you can set the default log level to `WARNING` as follows:
@@ -127,7 +127,7 @@ For example, you can set the default log level to `WARNING` as follows:
The [log service](log.service.md) also provides an
[`Observable`](http://reactivex.io/documentation/observable.html) called `_onMessage_`
that you can subscribe to if you want to receive all the log messages.
that you can subscribe to if you want to receive all the log messages.
The message object passed as a parameter to the `onMessage` handler has the following format:
```ts